Helix Plan GraphQL API Documentation
For information about installation and setup, see Helix Plan API Server Setup Guide
API Endpoints
https://help.perforce.com/hansoft/Version
2024.1001
Queries
activeColumns
Description
Returns a list of active only columns available in a project to the authenticated user
Response
Returns [Column]
Arguments
| Name | Description |
|---|---|
id - ID!
|
The unique id of the project to list columns in |
Example
Query
query activeColumns($id: ID!) {
activeColumns(id: $id) {
id
projectID
name
readOnly
}
}
Variables
{"id": 4}
Response
{
"data": {
"activeColumns": [
{
"id": "4",
"projectID": 4,
"name": "xyz789",
"readOnly": false
}
]
}
}
adminSetting
Description
Gets the administration settings for the database
Response
Returns an AdminSetting!
Example
Query
query adminSetting {
adminSetting {
securityPolicy {
minPasswordLength
minPasswordAlpha
minPasswordNumeric
minPasswordNonAlphaNumeric
minPasswordUpperCase
minPasswordLowerCase
passwordExpireDays
tokensExpireDays
passwordsInHistory
adminsCanChangePolicy
}
}
}
Response
{
"data": {
"adminSetting": {"securityPolicy": SecurityPolicy}
}
}
appInfo
Description
Returns application information
Response
Returns an AppInfo!
Example
Query
query appInfo {
appInfo {
apiVersion
ssoEnabled
ssoRequired
baseURL
helixCoreCommentType
}
}
Response
{
"data": {
"appInfo": {
"apiVersion": "abc123",
"ssoEnabled": false,
"ssoRequired": true,
"baseURL": "abc123",
"helixCoreCommentType": "none"
}
}
}
assignedItems
Description
Returns a list of items assigned to a user available to the authenticated user
Response
Returns [Item]
Arguments
| Name | Description |
|---|---|
id - ID!
|
The unique id of the user to get assigned items for |
Example
Query
query assignedItems($id: ID!) {
assignedItems(id: $id) {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Variables
{"id": "4"}
Response
{
"data": {
"assignedItems": [
{
"id": 4,
"projectID": "4",
"localID": "4",
"name": "abc123",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "xyz789",
"indentationLevel": 123,
"itemLink": "xyz789",
"links": [Link],
"hidden": false,
"watchers": [User],
"watching": true,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "xyz789"
}
]
}
}
boardColumns
Description
Gets all board columns of a sprint/board lane
Response
Returns [BoardColumn]!
Arguments
| Name | Description |
|---|---|
id - ID!
|
The unique id of the sprint/board lane to list columns on |
Example
Query
query boardColumns($id: ID!) {
boardColumns(id: $id) {
id
name
}
}
Variables
{"id": "4"}
Response
{
"data": {
"boardColumns": [
{
"id": "4",
"name": "abc123"
}
]
}
}
boardLanes
Description
Gets all board lanes on a board
Response
Returns [BoardLane]!
Arguments
| Name | Description |
|---|---|
id - ID!
|
The unique id of the board/sprint to list board lanes on |
Example
Query
query boardLanes($id: ID!) {
boardLanes(id: $id) {
id
name
}
}
Variables
{"id": "4"}
Response
{
"data": {
"boardLanes": [
{
"id": "4",
"name": "abc123"
}
]
}
}
chart
Description
Returns one chart
charts
Description
Returns a list of charts on a dashboard page
columns
Description
Returns a list of columns available in a project to the authenticated user
Response
Returns [Column]
Arguments
| Name | Description |
|---|---|
id - ID!
|
The unique id of the project to list columns in |
Example
Query
query columns($id: ID!) {
columns(id: $id) {
id
projectID
name
readOnly
}
}
Variables
{"id": "4"}
Response
{
"data": {
"columns": [
{
"id": "4",
"projectID": 4,
"name": "abc123",
"readOnly": true
}
]
}
}
comments
Description
Returns a list of comments posted on a specific item
Response
Returns [Comment]
Arguments
| Name | Description |
|---|---|
id - ID!
|
The unique id of the item to list the comments of |
Example
Query
query comments($id: ID!) {
comments(id: $id) {
id
item {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
text
postedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
postedAt
mentionedUsers {
id
name
sortName
isDeleted
isLocked
userLink
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"comments": [
{
"id": "4",
"item": Item,
"text": "abc123",
"postedBy": User,
"postedAt": ISODateTime,
"mentionedUsers": [User]
}
]
}
}
communicationChannels
Description
Returns a list of registered communication channels. Note that channel names are not unique, while the combination of a channel name and its owner's session ID is
Response
Returns [CommunicationChannel]
Arguments
| Name | Description |
|---|---|
name - String
|
The name of the channel(s) to return. If not set or the empty string all channels are returned |
Example
Query
query communicationChannels($name: String) {
communicationChannels(name: $name) {
name
ownerSessionID
databaseID
description
}
}
Variables
{"name": "abc123"}
Response
{
"data": {
"communicationChannels": [
{
"name": "xyz789",
"ownerSessionID": 4,
"databaseID": 4,
"description": "abc123"
}
]
}
}
customField
Description
Returns a custom field with a specified ID set on a task
Response
Returns a CustomField
Example
Query
query customField(
$id: ID!,
$customFieldID: ID!
) {
customField(
id: $id,
customFieldID: $customFieldID
) {
id
taskID
}
}
Variables
{"id": 4, "customFieldID": "4"}
Response
{"data": {"customField": {"id": 4, "taskID": 4}}}
customFields
Description
Returns a list of custom fields available on a task
Response
Returns [CustomField]
Arguments
| Name | Description |
|---|---|
id - ID!
|
The unique id of the task to list custom fields on |
Example
Query
query customFields($id: ID!) {
customFields(id: $id) {
id
taskID
}
}
Variables
{"id": 4}
Response
{
"data": {
"customFields": [
{"id": "4", "taskID": 4}
]
}
}
customFieldsSet
Description
Returns a list of custom fields available on a task that have data set
Response
Returns [CustomField]
Arguments
| Name | Description |
|---|---|
id - ID!
|
The unique id of the task to list custom fields on |
Example
Query
query customFieldsSet($id: ID!) {
customFieldsSet(id: $id) {
id
taskID
}
}
Variables
{"id": "4"}
Response
{
"data": {
"customFieldsSet": [
{
"id": "4",
"taskID": "4"
}
]
}
}
dashboardPages
Description
Gets all dashboard pages available to the autenticated user. The user must also have dashboard access
Response
Returns [DashboardPage]!
Example
Query
query dashboardPages {
dashboardPages {
id
name
charts {
id
name
}
layout {
style
columns {
charts {
...ChartFragment
}
}
}
theme
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
}
Response
{
"data": {
"dashboardPages": [
{
"id": 4,
"name": "abc123",
"charts": [Chart],
"layout": DashboardLayout,
"theme": "4",
"createdBy": User
}
]
}
}
databaseSetting
Description
Returns the global database settings
Response
Returns a DatabaseSetting!
Example
Query
query databaseSetting {
databaseSetting {
id
}
}
Response
{"data": {"databaseSetting": {"id": "4"}}}
documents
Description
Returns a list of of the documents at the specified path
Response
Returns [Document]
Arguments
| Name | Description |
|---|---|
path - String!
|
The path to search for documents in, e.g 'SDK/Plugins/com.example.testintegration' |
Example
Query
query documents($path: String!) {
documents(path: $path) {
id
name
directory
size
date
checksum
}
}
Variables
{"path": "abc123"}
Response
{
"data": {
"documents": [
{
"id": "4",
"name": "xyz789",
"directory": false,
"size": "xyz789",
"date": ISODateTime,
"checksum": "xyz789"
}
]
}
}
globalCustomSettings
Description
Gets the global custom settings for an identifier
item
Description
Returns one item if it is available to the authenticated user
Example
Query
query item($id: ID!) {
item(id: $id) {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Variables
{"id": 4}
Response
{
"data": {
"item": {
"id": 4,
"projectID": 4,
"localID": 4,
"name": "xyz789",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "abc123",
"indentationLevel": 123,
"itemLink": "abc123",
"links": [Link],
"hidden": false,
"watchers": [User],
"watching": false,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "abc123"
}
}
}
itemDetail
Description
Gets detailed information about an item from a Helix Plan URL
Response
Returns an ItemDetail!
Arguments
| Name | Description |
|---|---|
url - String!
|
The Helix Plan URL of the item to get detailed information about |
Example
Query
query itemDetail($url: String!) {
itemDetail(url: $url) {
id
name
description
status
workflowStatus
users
}
}
Variables
{"url": "xyz789"}
Response
{
"data": {
"itemDetail": {
"id": "4",
"name": "abc123",
"description": "xyz789",
"status": "xyz789",
"workflowStatus": "abc123",
"users": ["abc123"]
}
}
}
itemInternalData
Description
Returns data stored internally on an item. The data is Base64 encoded
Response
Returns a String
Example
Query
query itemInternalData(
$id: ID!,
$identifier: String!
) {
itemInternalData(
id: $id,
identifier: $identifier
)
}
Variables
{"id": 4, "identifier": "xyz789"}
Response
{"data": {"itemInternalData": "xyz789"}}
items
Description
Returns a list of items available in a project to the authenticated user
Response
Returns [Item]
Example
Query
query items(
$id: ID!,
$findQuery: String
) {
items(
id: $id,
findQuery: $findQuery
) {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Variables
{"id": 4, "findQuery": "abc123"}
Response
{
"data": {
"items": [
{
"id": "4",
"projectID": 4,
"localID": "4",
"name": "abc123",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "abc123",
"indentationLevel": 123,
"itemLink": "abc123",
"links": [Link],
"hidden": true,
"watchers": [User],
"watching": true,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "abc123"
}
]
}
}
normalisedCustomSettings
Description
Gets the normalised version of a custom settings string to be used for comparing local custom settings with custom settings stored in the database before upload.
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
settings - String!
|
The custom settings string to normalise |
Example
Query
query normalisedCustomSettings($settings: String!) {
normalisedCustomSettings(settings: $settings)
}
Variables
{"settings": "xyz789"}
Response
{
"data": {
"normalisedCustomSettings": "xyz789"
}
}
project
Description
Returns one project
Example
Query
query project($id: ID!) {
project(id: $id) {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
qa {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
users {
user {
id
name
sortName
isDeleted
isLocked
userLink
}
accessRights {
isMainManager
limitedVisibility
canAccessProjectHistory
}
}
userGroups {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
...BacklogFragment
}
qa {
...QaFragment
}
users {
...ProjectUserFragment
}
userGroups {
...UserGroupFragment
}
timesheetLock {
...TimesheetLockFragment
}
items {
...ItemFragment
}
workflows {
...WorkflowFragment
}
settings {
...ProjectSettingsFragment
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
timesheetLock {
activateLock
date
}
items {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
workflows {
id
projectID
name
icon
}
settings {
id
timeSpentCustomColumn {
id
projectID
name
readOnly
activated
}
priorityCustomColumn {
id
projectID
name
readOnly
activated
items {
...DropListItemFragment
}
}
commentsAllowed
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"project": {
"id": "4",
"name": "abc123",
"niceName": "xyz789",
"sortName": "xyz789",
"archivedStatus": true,
"schedulingMethod": "fixedDuration",
"taskCompletionMethod": "auto",
"defaultMode": "taskScheduling",
"methodTemplate": "scrum",
"backlog": Backlog,
"qa": Qa,
"users": [ProjectUser],
"userGroups": [UserGroup],
"timesheetLock": TimesheetLock,
"items": [Item],
"workflows": [Workflow],
"settings": ProjectSettings
}
}
}
projectAvailableUsersAndGroups
Description
Returns a list of users and groups available for allocation and custom user field selection in a project
Response
Returns [UserOrGroup]!
Arguments
| Name | Description |
|---|---|
projectID - ID!
|
The unique id of the project to find users and groups in |
Example
Query
query projectAvailableUsersAndGroups($projectID: ID!) {
projectAvailableUsersAndGroups(projectID: $projectID) {
... on NormalUser {
id
name
sortName
emailAddress
accessRights {
isActiveAccount
admin
portfolioAllocation
documentManagement
avatarManagement
chat
dashboards
dashboardPageShare
}
passwordConfigurations {
mustChangePasswordNextLogon
passwordNeverExpires
cannotChangePassword
passwordDisabled
}
isDeleted
isLocked
userLink
hasAvatar
}
... on QaUser {
id
name
sortName
emailAddress
accessRights {
isActiveAccount
documentManagement
avatarManagement
chat
}
passwordConfigurations {
mustChangePasswordNextLogon
passwordNeverExpires
cannotChangePassword
passwordDisabled
}
isDeleted
isLocked
userLink
hasAvatar
}
... on GhostUser {
id
name
sortName
isDeleted
isLocked
userLink
}
... on UserGroup {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
...BacklogFragment
}
qa {
...QaFragment
}
users {
...ProjectUserFragment
}
userGroups {
...UserGroupFragment
}
timesheetLock {
...TimesheetLockFragment
}
items {
...ItemFragment
}
workflows {
...WorkflowFragment
}
settings {
...ProjectSettingsFragment
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
}
}
Variables
{"projectID": 4}
Response
{"data": {"projectAvailableUsersAndGroups": [NormalUser]}}
projectCustomSettingsValue
Response
Returns a CustomSettingsValue!
Arguments
| Name | Description |
|---|---|
id - ID!
|
The unique identifier for the settings value. Can be used to store different settings for different applications, e.g. 'com.example.myintegration' |
projectID - ID!
|
The unique identifier for the project to get the settings value in |
path - String!
|
The path for the settings value, e.g. com.example.myintegration.settings/MyIntegrationSettings/MyIntegrationHostName |
Example
Query
query projectCustomSettingsValue(
$id: ID!,
$projectID: ID!,
$path: String!
) {
projectCustomSettingsValue(
id: $id,
projectID: $projectID,
path: $path
) {
isDefault
value
}
}
Variables
{
"id": 4,
"projectID": "4",
"path": "abc123"
}
Response
{
"data": {
"projectCustomSettingsValue": {
"isDefault": false,
"value": "xyz789"
}
}
}
projectSettings
Description
Gets the project settings for a project
Response
Returns a ProjectSettings!
Arguments
| Name | Description |
|---|---|
id - ID!
|
The unique id of the project to get settings for |
Example
Query
query projectSettings($id: ID!) {
projectSettings(id: $id) {
id
timeSpentCustomColumn {
id
projectID
name
readOnly
activated
}
priorityCustomColumn {
id
projectID
name
readOnly
activated
items {
id
name
icon
}
}
commentsAllowed
}
}
Variables
{"id": 4}
Response
{
"data": {
"projectSettings": {
"id": 4,
"timeSpentCustomColumn": TimeSpentCustomColumn,
"priorityCustomColumn": SingleSelectionDropListCustomColumn,
"commentsAllowed": true
}
}
}
projectUser
Description
Returns one project user
Response
Returns a ProjectUser
Example
Query
query projectUser(
$projectID: ID!,
$userID: ID!
) {
projectUser(
projectID: $projectID,
userID: $userID
) {
user {
id
name
sortName
isDeleted
isLocked
userLink
}
accessRights {
isMainManager
limitedVisibility
canAccessProjectHistory
}
}
}
Variables
{"projectID": "4", "userID": 4}
Response
{
"data": {
"projectUser": {
"user": User,
"accessRights": ProjectUserAccessRights
}
}
}
projects
Description
Returns a list of projects available to the authenticated user
Response
Returns [Project]!
Example
Query
query projects {
projects {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
qa {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
users {
user {
id
name
sortName
isDeleted
isLocked
userLink
}
accessRights {
isMainManager
limitedVisibility
canAccessProjectHistory
}
}
userGroups {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
...BacklogFragment
}
qa {
...QaFragment
}
users {
...ProjectUserFragment
}
userGroups {
...UserGroupFragment
}
timesheetLock {
...TimesheetLockFragment
}
items {
...ItemFragment
}
workflows {
...WorkflowFragment
}
settings {
...ProjectSettingsFragment
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
timesheetLock {
activateLock
date
}
items {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
workflows {
id
projectID
name
icon
}
settings {
id
timeSpentCustomColumn {
id
projectID
name
readOnly
activated
}
priorityCustomColumn {
id
projectID
name
readOnly
activated
items {
...DropListItemFragment
}
}
commentsAllowed
}
}
}
Response
{
"data": {
"projects": [
{
"id": 4,
"name": "abc123",
"niceName": "abc123",
"sortName": "abc123",
"archivedStatus": true,
"schedulingMethod": "fixedDuration",
"taskCompletionMethod": "auto",
"defaultMode": "taskScheduling",
"methodTemplate": "scrum",
"backlog": Backlog,
"qa": Qa,
"users": [ProjectUser],
"userGroups": [UserGroup],
"timesheetLock": TimesheetLock,
"items": [Item],
"workflows": [Workflow],
"settings": ProjectSettings
}
]
}
}
todoList
Description
Returns the todo list of the authenticated user
Response
Returns [Item]!
Arguments
| Name | Description |
|---|---|
showOptions - ShowOptions
|
The show options that can be passed in the todo list |
Example
Query
query todoList($showOptions: ShowOptions) {
todoList(showOptions: $showOptions) {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Variables
{"showOptions": ShowOptions}
Response
{
"data": {
"todoList": [
{
"id": 4,
"projectID": 4,
"localID": 4,
"name": "abc123",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "xyz789",
"indentationLevel": 987,
"itemLink": "xyz789",
"links": [Link],
"hidden": false,
"watchers": [User],
"watching": true,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "xyz789"
}
]
}
}
user
Description
Returns one user
Example
Query
query user($id: ID!) {
user(id: $id) {
id
name
sortName
isDeleted
isLocked
userLink
}
}
Variables
{"id": 4}
Response
{
"data": {
"user": {
"id": 4,
"name": "abc123",
"sortName": "xyz789",
"isDeleted": true,
"isLocked": true,
"userLink": "abc123"
}
}
}
userGroup
Description
Returns a user group
Response
Returns a UserGroup
Arguments
| Name | Description |
|---|---|
id - ID!
|
The unique id of the user group to return |
Example
Query
query userGroup($id: ID!) {
userGroup(id: $id) {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
id
items {
...ItemFragment
}
}
qa {
id
items {
...ItemFragment
}
}
users {
user {
...UserFragment
}
accessRights {
...ProjectUserAccessRightsFragment
}
}
userGroups {
id
project {
...ProjectFragment
}
name
sortName
users {
...UserFragment
}
}
timesheetLock {
activateLock
date
}
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
workflows {
id
projectID
name
icon
}
settings {
id
timeSpentCustomColumn {
...TimeSpentCustomColumnFragment
}
priorityCustomColumn {
...SingleSelectionDropListCustomColumnFragment
}
commentsAllowed
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"userGroup": {
"id": 4,
"project": Project,
"name": "abc123",
"sortName": "abc123",
"users": [User]
}
}
}
userGroups
Description
Returns a list of user groups available to the authenticated user
Response
Returns [UserGroup]!
Example
Query
query userGroups {
userGroups {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
id
items {
...ItemFragment
}
}
qa {
id
items {
...ItemFragment
}
}
users {
user {
...UserFragment
}
accessRights {
...ProjectUserAccessRightsFragment
}
}
userGroups {
id
project {
...ProjectFragment
}
name
sortName
users {
...UserFragment
}
}
timesheetLock {
activateLock
date
}
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
workflows {
id
projectID
name
icon
}
settings {
id
timeSpentCustomColumn {
...TimeSpentCustomColumnFragment
}
priorityCustomColumn {
...SingleSelectionDropListCustomColumnFragment
}
commentsAllowed
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
}
Response
{
"data": {
"userGroups": [
{
"id": "4",
"project": Project,
"name": "abc123",
"sortName": "abc123",
"users": [User]
}
]
}
}
userProjects
Description
Returns a list of non archived projects the authenticated user is a member of
Response
Returns [Project]!
Example
Query
query userProjects {
userProjects {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
qa {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
users {
user {
id
name
sortName
isDeleted
isLocked
userLink
}
accessRights {
isMainManager
limitedVisibility
canAccessProjectHistory
}
}
userGroups {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
...BacklogFragment
}
qa {
...QaFragment
}
users {
...ProjectUserFragment
}
userGroups {
...UserGroupFragment
}
timesheetLock {
...TimesheetLockFragment
}
items {
...ItemFragment
}
workflows {
...WorkflowFragment
}
settings {
...ProjectSettingsFragment
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
timesheetLock {
activateLock
date
}
items {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
workflows {
id
projectID
name
icon
}
settings {
id
timeSpentCustomColumn {
id
projectID
name
readOnly
activated
}
priorityCustomColumn {
id
projectID
name
readOnly
activated
items {
...DropListItemFragment
}
}
commentsAllowed
}
}
}
Response
{
"data": {
"userProjects": [
{
"id": "4",
"name": "abc123",
"niceName": "xyz789",
"sortName": "abc123",
"archivedStatus": true,
"schedulingMethod": "fixedDuration",
"taskCompletionMethod": "auto",
"defaultMode": "taskScheduling",
"methodTemplate": "scrum",
"backlog": Backlog,
"qa": Qa,
"users": [ProjectUser],
"userGroups": [UserGroup],
"timesheetLock": TimesheetLock,
"items": [Item],
"workflows": [Workflow],
"settings": ProjectSettings
}
]
}
}
users
Description
Returns a list of users available to the authenticated user
Response
Returns [User]!
Example
Query
query users {
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
Response
{
"data": {
"users": [
{
"id": 4,
"name": "abc123",
"sortName": "xyz789",
"isDeleted": false,
"isLocked": true,
"userLink": "xyz789"
}
]
}
}
workflow
Description
Returns one workflow in a project
Response
Returns a Workflow
Example
Query
query workflow(
$projectID: ID!,
$id: ID!
) {
workflow(
projectID: $projectID,
id: $id
) {
id
projectID
name
icon
}
}
Variables
{
"projectID": "4",
"id": "4"
}
Response
{
"data": {
"workflow": {
"id": "4",
"projectID": "4",
"name": "xyz789",
"icon": "default"
}
}
}
workflows
Description
Returns a list of workflows in a project
Response
Returns [Workflow]!
Arguments
| Name | Description |
|---|---|
id - ID!
|
The unique id of the project to list workflows in |
Example
Query
query workflows($id: ID!) {
workflows(id: $id) {
id
projectID
name
icon
}
}
Variables
{"id": "4"}
Response
{
"data": {
"workflows": [
{
"id": 4,
"projectID": "4",
"name": "xyz789",
"icon": "default"
}
]
}
}
Mutations
addDocuments
Description
Add documents to Helix Plan
Response
Returns a String
Arguments
| Name | Description |
|---|---|
addDocumentsInput - AddDocumentsInput!
|
Example
Query
mutation addDocuments($addDocumentsInput: AddDocumentsInput!) {
addDocuments(addDocumentsInput: $addDocumentsInput)
}
Variables
{"addDocumentsInput": AddDocumentsInput}
Response
{"data": {"addDocuments": "abc123"}}
addExternalLink
Description
Adds a new external link
Response
Returns a Link!
Arguments
| Name | Description |
|---|---|
addLinkInput - AddExternalLinkInput!
|
Example
Query
mutation addExternalLink($addLinkInput: AddExternalLinkInput!) {
addExternalLink(addLinkInput: $addLinkInput) {
fromItem {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
relation
notes
}
}
Variables
{"addLinkInput": AddExternalLinkInput}
Response
{
"data": {
"addExternalLink": {
"fromItem": Item,
"relation": "relatedTo",
"notes": "abc123"
}
}
}
addInternalLink
Description
Adds a new internal link
Response
Returns a Link!
Arguments
| Name | Description |
|---|---|
addLinkInput - AddInternaLinkInput!
|
Example
Query
mutation addInternalLink($addLinkInput: AddInternaLinkInput!) {
addInternalLink(addLinkInput: $addLinkInput) {
fromItem {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
relation
notes
}
}
Variables
{"addLinkInput": AddInternaLinkInput}
Response
{
"data": {
"addInternalLink": {
"fromItem": Item,
"relation": "relatedTo",
"notes": "xyz789"
}
}
}
addProjectUser
Description
Adds a user to a project
Response
Returns a Project!
Example
Query
mutation addProjectUser(
$projectID: ID!,
$userID: ID!
) {
addProjectUser(
projectID: $projectID,
userID: $userID
) {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
qa {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
users {
user {
id
name
sortName
isDeleted
isLocked
userLink
}
accessRights {
isMainManager
limitedVisibility
canAccessProjectHistory
}
}
userGroups {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
...BacklogFragment
}
qa {
...QaFragment
}
users {
...ProjectUserFragment
}
userGroups {
...UserGroupFragment
}
timesheetLock {
...TimesheetLockFragment
}
items {
...ItemFragment
}
workflows {
...WorkflowFragment
}
settings {
...ProjectSettingsFragment
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
timesheetLock {
activateLock
date
}
items {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
workflows {
id
projectID
name
icon
}
settings {
id
timeSpentCustomColumn {
id
projectID
name
readOnly
activated
}
priorityCustomColumn {
id
projectID
name
readOnly
activated
items {
...DropListItemFragment
}
}
commentsAllowed
}
}
}
Variables
{"projectID": 4, "userID": "4"}
Response
{
"data": {
"addProjectUser": {
"id": 4,
"name": "abc123",
"niceName": "abc123",
"sortName": "xyz789",
"archivedStatus": true,
"schedulingMethod": "fixedDuration",
"taskCompletionMethod": "auto",
"defaultMode": "taskScheduling",
"methodTemplate": "scrum",
"backlog": Backlog,
"qa": Qa,
"users": [ProjectUser],
"userGroups": [UserGroup],
"timesheetLock": TimesheetLock,
"items": [Item],
"workflows": [Workflow],
"settings": ProjectSettings
}
}
}
addProjectUserGroup
Description
Adds a user group to a project. The users in the group will be auto-added to project
Response
Returns a Project!
Example
Query
mutation addProjectUserGroup(
$projectID: ID!,
$userGroupID: ID!
) {
addProjectUserGroup(
projectID: $projectID,
userGroupID: $userGroupID
) {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
qa {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
users {
user {
id
name
sortName
isDeleted
isLocked
userLink
}
accessRights {
isMainManager
limitedVisibility
canAccessProjectHistory
}
}
userGroups {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
...BacklogFragment
}
qa {
...QaFragment
}
users {
...ProjectUserFragment
}
userGroups {
...UserGroupFragment
}
timesheetLock {
...TimesheetLockFragment
}
items {
...ItemFragment
}
workflows {
...WorkflowFragment
}
settings {
...ProjectSettingsFragment
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
timesheetLock {
activateLock
date
}
items {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
workflows {
id
projectID
name
icon
}
settings {
id
timeSpentCustomColumn {
id
projectID
name
readOnly
activated
}
priorityCustomColumn {
id
projectID
name
readOnly
activated
items {
...DropListItemFragment
}
}
commentsAllowed
}
}
}
Variables
{"projectID": 4, "userGroupID": "4"}
Response
{
"data": {
"addProjectUserGroup": {
"id": "4",
"name": "abc123",
"niceName": "abc123",
"sortName": "abc123",
"archivedStatus": false,
"schedulingMethod": "fixedDuration",
"taskCompletionMethod": "auto",
"defaultMode": "taskScheduling",
"methodTemplate": "scrum",
"backlog": Backlog,
"qa": Qa,
"users": [ProjectUser],
"userGroups": [UserGroup],
"timesheetLock": TimesheetLock,
"items": [Item],
"workflows": [Workflow],
"settings": ProjectSettings
}
}
}
changeUserGroupProjectToGlobal
Description
Change a project specific user group to be global. Only possible if group was created as a project user group.
Response
Returns a UserGroup!
Arguments
| Name | Description |
|---|---|
id - ID!
|
The unique id of the user group to make a project user group of |
Example
Query
mutation changeUserGroupProjectToGlobal($id: ID!) {
changeUserGroupProjectToGlobal(id: $id) {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
id
items {
...ItemFragment
}
}
qa {
id
items {
...ItemFragment
}
}
users {
user {
...UserFragment
}
accessRights {
...ProjectUserAccessRightsFragment
}
}
userGroups {
id
project {
...ProjectFragment
}
name
sortName
users {
...UserFragment
}
}
timesheetLock {
activateLock
date
}
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
workflows {
id
projectID
name
icon
}
settings {
id
timeSpentCustomColumn {
...TimeSpentCustomColumnFragment
}
priorityCustomColumn {
...SingleSelectionDropListCustomColumnFragment
}
commentsAllowed
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"changeUserGroupProjectToGlobal": {
"id": 4,
"project": Project,
"name": "xyz789",
"sortName": "xyz789",
"users": [User]
}
}
}
cloneProject
Description
clones a project
Response
Returns a Project!
Arguments
| Name | Description |
|---|---|
cloneProjectInput - CloneProjectInput!
|
The project properties that the cloned project will have |
Example
Query
mutation cloneProject($cloneProjectInput: CloneProjectInput!) {
cloneProject(cloneProjectInput: $cloneProjectInput) {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
qa {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
users {
user {
id
name
sortName
isDeleted
isLocked
userLink
}
accessRights {
isMainManager
limitedVisibility
canAccessProjectHistory
}
}
userGroups {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
...BacklogFragment
}
qa {
...QaFragment
}
users {
...ProjectUserFragment
}
userGroups {
...UserGroupFragment
}
timesheetLock {
...TimesheetLockFragment
}
items {
...ItemFragment
}
workflows {
...WorkflowFragment
}
settings {
...ProjectSettingsFragment
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
timesheetLock {
activateLock
date
}
items {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
workflows {
id
projectID
name
icon
}
settings {
id
timeSpentCustomColumn {
id
projectID
name
readOnly
activated
}
priorityCustomColumn {
id
projectID
name
readOnly
activated
items {
...DropListItemFragment
}
}
commentsAllowed
}
}
}
Variables
{"cloneProjectInput": CloneProjectInput}
Response
{
"data": {
"cloneProject": {
"id": 4,
"name": "xyz789",
"niceName": "xyz789",
"sortName": "abc123",
"archivedStatus": true,
"schedulingMethod": "fixedDuration",
"taskCompletionMethod": "auto",
"defaultMode": "taskScheduling",
"methodTemplate": "scrum",
"backlog": Backlog,
"qa": Qa,
"users": [ProjectUser],
"userGroups": [UserGroup],
"timesheetLock": TimesheetLock,
"items": [Item],
"workflows": [Workflow],
"settings": ProjectSettings
}
}
}
createBacklogTasks
Description
Creates new backlog tasks in a backlog project
Response
Returns [BacklogTask]!
Arguments
| Name | Description |
|---|---|
projectID - ID!
|
The id of the backlog project to create the backlog tasks in |
createBacklogTasksInput - [CreateBacklogTaskInput]!
|
The task properties that the new backlog tasks will have |
previousItemID - ID
|
The id of the task that the new tasks will be created below in the backlog tree list. If not set, the tasks will be created at the top of the backlog |
Example
Query
mutation createBacklogTasks(
$projectID: ID!,
$createBacklogTasksInput: [CreateBacklogTaskInput]!,
$previousItemID: ID
) {
createBacklogTasks(
projectID: $projectID,
createBacklogTasksInput: $createBacklogTasksInput,
previousItemID: $previousItemID
) {
id
projectID
localID
committedToProjectID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
status
workflow {
id
projectID
name
icon
}
workflowStatus {
id
workflowID
projectID
name
icon
connectedStatuses {
connectedTo {
...WorkflowStatusFragment
}
usersCanEditAllFields
requiredFields {
...FieldIDFragment
}
}
statusToWorkflowStatuses {
status
workflowStatusID
}
}
confidence
risk
color
hyperlink
assignedTo {
user {
id
name
sortName
isDeleted
isLocked
userLink
}
percentageAllocation
}
subprojectPath
points
customFields {
id
taskID
}
indentationLevel
workRemaining
committedTo {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
confidence
color
risk
hyperlink
indentationLevel
itemLink
start
finish
releases {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
date
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
board
duration
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
membersHaveFullAccessRights
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
workRemaining
estimatedDays
status
points
aggregatedFieldsSummary {
points {
...AggregatedValueFragment
}
workRemaining {
...AggregatedValueFragment
}
estimatedDays {
...AggregatedValueFragment
}
customFields {
...AggregatedCustomFieldFragment
}
}
subprojectPath
allocations {
user {
...UserFragment
}
percentageAllocation
}
}
customField {
id
taskID
}
itemLink
releases {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
date
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
category
sprintPriority
backlogPriority
estimatedDays
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
boardLane {
id
name
}
boardColumn {
id
name
}
boardMembershipInfo {
position
hidden
}
epic
isUserStory
userStory
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
wbs
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
linkedToPipelineTask {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
createdFromWorkflow
hasChildren
aggregatedFieldsSummary {
points {
projectValue
committedToProjectValue
originalValue
}
workRemaining {
projectValue
committedToProjectValue
originalValue
}
estimatedDays {
projectValue
committedToProjectValue
originalValue
}
customFields {
id
value {
...AggregatedValueFragment
}
}
}
}
}
Variables
{
"projectID": "4",
"createBacklogTasksInput": [CreateBacklogTaskInput],
"previousItemID": "4"
}
Response
{
"data": {
"createBacklogTasks": [
{
"id": 4,
"projectID": 4,
"localID": 4,
"committedToProjectID": "4",
"name": "abc123",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"status": "none",
"workflow": Workflow,
"workflowStatus": WorkflowStatus,
"confidence": "none",
"risk": "none",
"color": "notSet",
"hyperlink": "xyz789",
"assignedTo": [AssignedUser],
"subprojectPath": "xyz789",
"points": 123,
"customFields": [CustomField],
"indentationLevel": 987,
"workRemaining": 987.65,
"committedTo": Sprint,
"customField": CustomField,
"itemLink": "abc123",
"releases": [Release],
"category": "none",
"sprintPriority": "none",
"backlogPriority": "none",
"estimatedDays": 123.45,
"links": [Link],
"hidden": true,
"boardLane": BoardLane,
"boardColumn": BoardColumn,
"boardMembershipInfo": BoardMembershipInfo,
"epic": false,
"isUserStory": false,
"userStory": "xyz789",
"attachments": [Attachment],
"wbs": "xyz789",
"watchers": [User],
"watching": false,
"linkedToPipelineTask": Item,
"createdFromWorkflow": false,
"hasChildren": false,
"aggregatedFieldsSummary": AggregatedFieldsSummary
}
]
}
}
createBugs
Description
Creates new bugs at the end of the bug list in a QA project
Response
Returns [Bug]!
Arguments
| Name | Description |
|---|---|
projectID - ID!
|
The id of the QA project to create the bugs in |
createBugsInput - [CreateBugInput]!
|
The bug properties that the bugs will have |
Example
Query
mutation createBugs(
$projectID: ID!,
$createBugsInput: [CreateBugInput]!
) {
createBugs(
projectID: $projectID,
createBugsInput: $createBugsInput
) {
id
projectID
localID
committedToProjectID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
status
workflow {
id
projectID
name
icon
}
workflowStatus {
id
workflowID
projectID
name
icon
connectedStatuses {
connectedTo {
...WorkflowStatusFragment
}
usersCanEditAllFields
requiredFields {
...FieldIDFragment
}
}
statusToWorkflowStatuses {
status
workflowStatusID
}
}
assignedTo {
user {
id
name
sortName
isDeleted
isLocked
userLink
}
percentageAllocation
}
confidence
risk
severity
color
hyperlink
subprojectPath
customFields {
id
taskID
}
indentationLevel
workRemaining
committedTo {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
confidence
color
risk
hyperlink
indentationLevel
itemLink
start
finish
releases {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
date
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
board
duration
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
membersHaveFullAccessRights
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
workRemaining
estimatedDays
status
points
aggregatedFieldsSummary {
points {
...AggregatedValueFragment
}
workRemaining {
...AggregatedValueFragment
}
estimatedDays {
...AggregatedValueFragment
}
customFields {
...AggregatedCustomFieldFragment
}
}
subprojectPath
allocations {
user {
...UserFragment
}
percentageAllocation
}
}
customField {
id
taskID
}
itemLink
releases {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
date
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
stepsToReproduce
detailedDescription
bugPriority
sprintPriority
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
boardLane {
id
name
}
boardColumn {
id
name
}
boardMembershipInfo {
position
hidden
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
}
}
Variables
{
"projectID": "4",
"createBugsInput": [CreateBugInput]
}
Response
{
"data": {
"createBugs": [
{
"id": 4,
"projectID": 4,
"localID": 4,
"committedToProjectID": "4",
"name": "abc123",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"status": "none",
"workflow": Workflow,
"workflowStatus": WorkflowStatus,
"assignedTo": [AssignedUser],
"confidence": "none",
"risk": "none",
"severity": "none",
"color": "notSet",
"hyperlink": "xyz789",
"subprojectPath": "xyz789",
"customFields": [CustomField],
"indentationLevel": 987,
"workRemaining": 987.65,
"committedTo": Sprint,
"customField": CustomField,
"itemLink": "xyz789",
"releases": [Release],
"stepsToReproduce": "xyz789",
"detailedDescription": "xyz789",
"bugPriority": "none",
"sprintPriority": "none",
"links": [Link],
"hidden": true,
"boardLane": BoardLane,
"boardColumn": BoardColumn,
"boardMembershipInfo": BoardMembershipInfo,
"attachments": [Attachment],
"watchers": [User],
"watching": false
}
]
}
}
createDateCustomColumn
Description
Creates a new custom date column in a project
Response
Returns a DateCustomColumn!
Arguments
| Name | Description |
|---|---|
projectID - ID!
|
The id of the project to create the custom date column in |
createDateCustomColumnInput - CreateDateCustomColumnInput!
|
The column properties that the new custom date column will have |
Example
Query
mutation createDateCustomColumn(
$projectID: ID!,
$createDateCustomColumnInput: CreateDateCustomColumnInput!
) {
createDateCustomColumn(
projectID: $projectID,
createDateCustomColumnInput: $createDateCustomColumnInput
) {
id
projectID
name
readOnly
activated
}
}
Variables
{
"projectID": "4",
"createDateCustomColumnInput": CreateDateCustomColumnInput
}
Response
{
"data": {
"createDateCustomColumn": {
"id": 4,
"projectID": "4",
"name": "abc123",
"readOnly": false,
"activated": false
}
}
}
createDateTimeCustomColumn
Description
Creates a new custom date time column in a project
Response
Returns a DateTimeCustomColumn!
Arguments
| Name | Description |
|---|---|
projectID - ID!
|
The id of the project to create the custom date time column in |
createDateTimeCustomColumnInput - CreateDateCustomColumnInput!
|
The column properties that the new custom date time column will have |
Example
Query
mutation createDateTimeCustomColumn(
$projectID: ID!,
$createDateTimeCustomColumnInput: CreateDateCustomColumnInput!
) {
createDateTimeCustomColumn(
projectID: $projectID,
createDateTimeCustomColumnInput: $createDateTimeCustomColumnInput
) {
id
projectID
name
readOnly
activated
}
}
Variables
{
"projectID": 4,
"createDateTimeCustomColumnInput": CreateDateCustomColumnInput
}
Response
{
"data": {
"createDateTimeCustomColumn": {
"id": "4",
"projectID": 4,
"name": "abc123",
"readOnly": true,
"activated": false
}
}
}
createDecimalNumberCustomColumn
Description
Creates a new custom decimal number column in a project
Response
Returns a DecimalNumberCustomColumn!
Arguments
| Name | Description |
|---|---|
projectID - ID!
|
The id of the project to create the custom decimal number column in |
createDecimalNumberCustomColumnInput - CreateNumberCustomColumnInput!
|
The column properties that the new custom decimal number column will have |
Example
Query
mutation createDecimalNumberCustomColumn(
$projectID: ID!,
$createDecimalNumberCustomColumnInput: CreateNumberCustomColumnInput!
) {
createDecimalNumberCustomColumn(
projectID: $projectID,
createDecimalNumberCustomColumnInput: $createDecimalNumberCustomColumnInput
) {
id
projectID
name
unitName
readOnly
activated
}
}
Variables
{
"projectID": 4,
"createDecimalNumberCustomColumnInput": CreateNumberCustomColumnInput
}
Response
{
"data": {
"createDecimalNumberCustomColumn": {
"id": 4,
"projectID": 4,
"name": "xyz789",
"unitName": "abc123",
"readOnly": true,
"activated": true
}
}
}
createGhostUser
Description
Creates a new ghost user
Response
Returns a GhostUser!
Arguments
| Name | Description |
|---|---|
createGhostUserInput - CreateGhostUserInput!
|
The user properties that the created ghost user will have |
Example
Query
mutation createGhostUser($createGhostUserInput: CreateGhostUserInput!) {
createGhostUser(createGhostUserInput: $createGhostUserInput) {
id
name
sortName
isDeleted
isLocked
userLink
}
}
Variables
{"createGhostUserInput": CreateGhostUserInput}
Response
{
"data": {
"createGhostUser": {
"id": 4,
"name": "xyz789",
"sortName": "abc123",
"isDeleted": true,
"isLocked": true,
"userLink": "abc123"
}
}
}
createHyperlinkCustomColumn
Description
Creates a new custom hyperlink column in a project
Response
Returns a HyperlinkCustomColumn!
Arguments
| Name | Description |
|---|---|
projectID - ID!
|
The id of the project to create the custom hyperlink in |
createHyperlinkCustomColumnInput - CreateCustomColumnInput!
|
The column properties that the new custom hyperlinkcolumn will have |
Example
Query
mutation createHyperlinkCustomColumn(
$projectID: ID!,
$createHyperlinkCustomColumnInput: CreateCustomColumnInput!
) {
createHyperlinkCustomColumn(
projectID: $projectID,
createHyperlinkCustomColumnInput: $createHyperlinkCustomColumnInput
) {
id
projectID
name
readOnly
activated
}
}
Variables
{
"projectID": "4",
"createHyperlinkCustomColumnInput": CreateCustomColumnInput
}
Response
{
"data": {
"createHyperlinkCustomColumn": {
"id": 4,
"projectID": "4",
"name": "abc123",
"readOnly": true,
"activated": true
}
}
}
createMultilineTextCustomColumn
Description
Creates a new custom multiline text column in a project
Response
Returns a MultilineTextCustomColumn!
Arguments
| Name | Description |
|---|---|
projectID - ID!
|
The id of the project to create the custom multiline column in |
createMultilineTextCustomColumnInput - CreateCustomColumnInput!
|
The column properties that the new custom multiline column will have |
Example
Query
mutation createMultilineTextCustomColumn(
$projectID: ID!,
$createMultilineTextCustomColumnInput: CreateCustomColumnInput!
) {
createMultilineTextCustomColumn(
projectID: $projectID,
createMultilineTextCustomColumnInput: $createMultilineTextCustomColumnInput
) {
id
projectID
name
readOnly
activated
}
}
Variables
{
"projectID": 4,
"createMultilineTextCustomColumnInput": CreateCustomColumnInput
}
Response
{
"data": {
"createMultilineTextCustomColumn": {
"id": 4,
"projectID": 4,
"name": "xyz789",
"readOnly": true,
"activated": true
}
}
}
createMultipleSelectionDropListCustomColumn
Description
Creates a new custom multiple selection drop list column in a project
Response
Returns a MultipleSelectionDropListCustomColumn!
Arguments
| Name | Description |
|---|---|
projectID - ID!
|
The id of the project to create the custom multiple selection drop list column in |
createMultipleSelectionDropListCustomColumnInput - CreateDropListCustomColumnInput!
|
The column properties that the new custom multiple selection drop list column will have |
Example
Query
mutation createMultipleSelectionDropListCustomColumn(
$projectID: ID!,
$createMultipleSelectionDropListCustomColumnInput: CreateDropListCustomColumnInput!
) {
createMultipleSelectionDropListCustomColumn(
projectID: $projectID,
createMultipleSelectionDropListCustomColumnInput: $createMultipleSelectionDropListCustomColumnInput
) {
id
projectID
name
readOnly
activated
items {
id
name
icon
}
}
}
Variables
{
"projectID": "4",
"createMultipleSelectionDropListCustomColumnInput": CreateDropListCustomColumnInput
}
Response
{
"data": {
"createMultipleSelectionDropListCustomColumn": {
"id": "4",
"projectID": 4,
"name": "abc123",
"readOnly": true,
"activated": true,
"items": [DropListItem]
}
}
}
createNormalUser
Description
Creates a new normal user
Response
Returns a NormalUser!
Arguments
| Name | Description |
|---|---|
createNormalUserInput - CreateNormalUserInput!
|
The user properties that the created normal user will have |
Example
Query
mutation createNormalUser($createNormalUserInput: CreateNormalUserInput!) {
createNormalUser(createNormalUserInput: $createNormalUserInput) {
id
name
sortName
emailAddress
accessRights {
isActiveAccount
admin
portfolioAllocation
documentManagement
avatarManagement
chat
dashboards
dashboardPageShare
}
passwordConfigurations {
mustChangePasswordNextLogon
passwordNeverExpires
cannotChangePassword
passwordDisabled
}
isDeleted
isLocked
userLink
hasAvatar
}
}
Variables
{"createNormalUserInput": CreateNormalUserInput}
Response
{
"data": {
"createNormalUser": {
"id": "4",
"name": "abc123",
"sortName": "abc123",
"emailAddress": "abc123",
"accessRights": UserAccessRights,
"passwordConfigurations": PasswordConfigurations,
"isDeleted": false,
"isLocked": true,
"userLink": "xyz789",
"hasAvatar": true
}
}
}
createNumberCustomColumn
Description
Creates a new custom number column in a project
Response
Returns a NumberCustomColumn!
Arguments
| Name | Description |
|---|---|
projectID - ID!
|
The id of the project to create the custom number column in |
createNumberCustomColumnInput - CreateNumberCustomColumnInput!
|
The column properties that the new custom number column will have |
Example
Query
mutation createNumberCustomColumn(
$projectID: ID!,
$createNumberCustomColumnInput: CreateNumberCustomColumnInput!
) {
createNumberCustomColumn(
projectID: $projectID,
createNumberCustomColumnInput: $createNumberCustomColumnInput
) {
id
projectID
name
unitName
readOnly
activated
}
}
Variables
{
"projectID": "4",
"createNumberCustomColumnInput": CreateNumberCustomColumnInput
}
Response
{
"data": {
"createNumberCustomColumn": {
"id": "4",
"projectID": 4,
"name": "abc123",
"unitName": "xyz789",
"readOnly": false,
"activated": false
}
}
}
createProject
Description
Creates a new project
Response
Returns a Project!
Arguments
| Name | Description |
|---|---|
createProjectInput - CreateProjectInput!
|
The project properties that the created project will have |
Example
Query
mutation createProject($createProjectInput: CreateProjectInput!) {
createProject(createProjectInput: $createProjectInput) {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
qa {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
users {
user {
id
name
sortName
isDeleted
isLocked
userLink
}
accessRights {
isMainManager
limitedVisibility
canAccessProjectHistory
}
}
userGroups {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
...BacklogFragment
}
qa {
...QaFragment
}
users {
...ProjectUserFragment
}
userGroups {
...UserGroupFragment
}
timesheetLock {
...TimesheetLockFragment
}
items {
...ItemFragment
}
workflows {
...WorkflowFragment
}
settings {
...ProjectSettingsFragment
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
timesheetLock {
activateLock
date
}
items {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
workflows {
id
projectID
name
icon
}
settings {
id
timeSpentCustomColumn {
id
projectID
name
readOnly
activated
}
priorityCustomColumn {
id
projectID
name
readOnly
activated
items {
...DropListItemFragment
}
}
commentsAllowed
}
}
}
Variables
{"createProjectInput": CreateProjectInput}
Response
{
"data": {
"createProject": {
"id": "4",
"name": "xyz789",
"niceName": "xyz789",
"sortName": "xyz789",
"archivedStatus": false,
"schedulingMethod": "fixedDuration",
"taskCompletionMethod": "auto",
"defaultMode": "taskScheduling",
"methodTemplate": "scrum",
"backlog": Backlog,
"qa": Qa,
"users": [ProjectUser],
"userGroups": [UserGroup],
"timesheetLock": TimesheetLock,
"items": [Item],
"workflows": [Workflow],
"settings": ProjectSettings
}
}
}
createQaUser
Description
Creates a new QA user
Response
Returns a QaUser!
Arguments
| Name | Description |
|---|---|
createQaUserInput - CreateQaUserInput!
|
The user properties that the created QA user will have |
Example
Query
mutation createQaUser($createQaUserInput: CreateQaUserInput!) {
createQaUser(createQaUserInput: $createQaUserInput) {
id
name
sortName
emailAddress
accessRights {
isActiveAccount
documentManagement
avatarManagement
chat
}
passwordConfigurations {
mustChangePasswordNextLogon
passwordNeverExpires
cannotChangePassword
passwordDisabled
}
isDeleted
isLocked
userLink
hasAvatar
}
}
Variables
{"createQaUserInput": CreateQaUserInput}
Response
{
"data": {
"createQaUser": {
"id": 4,
"name": "abc123",
"sortName": "abc123",
"emailAddress": "xyz789",
"accessRights": QaUserAccessRights,
"passwordConfigurations": PasswordConfigurations,
"isDeleted": false,
"isLocked": false,
"userLink": "xyz789",
"hasAvatar": true
}
}
}
createSdkUser
Description
Creates a new SDK user
Response
Returns a SdkUser!
Arguments
| Name | Description |
|---|---|
createSdkUserInput - CreateSdkUserInput!
|
The user properties that the created SDK user will have |
Example
Query
mutation createSdkUser($createSdkUserInput: CreateSdkUserInput!) {
createSdkUser(createSdkUserInput: $createSdkUserInput) {
id
name
sortName
syncMethod
passwordConfigurations {
mustChangePasswordNextLogon
passwordNeverExpires
cannotChangePassword
passwordDisabled
}
isDeleted
isLocked
authenticationProvider
credentialCheckProvider
chatUser
isActiveAccount
userLink
}
}
Variables
{"createSdkUserInput": CreateSdkUserInput}
Response
{
"data": {
"createSdkUser": {
"id": 4,
"name": "abc123",
"sortName": "xyz789",
"syncMethod": "allMembersProjects",
"passwordConfigurations": PasswordConfigurations,
"isDeleted": false,
"isLocked": false,
"authenticationProvider": false,
"credentialCheckProvider": true,
"chatUser": true,
"isActiveAccount": true,
"userLink": "xyz789"
}
}
}
createSingleSelectionDropListCustomColumn
Description
Creates a new custom single selection drop list column in a project
Response
Returns a SingleSelectionDropListCustomColumn!
Arguments
| Name | Description |
|---|---|
projectID - ID!
|
The id of the project to create the custom single selection drop list column in |
createSingleSelectionDropListCustomColumnInput - CreateDropListCustomColumnInput!
|
The column properties that the new custom single selection drop list column will have |
Example
Query
mutation createSingleSelectionDropListCustomColumn(
$projectID: ID!,
$createSingleSelectionDropListCustomColumnInput: CreateDropListCustomColumnInput!
) {
createSingleSelectionDropListCustomColumn(
projectID: $projectID,
createSingleSelectionDropListCustomColumnInput: $createSingleSelectionDropListCustomColumnInput
) {
id
projectID
name
readOnly
activated
items {
id
name
icon
}
}
}
Variables
{
"projectID": 4,
"createSingleSelectionDropListCustomColumnInput": CreateDropListCustomColumnInput
}
Response
{
"data": {
"createSingleSelectionDropListCustomColumn": {
"id": "4",
"projectID": 4,
"name": "xyz789",
"readOnly": false,
"activated": true,
"items": [DropListItem]
}
}
}
createTextCustomColumn
Description
Creates a new custom text column in a project
Response
Returns a TextCustomColumn!
Arguments
| Name | Description |
|---|---|
projectID - ID!
|
The id of the project to create the custom text column in |
createTextCustomColumnInput - CreateCustomColumnInput!
|
The column properties that the new custom text column will have |
Example
Query
mutation createTextCustomColumn(
$projectID: ID!,
$createTextCustomColumnInput: CreateCustomColumnInput!
) {
createTextCustomColumn(
projectID: $projectID,
createTextCustomColumnInput: $createTextCustomColumnInput
) {
id
projectID
name
readOnly
activated
}
}
Variables
{
"projectID": 4,
"createTextCustomColumnInput": CreateCustomColumnInput
}
Response
{
"data": {
"createTextCustomColumn": {
"id": "4",
"projectID": "4",
"name": "xyz789",
"readOnly": true,
"activated": true
}
}
}
createTimeSpentCustomColumn
Description
Creates a new custom time spent column in a project
Response
Returns a TimeSpentCustomColumn!
Arguments
| Name | Description |
|---|---|
projectID - ID!
|
The id of the project to create the custom time spent column in |
createTimeSpentCustomColumnInput - CreateTimeSpentCustomColumnInput!
|
The column properties that the new custom time spent column will have |
Example
Query
mutation createTimeSpentCustomColumn(
$projectID: ID!,
$createTimeSpentCustomColumnInput: CreateTimeSpentCustomColumnInput!
) {
createTimeSpentCustomColumn(
projectID: $projectID,
createTimeSpentCustomColumnInput: $createTimeSpentCustomColumnInput
) {
id
projectID
name
readOnly
activated
}
}
Variables
{
"projectID": "4",
"createTimeSpentCustomColumnInput": CreateTimeSpentCustomColumnInput
}
Response
{
"data": {
"createTimeSpentCustomColumn": {
"id": 4,
"projectID": "4",
"name": "abc123",
"readOnly": false,
"activated": false
}
}
}
createUserCustomColumn
Description
Creates a new custom user column in a project
Response
Returns a UserCustomColumn!
Arguments
| Name | Description |
|---|---|
projectID - ID!
|
The id of the project to create the custom user column in |
createUserCustomColumnInput - CreateCustomColumnInput!
|
The column properties that the new custom user column will have |
Example
Query
mutation createUserCustomColumn(
$projectID: ID!,
$createUserCustomColumnInput: CreateCustomColumnInput!
) {
createUserCustomColumn(
projectID: $projectID,
createUserCustomColumnInput: $createUserCustomColumnInput
) {
id
projectID
name
readOnly
activated
}
}
Variables
{
"projectID": 4,
"createUserCustomColumnInput": CreateCustomColumnInput
}
Response
{
"data": {
"createUserCustomColumn": {
"id": 4,
"projectID": 4,
"name": "xyz789",
"readOnly": true,
"activated": false
}
}
}
createUserGroup
Description
Creates a new user group
Response
Returns a UserGroup!
Arguments
| Name | Description |
|---|---|
createUserGroupInput - CreateUserGroupInput!
|
The user group properties that the created user group will have |
Example
Query
mutation createUserGroup($createUserGroupInput: CreateUserGroupInput!) {
createUserGroup(createUserGroupInput: $createUserGroupInput) {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
id
items {
...ItemFragment
}
}
qa {
id
items {
...ItemFragment
}
}
users {
user {
...UserFragment
}
accessRights {
...ProjectUserAccessRightsFragment
}
}
userGroups {
id
project {
...ProjectFragment
}
name
sortName
users {
...UserFragment
}
}
timesheetLock {
activateLock
date
}
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
workflows {
id
projectID
name
icon
}
settings {
id
timeSpentCustomColumn {
...TimeSpentCustomColumnFragment
}
priorityCustomColumn {
...SingleSelectionDropListCustomColumnFragment
}
commentsAllowed
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
}
Variables
{"createUserGroupInput": CreateUserGroupInput}
Response
{
"data": {
"createUserGroup": {
"id": 4,
"project": Project,
"name": "xyz789",
"sortName": "xyz789",
"users": [User]
}
}
}
deleteComment
Description
deletes an existing comment
Response
Returns an ID!
Arguments
| Name | Description |
|---|---|
deleteCommentInput - DeleteCommentInput!
|
Example
Query
mutation deleteComment($deleteCommentInput: DeleteCommentInput!) {
deleteComment(deleteCommentInput: $deleteCommentInput)
}
Variables
{"deleteCommentInput": DeleteCommentInput}
Response
{"data": {"deleteComment": "4"}}
deleteDocuments
Description
Delete documents from Helix Plan
Response
Returns a String
Arguments
| Name | Description |
|---|---|
deleteDocumentsInput - DeleteDocumentsInput!
|
Example
Query
mutation deleteDocuments($deleteDocumentsInput: DeleteDocumentsInput!) {
deleteDocuments(deleteDocumentsInput: $deleteDocumentsInput)
}
Variables
{"deleteDocumentsInput": DeleteDocumentsInput}
Response
{"data": {"deleteDocuments": "abc123"}}
deleteExternalLink
Description
Deletes an existing external link
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
deleteLinkInput - DeleteExternalLinkInput!
|
Example
Query
mutation deleteExternalLink($deleteLinkInput: DeleteExternalLinkInput!) {
deleteExternalLink(deleteLinkInput: $deleteLinkInput)
}
Variables
{"deleteLinkInput": DeleteExternalLinkInput}
Response
{"data": {"deleteExternalLink": true}}
deleteInternalLink
Description
Deletes an existing internal link
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
deleteLinkInput - DeleteInternalLinkInput!
|
Example
Query
mutation deleteInternalLink($deleteLinkInput: DeleteInternalLinkInput!) {
deleteInternalLink(deleteLinkInput: $deleteLinkInput)
}
Variables
{"deleteLinkInput": DeleteInternalLinkInput}
Response
{"data": {"deleteInternalLink": false}}
deleteProject
Description
Deletes a project
deleteSdkUser
Description
Deletes the SDK user and all related information. The user account and all references in projects where the user has assigned tasks are deleted. The user cannot be restored. For other user types, use deleteUser
deleteUser
Description
Deletes the user and all related information. The user account and all references in projects where the user has assigned tasks are deleted. The user cannot be restored. For SDK users, use deleteSdkUser
deleteUserGroup
Description
Deletes a user group
login
Description
Responsible for granting an authentication token for valid database users
Response
Returns a Token!
Arguments
| Name | Description |
|---|---|
loginUserInput - LoginUserInput!
|
Example
Query
mutation login($loginUserInput: LoginUserInput!) {
login(loginUserInput: $loginUserInput) {
access_token
}
}
Variables
{"loginUserInput": LoginUserInput}
Response
{
"data": {
"login": {"access_token": "abc123"}
}
}
postComment
Description
Posts a new comment on a task
Response
Returns a Comment!
Arguments
| Name | Description |
|---|---|
postCommentInput - PostCommentInput!
|
Example
Query
mutation postComment($postCommentInput: PostCommentInput!) {
postComment(postCommentInput: $postCommentInput) {
id
item {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
text
postedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
postedAt
mentionedUsers {
id
name
sortName
isDeleted
isLocked
userLink
}
}
}
Variables
{"postCommentInput": PostCommentInput}
Response
{
"data": {
"postComment": {
"id": 4,
"item": Item,
"text": "xyz789",
"postedBy": User,
"postedAt": ISODateTime,
"mentionedUsers": [User]
}
}
}
registerCommunicationChannel
Description
Register a communication channel. Returns the channel name
Response
Returns a String!
Example
Query
mutation registerCommunicationChannel(
$name: String!,
$description: String
) {
registerCommunicationChannel(
name: $name,
description: $description
)
}
Variables
{
"name": "xyz789",
"description": "abc123"
}
Response
{
"data": {
"registerCommunicationChannel": "abc123"
}
}
registerGlobalCustomSettings
Description
Register global custom settings. Returns settings id
Response
Returns an ID!
Example
Query
mutation registerGlobalCustomSettings(
$id: ID!,
$settings: String!
) {
registerGlobalCustomSettings(
id: $id,
settings: $settings
)
}
Variables
{"id": 4, "settings": "abc123"}
Response
{
"data": {
"registerGlobalCustomSettings": "4"
}
}
removeProjectUser
Description
Removes a user from a project
Response
Returns a Project!
Example
Query
mutation removeProjectUser(
$projectID: ID!,
$userID: ID!
) {
removeProjectUser(
projectID: $projectID,
userID: $userID
) {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
qa {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
users {
user {
id
name
sortName
isDeleted
isLocked
userLink
}
accessRights {
isMainManager
limitedVisibility
canAccessProjectHistory
}
}
userGroups {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
...BacklogFragment
}
qa {
...QaFragment
}
users {
...ProjectUserFragment
}
userGroups {
...UserGroupFragment
}
timesheetLock {
...TimesheetLockFragment
}
items {
...ItemFragment
}
workflows {
...WorkflowFragment
}
settings {
...ProjectSettingsFragment
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
timesheetLock {
activateLock
date
}
items {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
workflows {
id
projectID
name
icon
}
settings {
id
timeSpentCustomColumn {
id
projectID
name
readOnly
activated
}
priorityCustomColumn {
id
projectID
name
readOnly
activated
items {
...DropListItemFragment
}
}
commentsAllowed
}
}
}
Variables
{"projectID": 4, "userID": "4"}
Response
{
"data": {
"removeProjectUser": {
"id": 4,
"name": "abc123",
"niceName": "abc123",
"sortName": "xyz789",
"archivedStatus": false,
"schedulingMethod": "fixedDuration",
"taskCompletionMethod": "auto",
"defaultMode": "taskScheduling",
"methodTemplate": "scrum",
"backlog": Backlog,
"qa": Qa,
"users": [ProjectUser],
"userGroups": [UserGroup],
"timesheetLock": TimesheetLock,
"items": [Item],
"workflows": [Workflow],
"settings": ProjectSettings
}
}
}
removeProjectUserGroup
Description
Removes a user group from a project. Users in the group that are not members of the project will be removed from project.
Response
Returns a Project!
Example
Query
mutation removeProjectUserGroup(
$projectID: ID!,
$userGroupID: ID!
) {
removeProjectUserGroup(
projectID: $projectID,
userGroupID: $userGroupID
) {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
qa {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
users {
user {
id
name
sortName
isDeleted
isLocked
userLink
}
accessRights {
isMainManager
limitedVisibility
canAccessProjectHistory
}
}
userGroups {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
...BacklogFragment
}
qa {
...QaFragment
}
users {
...ProjectUserFragment
}
userGroups {
...UserGroupFragment
}
timesheetLock {
...TimesheetLockFragment
}
items {
...ItemFragment
}
workflows {
...WorkflowFragment
}
settings {
...ProjectSettingsFragment
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
timesheetLock {
activateLock
date
}
items {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
workflows {
id
projectID
name
icon
}
settings {
id
timeSpentCustomColumn {
id
projectID
name
readOnly
activated
}
priorityCustomColumn {
id
projectID
name
readOnly
activated
items {
...DropListItemFragment
}
}
commentsAllowed
}
}
}
Variables
{
"projectID": "4",
"userGroupID": "4"
}
Response
{
"data": {
"removeProjectUserGroup": {
"id": 4,
"name": "abc123",
"niceName": "xyz789",
"sortName": "abc123",
"archivedStatus": false,
"schedulingMethod": "fixedDuration",
"taskCompletionMethod": "auto",
"defaultMode": "taskScheduling",
"methodTemplate": "scrum",
"backlog": Backlog,
"qa": Qa,
"users": [ProjectUser],
"userGroups": [UserGroup],
"timesheetLock": TimesheetLock,
"items": [Item],
"workflows": [Workflow],
"settings": ProjectSettings
}
}
}
sendCommunicationChannelPackage
Description
Send a communication channel package. Returns the channel name
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
name - String!
|
The name to uniquely identify the communication channel the package will be sent to, e.g. com.example.myintegration |
sessionID - String!
|
The identifier of the session to which the packet should be sent. Identifier 0 sends it to the channel's current owner, i.e. the session that last registered the channel |
data - String!
|
Base64 encoded data to send |
Example
Query
mutation sendCommunicationChannelPackage(
$name: String!,
$sessionID: String!,
$data: String!
) {
sendCommunicationChannelPackage(
name: $name,
sessionID: $sessionID,
data: $data
)
}
Variables
{
"name": "abc123",
"sessionID": "xyz789",
"data": "xyz789"
}
Response
{
"data": {
"sendCommunicationChannelPackage": "xyz789"
}
}
setDateCustomFieldValue
Description
Sets a date value on a task in a date custom field
Response
Returns an Item!
Example
Query
mutation setDateCustomFieldValue(
$taskID: ID!,
$customFieldID: ID!,
$value: ISODate!
) {
setDateCustomFieldValue(
taskID: $taskID,
customFieldID: $customFieldID,
value: $value
) {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Variables
{
"taskID": "4",
"customFieldID": "4",
"value": ISODate
}
Response
{
"data": {
"setDateCustomFieldValue": {
"id": "4",
"projectID": "4",
"localID": 4,
"name": "xyz789",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "xyz789",
"indentationLevel": 987,
"itemLink": "abc123",
"links": [Link],
"hidden": true,
"watchers": [User],
"watching": false,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "xyz789"
}
}
}
setDateTimeCustomFieldValue
Description
Sets a date time value on a task in a date time custom field
Response
Returns an Item!
Arguments
| Name | Description |
|---|---|
taskID - ID!
|
The id of the task to set the date time on |
customFieldID - ID!
|
The id of the date time custom field. The id is an id of a DateTimeCustomColumn |
value - ISODateTime!
|
The date time to set on the task |
Example
Query
mutation setDateTimeCustomFieldValue(
$taskID: ID!,
$customFieldID: ID!,
$value: ISODateTime!
) {
setDateTimeCustomFieldValue(
taskID: $taskID,
customFieldID: $customFieldID,
value: $value
) {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Variables
{
"taskID": "4",
"customFieldID": "4",
"value": ISODateTime
}
Response
{
"data": {
"setDateTimeCustomFieldValue": {
"id": "4",
"projectID": "4",
"localID": "4",
"name": "xyz789",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "xyz789",
"indentationLevel": 123,
"itemLink": "abc123",
"links": [Link],
"hidden": false,
"watchers": [User],
"watching": false,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "abc123"
}
}
}
setDecimalNumberCustomFieldValue
Description
Sets a decimal number value on a task in a decimal number custom field
Response
Returns an Item!
Example
Query
mutation setDecimalNumberCustomFieldValue(
$taskID: ID!,
$customFieldID: ID!,
$value: Float!
) {
setDecimalNumberCustomFieldValue(
taskID: $taskID,
customFieldID: $customFieldID,
value: $value
) {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Variables
{"taskID": 4, "customFieldID": 4, "value": 123.45}
Response
{
"data": {
"setDecimalNumberCustomFieldValue": {
"id": 4,
"projectID": 4,
"localID": "4",
"name": "abc123",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "xyz789",
"indentationLevel": 123,
"itemLink": "abc123",
"links": [Link],
"hidden": true,
"watchers": [User],
"watching": false,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "abc123"
}
}
}
setHyperlinkCustomFieldValue
Description
Sets a hyperlink value on a task in a hyperlink custom field
Response
Returns an Item!
Example
Query
mutation setHyperlinkCustomFieldValue(
$taskID: ID!,
$customFieldID: ID!,
$value: String!
) {
setHyperlinkCustomFieldValue(
taskID: $taskID,
customFieldID: $customFieldID,
value: $value
) {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Variables
{
"taskID": 4,
"customFieldID": "4",
"value": "abc123"
}
Response
{
"data": {
"setHyperlinkCustomFieldValue": {
"id": 4,
"projectID": "4",
"localID": "4",
"name": "abc123",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "xyz789",
"indentationLevel": 987,
"itemLink": "xyz789",
"links": [Link],
"hidden": true,
"watchers": [User],
"watching": false,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "xyz789"
}
}
}
setItemInternalData
Description
Sets data that will be stored internally on an item
Response
Returns an Item!
Arguments
| Name | Description |
|---|---|
setItemInternalDataInput - SetItemInternalDataInput
|
Example
Query
mutation setItemInternalData($setItemInternalDataInput: SetItemInternalDataInput) {
setItemInternalData(setItemInternalDataInput: $setItemInternalDataInput) {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Variables
{"setItemInternalDataInput": SetItemInternalDataInput}
Response
{
"data": {
"setItemInternalData": {
"id": "4",
"projectID": 4,
"localID": 4,
"name": "abc123",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "xyz789",
"indentationLevel": 987,
"itemLink": "abc123",
"links": [Link],
"hidden": true,
"watchers": [User],
"watching": true,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "xyz789"
}
}
}
setMultilineTextCustomFieldValue
Description
Sets a text value on a task in a multiline text custom field
Response
Returns an Item!
Example
Query
mutation setMultilineTextCustomFieldValue(
$taskID: ID!,
$customFieldID: ID!,
$value: String!
) {
setMultilineTextCustomFieldValue(
taskID: $taskID,
customFieldID: $customFieldID,
value: $value
) {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Variables
{
"taskID": "4",
"customFieldID": "4",
"value": "abc123"
}
Response
{
"data": {
"setMultilineTextCustomFieldValue": {
"id": 4,
"projectID": 4,
"localID": "4",
"name": "xyz789",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "xyz789",
"indentationLevel": 123,
"itemLink": "abc123",
"links": [Link],
"hidden": true,
"watchers": [User],
"watching": false,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "xyz789"
}
}
}
setMultipleSelectionDropListCustomFieldValue
Description
Sets multiple selection drop list values on a task for a multiple selection drop list custom field
Response
Returns an Item!
Arguments
| Name | Description |
|---|---|
taskID - ID!
|
The id of the task to set the multiple selection drop list values on |
customFieldID - ID!
|
The id of the multiple selection drop list field The id is an id of a MultipleSelectionDropListCustomColumn |
value - [ID]!
|
The list of multiple selection drop list item ids to set on the task. These are ids in the DropListItem s of the MultipleSelectionDropListCustomColumn |
Example
Query
mutation setMultipleSelectionDropListCustomFieldValue(
$taskID: ID!,
$customFieldID: ID!,
$value: [ID]!
) {
setMultipleSelectionDropListCustomFieldValue(
taskID: $taskID,
customFieldID: $customFieldID,
value: $value
) {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Variables
{"taskID": 4, "customFieldID": 4, "value": [4]}
Response
{
"data": {
"setMultipleSelectionDropListCustomFieldValue": {
"id": 4,
"projectID": 4,
"localID": 4,
"name": "abc123",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "xyz789",
"indentationLevel": 123,
"itemLink": "xyz789",
"links": [Link],
"hidden": true,
"watchers": [User],
"watching": false,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "xyz789"
}
}
}
setNumberCustomFieldValue
Description
Sets a number value on a task in a number custom field
Response
Returns an Item!
Example
Query
mutation setNumberCustomFieldValue(
$taskID: ID!,
$customFieldID: ID!,
$value: Int!
) {
setNumberCustomFieldValue(
taskID: $taskID,
customFieldID: $customFieldID,
value: $value
) {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Variables
{
"taskID": 4,
"customFieldID": "4",
"value": 987
}
Response
{
"data": {
"setNumberCustomFieldValue": {
"id": 4,
"projectID": "4",
"localID": 4,
"name": "abc123",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "xyz789",
"indentationLevel": 987,
"itemLink": "xyz789",
"links": [Link],
"hidden": false,
"watchers": [User],
"watching": true,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "xyz789"
}
}
}
setSingleSelectionDropListCustomFieldValue
Description
Sets a single selection drop list value on a task for a single selection drop list custom field
Response
Returns an Item!
Arguments
| Name | Description |
|---|---|
taskID - ID!
|
The id of the task to set the single selection drop list value on |
customFieldID - ID!
|
The id of the single selection drop list field. The id is an id of a SingleSelectionDropListCustomColumn |
value - ID!
|
The single selection drop list item id to set on the task. This is an id from the DropListItem s of the SingleSelectionDropListCustomColumn. Empty '' can be set for removing existing selection |
Example
Query
mutation setSingleSelectionDropListCustomFieldValue(
$taskID: ID!,
$customFieldID: ID!,
$value: ID!
) {
setSingleSelectionDropListCustomFieldValue(
taskID: $taskID,
customFieldID: $customFieldID,
value: $value
) {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Variables
{
"taskID": 4,
"customFieldID": "4",
"value": 4
}
Response
{
"data": {
"setSingleSelectionDropListCustomFieldValue": {
"id": 4,
"projectID": "4",
"localID": "4",
"name": "xyz789",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "xyz789",
"indentationLevel": 987,
"itemLink": "xyz789",
"links": [Link],
"hidden": false,
"watchers": [User],
"watching": false,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "xyz789"
}
}
}
setTextCustomFieldValue
Description
Sets a text value on a task in a text custom field
Response
Returns an Item!
Example
Query
mutation setTextCustomFieldValue(
$taskID: ID!,
$customFieldID: ID!,
$value: String!
) {
setTextCustomFieldValue(
taskID: $taskID,
customFieldID: $customFieldID,
value: $value
) {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Variables
{
"taskID": 4,
"customFieldID": 4,
"value": "xyz789"
}
Response
{
"data": {
"setTextCustomFieldValue": {
"id": "4",
"projectID": "4",
"localID": 4,
"name": "abc123",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "xyz789",
"indentationLevel": 987,
"itemLink": "abc123",
"links": [Link],
"hidden": true,
"watchers": [User],
"watching": false,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "xyz789"
}
}
}
setTimeSpentCustomFieldValue
Description
Sets a time spent value on a task for a time spent custom field
Response
Returns an Item!
Arguments
| Name | Description |
|---|---|
taskID - ID!
|
The id of the task to set the time spent value on |
customFieldID - ID!
|
The id of the time spent custom field |
value - Float!
|
The value to add to current time spent value. You can decrease the value by adding a negative number, but the value is never less than zero |
Example
Query
mutation setTimeSpentCustomFieldValue(
$taskID: ID!,
$customFieldID: ID!,
$value: Float!
) {
setTimeSpentCustomFieldValue(
taskID: $taskID,
customFieldID: $customFieldID,
value: $value
) {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Variables
{"taskID": 4, "customFieldID": 4, "value": 987.65}
Response
{
"data": {
"setTimeSpentCustomFieldValue": {
"id": "4",
"projectID": "4",
"localID": 4,
"name": "xyz789",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "abc123",
"indentationLevel": 123,
"itemLink": "abc123",
"links": [Link],
"hidden": true,
"watchers": [User],
"watching": true,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "abc123"
}
}
}
setUserCustomFieldValue
Description
Sets user values on a task for a user custom field
Response
Returns an Item!
Arguments
| Name | Description |
|---|---|
taskID - ID!
|
The id of the task to set the user values on |
customFieldID - ID!
|
The id of the user field. The id is an id of a UserCustomColumn |
usersAndGroups - UsersOrGroupsInput
|
The users and/or groups to set on the task |
Example
Query
mutation setUserCustomFieldValue(
$taskID: ID!,
$customFieldID: ID!,
$usersAndGroups: UsersOrGroupsInput
) {
setUserCustomFieldValue(
taskID: $taskID,
customFieldID: $customFieldID,
usersAndGroups: $usersAndGroups
) {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Variables
{
"taskID": 4,
"customFieldID": 4,
"usersAndGroups": UsersOrGroupsInput
}
Response
{
"data": {
"setUserCustomFieldValue": {
"id": "4",
"projectID": 4,
"localID": 4,
"name": "xyz789",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "xyz789",
"indentationLevel": 987,
"itemLink": "abc123",
"links": [Link],
"hidden": true,
"watchers": [User],
"watching": false,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "abc123"
}
}
}
setWatching
Description
Sets the watching status of the current authenticated user
Response
Returns an Item!
Example
Query
mutation setWatching(
$itemID: ID!,
$watching: Boolean!
) {
setWatching(
itemID: $itemID,
watching: $watching
) {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Variables
{"itemID": "4", "watching": true}
Response
{
"data": {
"setWatching": {
"id": 4,
"projectID": 4,
"localID": 4,
"name": "abc123",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "xyz789",
"indentationLevel": 123,
"itemLink": "abc123",
"links": [Link],
"hidden": true,
"watchers": [User],
"watching": false,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "abc123"
}
}
}
setWorkflow
Description
Sets workflow on a task
Response
Returns a Task!
Example
Query
mutation setWorkflow(
$taskID: ID!,
$workflowID: ID!
) {
setWorkflow(
taskID: $taskID,
workflowID: $workflowID
) {
id
projectID
localID
committedToProjectID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
status
subprojectPath
customFields {
id
taskID
}
confidence
risk
color
hyperlink
assignedTo {
user {
id
name
sortName
isDeleted
isLocked
userLink
}
percentageAllocation
}
workflow {
id
projectID
name
icon
}
workflowStatus {
id
workflowID
projectID
name
icon
connectedStatuses {
connectedTo {
...WorkflowStatusFragment
}
usersCanEditAllFields
requiredFields {
...FieldIDFragment
}
}
statusToWorkflowStatuses {
status
workflowStatusID
}
}
indentationLevel
customField {
id
taskID
}
itemLink
releases {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
date
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
}
}
Variables
{"taskID": 4, "workflowID": "4"}
Response
{
"data": {
"setWorkflow": {
"id": 4,
"projectID": "4",
"localID": "4",
"committedToProjectID": 4,
"name": "abc123",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"status": "none",
"subprojectPath": "xyz789",
"customFields": [CustomField],
"confidence": "none",
"risk": "none",
"color": "notSet",
"hyperlink": "xyz789",
"assignedTo": [AssignedUser],
"workflow": Workflow,
"workflowStatus": WorkflowStatus,
"indentationLevel": 987,
"customField": CustomField,
"itemLink": "abc123",
"releases": [Release],
"links": [Link],
"hidden": true,
"attachments": [Attachment],
"watchers": [User],
"watching": false
}
}
}
softDeleteSdkUser
Description
Soft deletes an SDK user. Saves the user assignment and history information. The user can be restored if needed using undeleteSdkUser. For other user types, use softDeleteUser
Example
Query
mutation softDeleteSdkUser($userID: ID!) {
softDeleteSdkUser(userID: $userID) {
id
name
sortName
isDeleted
isLocked
userLink
}
}
Variables
{"userID": "4"}
Response
{
"data": {
"softDeleteSdkUser": {
"id": "4",
"name": "xyz789",
"sortName": "xyz789",
"isDeleted": true,
"isLocked": true,
"userLink": "abc123"
}
}
}
softDeleteUser
Description
Soft deletes a user. Saves the user assignment and history information. The user can be restored if needed using undeleteUser. For SDK users, use softDeleteSdkUser
Example
Query
mutation softDeleteUser($userID: ID!) {
softDeleteUser(userID: $userID) {
id
name
sortName
isDeleted
isLocked
userLink
}
}
Variables
{"userID": 4}
Response
{
"data": {
"softDeleteUser": {
"id": "4",
"name": "abc123",
"sortName": "abc123",
"isDeleted": false,
"isLocked": false,
"userLink": "xyz789"
}
}
}
undeleteSdkUser
Description
Undeletes an SDK user which is not fully deleted from the database. For other user types, use undeleteUser
Response
Returns a User!
Arguments
| Name | Description |
|---|---|
userID - ID!
|
The unique id of the user to undelete |
Example
Query
mutation undeleteSdkUser($userID: ID!) {
undeleteSdkUser(userID: $userID) {
id
name
sortName
isDeleted
isLocked
userLink
}
}
Variables
{"userID": 4}
Response
{
"data": {
"undeleteSdkUser": {
"id": 4,
"name": "abc123",
"sortName": "abc123",
"isDeleted": true,
"isLocked": true,
"userLink": "xyz789"
}
}
}
undeleteUser
Description
Undeletes a user which is not fully deleted from the database. For SDK users, use undeleteSdkUser
Response
Returns a User!
Arguments
| Name | Description |
|---|---|
userID - ID!
|
The unique id of the user to undelete |
Example
Query
mutation undeleteUser($userID: ID!) {
undeleteUser(userID: $userID) {
id
name
sortName
isDeleted
isLocked
userLink
}
}
Variables
{"userID": 4}
Response
{
"data": {
"undeleteUser": {
"id": "4",
"name": "xyz789",
"sortName": "abc123",
"isDeleted": true,
"isLocked": true,
"userLink": "abc123"
}
}
}
unregisterCommunicationChannel
Description
Unregister a communication channel. Returns the channel name
Response
Returns a String!
Arguments
| Name | Description |
|---|---|
name - String!
|
The name to uniquely identify the communication channel |
Example
Query
mutation unregisterCommunicationChannel($name: String!) {
unregisterCommunicationChannel(name: $name)
}
Variables
{"name": "xyz789"}
Response
{
"data": {
"unregisterCommunicationChannel": "abc123"
}
}
unregisterGlobalCustomSettings
Description
Unregister global custom settings. Returns settings id
updateAuthenticatedUserPassword
Description
Updates the password of the authenticated user
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
password - String!
|
The new password for the authenticated user |
Example
Query
mutation updateAuthenticatedUserPassword($password: String!) {
updateAuthenticatedUserPassword(password: $password)
}
Variables
{"password": "xyz789"}
Response
{"data": {"updateAuthenticatedUserPassword": false}}
updateBacklogTask
Description
Updates a backlog task by ID
Response
Returns a BacklogTask!
Arguments
| Name | Description |
|---|---|
updateBacklogTaskInput - UpdateBacklogTaskInput!
|
The backlog task properties to update |
Example
Query
mutation updateBacklogTask($updateBacklogTaskInput: UpdateBacklogTaskInput!) {
updateBacklogTask(updateBacklogTaskInput: $updateBacklogTaskInput) {
id
projectID
localID
committedToProjectID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
status
workflow {
id
projectID
name
icon
}
workflowStatus {
id
workflowID
projectID
name
icon
connectedStatuses {
connectedTo {
...WorkflowStatusFragment
}
usersCanEditAllFields
requiredFields {
...FieldIDFragment
}
}
statusToWorkflowStatuses {
status
workflowStatusID
}
}
confidence
risk
color
hyperlink
assignedTo {
user {
id
name
sortName
isDeleted
isLocked
userLink
}
percentageAllocation
}
subprojectPath
points
customFields {
id
taskID
}
indentationLevel
workRemaining
committedTo {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
confidence
color
risk
hyperlink
indentationLevel
itemLink
start
finish
releases {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
date
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
board
duration
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
membersHaveFullAccessRights
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
workRemaining
estimatedDays
status
points
aggregatedFieldsSummary {
points {
...AggregatedValueFragment
}
workRemaining {
...AggregatedValueFragment
}
estimatedDays {
...AggregatedValueFragment
}
customFields {
...AggregatedCustomFieldFragment
}
}
subprojectPath
allocations {
user {
...UserFragment
}
percentageAllocation
}
}
customField {
id
taskID
}
itemLink
releases {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
date
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
category
sprintPriority
backlogPriority
estimatedDays
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
boardLane {
id
name
}
boardColumn {
id
name
}
boardMembershipInfo {
position
hidden
}
epic
isUserStory
userStory
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
wbs
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
linkedToPipelineTask {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
createdFromWorkflow
hasChildren
aggregatedFieldsSummary {
points {
projectValue
committedToProjectValue
originalValue
}
workRemaining {
projectValue
committedToProjectValue
originalValue
}
estimatedDays {
projectValue
committedToProjectValue
originalValue
}
customFields {
id
value {
...AggregatedValueFragment
}
}
}
}
}
Variables
{"updateBacklogTaskInput": UpdateBacklogTaskInput}
Response
{
"data": {
"updateBacklogTask": {
"id": 4,
"projectID": "4",
"localID": "4",
"committedToProjectID": 4,
"name": "xyz789",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"status": "none",
"workflow": Workflow,
"workflowStatus": WorkflowStatus,
"confidence": "none",
"risk": "none",
"color": "notSet",
"hyperlink": "xyz789",
"assignedTo": [AssignedUser],
"subprojectPath": "xyz789",
"points": 987,
"customFields": [CustomField],
"indentationLevel": 987,
"workRemaining": 987.65,
"committedTo": Sprint,
"customField": CustomField,
"itemLink": "xyz789",
"releases": [Release],
"category": "none",
"sprintPriority": "none",
"backlogPriority": "none",
"estimatedDays": 123.45,
"links": [Link],
"hidden": false,
"boardLane": BoardLane,
"boardColumn": BoardColumn,
"boardMembershipInfo": BoardMembershipInfo,
"epic": true,
"isUserStory": true,
"userStory": "xyz789",
"attachments": [Attachment],
"wbs": "abc123",
"watchers": [User],
"watching": false,
"linkedToPipelineTask": Item,
"createdFromWorkflow": true,
"hasChildren": true,
"aggregatedFieldsSummary": AggregatedFieldsSummary
}
}
}
updateBug
Description
Updates a bug
Response
Returns a Bug!
Arguments
| Name | Description |
|---|---|
updateBugInput - UpdateBugInput!
|
The bug properties to update |
Example
Query
mutation updateBug($updateBugInput: UpdateBugInput!) {
updateBug(updateBugInput: $updateBugInput) {
id
projectID
localID
committedToProjectID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
status
workflow {
id
projectID
name
icon
}
workflowStatus {
id
workflowID
projectID
name
icon
connectedStatuses {
connectedTo {
...WorkflowStatusFragment
}
usersCanEditAllFields
requiredFields {
...FieldIDFragment
}
}
statusToWorkflowStatuses {
status
workflowStatusID
}
}
assignedTo {
user {
id
name
sortName
isDeleted
isLocked
userLink
}
percentageAllocation
}
confidence
risk
severity
color
hyperlink
subprojectPath
customFields {
id
taskID
}
indentationLevel
workRemaining
committedTo {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
confidence
color
risk
hyperlink
indentationLevel
itemLink
start
finish
releases {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
date
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
board
duration
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
membersHaveFullAccessRights
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
workRemaining
estimatedDays
status
points
aggregatedFieldsSummary {
points {
...AggregatedValueFragment
}
workRemaining {
...AggregatedValueFragment
}
estimatedDays {
...AggregatedValueFragment
}
customFields {
...AggregatedCustomFieldFragment
}
}
subprojectPath
allocations {
user {
...UserFragment
}
percentageAllocation
}
}
customField {
id
taskID
}
itemLink
releases {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
date
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
stepsToReproduce
detailedDescription
bugPriority
sprintPriority
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
boardLane {
id
name
}
boardColumn {
id
name
}
boardMembershipInfo {
position
hidden
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
}
}
Variables
{"updateBugInput": UpdateBugInput}
Response
{
"data": {
"updateBug": {
"id": 4,
"projectID": 4,
"localID": "4",
"committedToProjectID": "4",
"name": "xyz789",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"status": "none",
"workflow": Workflow,
"workflowStatus": WorkflowStatus,
"assignedTo": [AssignedUser],
"confidence": "none",
"risk": "none",
"severity": "none",
"color": "notSet",
"hyperlink": "abc123",
"subprojectPath": "xyz789",
"customFields": [CustomField],
"indentationLevel": 123,
"workRemaining": 123.45,
"committedTo": Sprint,
"customField": CustomField,
"itemLink": "xyz789",
"releases": [Release],
"stepsToReproduce": "xyz789",
"detailedDescription": "abc123",
"bugPriority": "none",
"sprintPriority": "none",
"links": [Link],
"hidden": true,
"boardLane": BoardLane,
"boardColumn": BoardColumn,
"boardMembershipInfo": BoardMembershipInfo,
"attachments": [Attachment],
"watchers": [User],
"watching": false
}
}
}
updateComment
Description
Updates an existing comment
Response
Returns a Comment!
Arguments
| Name | Description |
|---|---|
updateCommentInput - UpdateCommentInput!
|
Example
Query
mutation updateComment($updateCommentInput: UpdateCommentInput!) {
updateComment(updateCommentInput: $updateCommentInput) {
id
item {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
text
postedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
postedAt
mentionedUsers {
id
name
sortName
isDeleted
isLocked
userLink
}
}
}
Variables
{"updateCommentInput": UpdateCommentInput}
Response
{
"data": {
"updateComment": {
"id": 4,
"item": Item,
"text": "abc123",
"postedBy": User,
"postedAt": ISODateTime,
"mentionedUsers": [User]
}
}
}
updateExpiredPassword
Description
Updates the password of a user if the existing password has expired
Response
Returns a Boolean!
Arguments
| Name | Description |
|---|---|
updateExpiredPasswordInput - UpdateExpiredPasswordInput!
|
The required credentials to update a user's expired password |
Example
Query
mutation updateExpiredPassword($updateExpiredPasswordInput: UpdateExpiredPasswordInput!) {
updateExpiredPassword(updateExpiredPasswordInput: $updateExpiredPasswordInput)
}
Variables
{"updateExpiredPasswordInput": UpdateExpiredPasswordInput}
Response
{"data": {"updateExpiredPassword": true}}
updateExternalLink
Description
Updates an existing external link
Response
Returns a Link!
Arguments
| Name | Description |
|---|---|
updateLinkInput - UpdateExternalLinkInput!
|
Example
Query
mutation updateExternalLink($updateLinkInput: UpdateExternalLinkInput!) {
updateExternalLink(updateLinkInput: $updateLinkInput) {
fromItem {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
relation
notes
}
}
Variables
{"updateLinkInput": UpdateExternalLinkInput}
Response
{
"data": {
"updateExternalLink": {
"fromItem": Item,
"relation": "relatedTo",
"notes": "xyz789"
}
}
}
updateGhostUser
Description
Updates a ghost user by ID
Response
Returns a GhostUser!
Arguments
| Name | Description |
|---|---|
updateGhostUserInput - UpdateGhostUserInput!
|
The user properties to update |
Example
Query
mutation updateGhostUser($updateGhostUserInput: UpdateGhostUserInput!) {
updateGhostUser(updateGhostUserInput: $updateGhostUserInput) {
id
name
sortName
isDeleted
isLocked
userLink
}
}
Variables
{"updateGhostUserInput": UpdateGhostUserInput}
Response
{
"data": {
"updateGhostUser": {
"id": 4,
"name": "xyz789",
"sortName": "xyz789",
"isDeleted": true,
"isLocked": true,
"userLink": "xyz789"
}
}
}
updateInternalLink
Description
Updates an existing internal link
Response
Returns a Link!
Arguments
| Name | Description |
|---|---|
updateLinkInput - UpdateInternalLinkInput!
|
Example
Query
mutation updateInternalLink($updateLinkInput: UpdateInternalLinkInput!) {
updateInternalLink(updateLinkInput: $updateLinkInput) {
fromItem {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
relation
notes
}
}
Variables
{"updateLinkInput": UpdateInternalLinkInput}
Response
{
"data": {
"updateInternalLink": {
"fromItem": Item,
"relation": "relatedTo",
"notes": "abc123"
}
}
}
updateNormalUser
Description
Updates a normal user by ID
Response
Returns a NormalUser!
Arguments
| Name | Description |
|---|---|
updateNormalUserInput - UpdateNormalUserInput!
|
The user properties to update |
Example
Query
mutation updateNormalUser($updateNormalUserInput: UpdateNormalUserInput!) {
updateNormalUser(updateNormalUserInput: $updateNormalUserInput) {
id
name
sortName
emailAddress
accessRights {
isActiveAccount
admin
portfolioAllocation
documentManagement
avatarManagement
chat
dashboards
dashboardPageShare
}
passwordConfigurations {
mustChangePasswordNextLogon
passwordNeverExpires
cannotChangePassword
passwordDisabled
}
isDeleted
isLocked
userLink
hasAvatar
}
}
Variables
{"updateNormalUserInput": UpdateNormalUserInput}
Response
{
"data": {
"updateNormalUser": {
"id": "4",
"name": "abc123",
"sortName": "abc123",
"emailAddress": "xyz789",
"accessRights": UserAccessRights,
"passwordConfigurations": PasswordConfigurations,
"isDeleted": false,
"isLocked": true,
"userLink": "abc123",
"hasAvatar": true
}
}
}
updateProject
Description
Updates the project properties for a project
Response
Returns a Project!
Arguments
| Name | Description |
|---|---|
updateProjectInput - UpdateProjectInput!
|
The project properties that the updated project will have |
Example
Query
mutation updateProject($updateProjectInput: UpdateProjectInput!) {
updateProject(updateProjectInput: $updateProjectInput) {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
qa {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
users {
user {
id
name
sortName
isDeleted
isLocked
userLink
}
accessRights {
isMainManager
limitedVisibility
canAccessProjectHistory
}
}
userGroups {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
...BacklogFragment
}
qa {
...QaFragment
}
users {
...ProjectUserFragment
}
userGroups {
...UserGroupFragment
}
timesheetLock {
...TimesheetLockFragment
}
items {
...ItemFragment
}
workflows {
...WorkflowFragment
}
settings {
...ProjectSettingsFragment
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
timesheetLock {
activateLock
date
}
items {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
workflows {
id
projectID
name
icon
}
settings {
id
timeSpentCustomColumn {
id
projectID
name
readOnly
activated
}
priorityCustomColumn {
id
projectID
name
readOnly
activated
items {
...DropListItemFragment
}
}
commentsAllowed
}
}
}
Variables
{"updateProjectInput": UpdateProjectInput}
Response
{
"data": {
"updateProject": {
"id": "4",
"name": "abc123",
"niceName": "abc123",
"sortName": "xyz789",
"archivedStatus": true,
"schedulingMethod": "fixedDuration",
"taskCompletionMethod": "auto",
"defaultMode": "taskScheduling",
"methodTemplate": "scrum",
"backlog": Backlog,
"qa": Qa,
"users": [ProjectUser],
"userGroups": [UserGroup],
"timesheetLock": TimesheetLock,
"items": [Item],
"workflows": [Workflow],
"settings": ProjectSettings
}
}
}
updateProjectUserAccessRights
Description
Updates the access rights for a user in a project
Response
Returns a ProjectUser!
Arguments
| Name | Description |
|---|---|
projectID - ID!
|
The id of the project to update user access rights in |
userID - ID!
|
The id of the user to update acccess rights for |
accessRights - ProjectUserAccessRightsInput!
|
The updated access rights for the user |
Example
Query
mutation updateProjectUserAccessRights(
$projectID: ID!,
$userID: ID!,
$accessRights: ProjectUserAccessRightsInput!
) {
updateProjectUserAccessRights(
projectID: $projectID,
userID: $userID,
accessRights: $accessRights
) {
user {
id
name
sortName
isDeleted
isLocked
userLink
}
accessRights {
isMainManager
limitedVisibility
canAccessProjectHistory
}
}
}
Variables
{
"projectID": 4,
"userID": "4",
"accessRights": ProjectUserAccessRightsInput
}
Response
{
"data": {
"updateProjectUserAccessRights": {
"user": User,
"accessRights": ProjectUserAccessRights
}
}
}
updateQaUser
Description
Updates a QA user by ID
Response
Returns a QaUser!
Arguments
| Name | Description |
|---|---|
updateQaUserInput - UpdateQaUserInput!
|
The user properties to update |
Example
Query
mutation updateQaUser($updateQaUserInput: UpdateQaUserInput!) {
updateQaUser(updateQaUserInput: $updateQaUserInput) {
id
name
sortName
emailAddress
accessRights {
isActiveAccount
documentManagement
avatarManagement
chat
}
passwordConfigurations {
mustChangePasswordNextLogon
passwordNeverExpires
cannotChangePassword
passwordDisabled
}
isDeleted
isLocked
userLink
hasAvatar
}
}
Variables
{"updateQaUserInput": UpdateQaUserInput}
Response
{
"data": {
"updateQaUser": {
"id": 4,
"name": "xyz789",
"sortName": "abc123",
"emailAddress": "xyz789",
"accessRights": QaUserAccessRights,
"passwordConfigurations": PasswordConfigurations,
"isDeleted": true,
"isLocked": false,
"userLink": "abc123",
"hasAvatar": false
}
}
}
updateRelease
Description
Updates a release by ID
Response
Returns a Release!
Arguments
| Name | Description |
|---|---|
updateReleaseInput - UpdateReleaseInput!
|
The release properties to update |
Example
Query
mutation updateRelease($updateReleaseInput: UpdateReleaseInput!) {
updateRelease(updateReleaseInput: $updateReleaseInput) {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
date
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Variables
{"updateReleaseInput": UpdateReleaseInput}
Response
{
"data": {
"updateRelease": {
"id": 4,
"projectID": 4,
"localID": "4",
"name": "abc123",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "abc123",
"indentationLevel": 123,
"itemLink": "abc123",
"date": ISODate,
"links": [Link],
"hidden": true,
"watchers": [User],
"watching": true,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "xyz789"
}
}
}
updateScheduledTask
Description
Updates a scheduled task by ID
Response
Returns a ScheduledTask!
Arguments
| Name | Description |
|---|---|
updateScheduledTaskInput - UpdateScheduledTaskInput!
|
The scheduled task properties to update |
Example
Query
mutation updateScheduledTask($updateScheduledTaskInput: UpdateScheduledTaskInput!) {
updateScheduledTask(updateScheduledTaskInput: $updateScheduledTaskInput) {
id
projectID
localID
committedToProjectID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
status
workflow {
id
projectID
name
icon
}
workflowStatus {
id
workflowID
projectID
name
icon
connectedStatuses {
connectedTo {
...WorkflowStatusFragment
}
usersCanEditAllFields
requiredFields {
...FieldIDFragment
}
}
statusToWorkflowStatuses {
status
workflowStatusID
}
}
confidence
risk
color
hyperlink
assignedTo {
user {
id
name
sortName
isDeleted
isLocked
userLink
}
percentageAllocation
}
subprojectPath
points
customFields {
id
taskID
}
indentationLevel
customField {
id
taskID
}
itemLink
timeSpans {
start
finish
}
releases {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
date
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
category
backlogPriority
estimatedDays
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
duration
isUserStory
userStory
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
wbs
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
linkedToPipelineTask {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
createdFromWorkflow
hasChildren
aggregatedFieldsSummary {
points {
projectValue
committedToProjectValue
originalValue
}
workRemaining {
projectValue
committedToProjectValue
originalValue
}
estimatedDays {
projectValue
committedToProjectValue
originalValue
}
customFields {
id
value {
...AggregatedValueFragment
}
}
}
}
}
Variables
{"updateScheduledTaskInput": UpdateScheduledTaskInput}
Response
{
"data": {
"updateScheduledTask": {
"id": "4",
"projectID": 4,
"localID": 4,
"committedToProjectID": "4",
"name": "xyz789",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"status": "none",
"workflow": Workflow,
"workflowStatus": WorkflowStatus,
"confidence": "none",
"risk": "none",
"color": "notSet",
"hyperlink": "abc123",
"assignedTo": [AssignedUser],
"subprojectPath": "xyz789",
"points": 987,
"customFields": [CustomField],
"indentationLevel": 123,
"customField": CustomField,
"itemLink": "xyz789",
"timeSpans": [TimeSpan],
"releases": [Release],
"category": "none",
"backlogPriority": "none",
"estimatedDays": 123.45,
"links": [Link],
"hidden": false,
"duration": 123,
"isUserStory": true,
"userStory": "abc123",
"attachments": [Attachment],
"wbs": "xyz789",
"watchers": [User],
"watching": true,
"linkedToPipelineTask": Item,
"createdFromWorkflow": true,
"hasChildren": false,
"aggregatedFieldsSummary": AggregatedFieldsSummary
}
}
}
updateSdkUser
Description
Updates an SDK user by ID
Response
Returns a SdkUser!
Arguments
| Name | Description |
|---|---|
updateSdkUserInput - UpdateSdkUserInput!
|
The user properties to update |
Example
Query
mutation updateSdkUser($updateSdkUserInput: UpdateSdkUserInput!) {
updateSdkUser(updateSdkUserInput: $updateSdkUserInput) {
id
name
sortName
syncMethod
passwordConfigurations {
mustChangePasswordNextLogon
passwordNeverExpires
cannotChangePassword
passwordDisabled
}
isDeleted
isLocked
authenticationProvider
credentialCheckProvider
chatUser
isActiveAccount
userLink
}
}
Variables
{"updateSdkUserInput": UpdateSdkUserInput}
Response
{
"data": {
"updateSdkUser": {
"id": "4",
"name": "xyz789",
"sortName": "xyz789",
"syncMethod": "allMembersProjects",
"passwordConfigurations": PasswordConfigurations,
"isDeleted": true,
"isLocked": true,
"authenticationProvider": false,
"credentialCheckProvider": true,
"chatUser": false,
"isActiveAccount": true,
"userLink": "xyz789"
}
}
}
updateSprint
Description
Updates a sprint by ID
Response
Returns a Sprint!
Arguments
| Name | Description |
|---|---|
updateSprintInput - UpdateSprintInput!
|
The sprint properties to update |
Example
Query
mutation updateSprint($updateSprintInput: UpdateSprintInput!) {
updateSprint(updateSprintInput: $updateSprintInput) {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
confidence
color
risk
hyperlink
indentationLevel
itemLink
start
finish
releases {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
date
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
board
duration
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
membersHaveFullAccessRights
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
workRemaining
estimatedDays
status
points
aggregatedFieldsSummary {
points {
projectValue
committedToProjectValue
originalValue
}
workRemaining {
projectValue
committedToProjectValue
originalValue
}
estimatedDays {
projectValue
committedToProjectValue
originalValue
}
customFields {
id
value {
...AggregatedValueFragment
}
}
}
subprojectPath
allocations {
user {
id
name
sortName
isDeleted
isLocked
userLink
}
percentageAllocation
}
}
}
Variables
{"updateSprintInput": UpdateSprintInput}
Response
{
"data": {
"updateSprint": {
"id": "4",
"projectID": 4,
"localID": 4,
"name": "xyz789",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"confidence": "none",
"color": "notSet",
"risk": "none",
"hyperlink": "abc123",
"indentationLevel": 987,
"itemLink": "abc123",
"start": ISODate,
"finish": ISODate,
"releases": [Release],
"links": [Link],
"hidden": true,
"board": true,
"duration": 987,
"watchers": [User],
"watching": false,
"membersHaveFullAccessRights": true,
"customFields": [CustomField],
"attachments": [Attachment],
"workRemaining": 123.45,
"estimatedDays": 987.65,
"status": "none",
"points": 123,
"aggregatedFieldsSummary": AggregatedFieldsSummary,
"subprojectPath": "xyz789",
"allocations": [SprintUser]
}
}
}
updateUserGroup
Description
Updates a user group
Response
Returns a UserGroup!
Arguments
| Name | Description |
|---|---|
updateUserGroupInput - UpdateUserGroupInput!
|
The user group properties to be changed |
Example
Query
mutation updateUserGroup($updateUserGroupInput: UpdateUserGroupInput!) {
updateUserGroup(updateUserGroupInput: $updateUserGroupInput) {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
id
items {
...ItemFragment
}
}
qa {
id
items {
...ItemFragment
}
}
users {
user {
...UserFragment
}
accessRights {
...ProjectUserAccessRightsFragment
}
}
userGroups {
id
project {
...ProjectFragment
}
name
sortName
users {
...UserFragment
}
}
timesheetLock {
activateLock
date
}
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
workflows {
id
projectID
name
icon
}
settings {
id
timeSpentCustomColumn {
...TimeSpentCustomColumnFragment
}
priorityCustomColumn {
...SingleSelectionDropListCustomColumnFragment
}
commentsAllowed
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
}
Variables
{"updateUserGroupInput": UpdateUserGroupInput}
Response
{
"data": {
"updateUserGroup": {
"id": "4",
"project": Project,
"name": "abc123",
"sortName": "abc123",
"users": [User]
}
}
}
Subscriptions
chartAdded
Description
Subscribes to chart added events
Response
Returns a Chart!
Example
Query
subscription chartAdded {
chartAdded {
id
name
}
}
Response
{
"data": {
"chartAdded": {
"id": 4,
"name": "abc123"
}
}
}
chartData
Description
Subscribes to chart data and updates to the chart data for a chart
Response
Returns a ChartData
Arguments
| Name | Description |
|---|---|
id - ID!
|
The unique id of the chart to get chart data and updates for |
Example
Query
subscription chartData($id: ID!) {
chartData(id: $id) {
dimensions
measures
}
}
Variables
{"id": "4"}
Response
{
"data": {
"chartData": {
"dimensions": ["abc123"],
"measures": ["abc123"]
}
}
}
chartDeleted
Description
Subscribes to chart deleted events and returns the ID of the chart
Response
Returns an ID!
Example
Query
subscription chartDeleted {
chartDeleted
}
Response
{"data": {"chartDeleted": 4}}
chartUpdated
Description
Subscribes to changes for a chart by ID
commentAdded
Description
Subscribes to comment additions on an item by ID
Response
Returns a Comment!
Arguments
| Name | Description |
|---|---|
id - ID!
|
The unique id of the item to listen for comment additions on |
Example
Query
subscription commentAdded($id: ID!) {
commentAdded(id: $id) {
id
item {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
text
postedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
postedAt
mentionedUsers {
id
name
sortName
isDeleted
isLocked
userLink
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"commentAdded": {
"id": "4",
"item": Item,
"text": "xyz789",
"postedBy": User,
"postedAt": ISODateTime,
"mentionedUsers": [User]
}
}
}
commentDeleted
Description
Subscribes to comment deletions on an item by ID
commentUpdated
Description
Subscribes to comment updates on an item by ID
Response
Returns a Comment!
Arguments
| Name | Description |
|---|---|
id - ID!
|
The unique id of the item to listen for comment updates on |
Example
Query
subscription commentUpdated($id: ID!) {
commentUpdated(id: $id) {
id
item {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
text
postedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
postedAt
mentionedUsers {
id
name
sortName
isDeleted
isLocked
userLink
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"commentUpdated": {
"id": "4",
"item": Item,
"text": "abc123",
"postedBy": User,
"postedAt": ISODateTime,
"mentionedUsers": [User]
}
}
}
communicationChannelPacketReceived
Description
Subscribes to packages sent to a communication channel by name
Response
Returns a CommunicationChannelPackage!
Arguments
| Name | Description |
|---|---|
name - String!
|
The name of the communication channel to listen to incoming packages for |
Example
Query
subscription communicationChannelPacketReceived($name: String!) {
communicationChannelPacketReceived(name: $name) {
name
data
toSessionID
fromSessionID
}
}
Variables
{"name": "xyz789"}
Response
{
"data": {
"communicationChannelPacketReceived": {
"name": "abc123",
"data": "xyz789",
"toSessionID": 4,
"fromSessionID": 4
}
}
}
dashboardPageAdded
Description
Subscribes to dashboard page added events
Response
Returns a DashboardPage!
Example
Query
subscription dashboardPageAdded {
dashboardPageAdded {
id
name
charts {
id
name
}
layout {
style
columns {
charts {
...ChartFragment
}
}
}
theme
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
}
Response
{
"data": {
"dashboardPageAdded": {
"id": 4,
"name": "abc123",
"charts": [Chart],
"layout": DashboardLayout,
"theme": "4",
"createdBy": User
}
}
}
dashboardPageDeleted
Description
Subscribes to dashoboard page deleted events and returns the ID of the dashboard page
Response
Returns an ID!
Example
Query
subscription dashboardPageDeleted {
dashboardPageDeleted
}
Response
{"data": {"dashboardPageDeleted": 4}}
dashboardPageUpdated
Description
Subscribes to changes for a dashboard page by ID
Response
Returns a DashboardPage!
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
subscription dashboardPageUpdated($id: ID!) {
dashboardPageUpdated(id: $id) {
id
name
charts {
id
name
}
layout {
style
columns {
charts {
...ChartFragment
}
}
}
theme
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"dashboardPageUpdated": {
"id": 4,
"name": "abc123",
"charts": [Chart],
"layout": DashboardLayout,
"theme": "4",
"createdBy": User
}
}
}
healthcheck
Description
Subscribes to healthcheck updates for the Helix Plan API. Returns true if the Helix Plan API is up and running and false if it is not
Response
Returns a Boolean!
Example
Query
subscription healthcheck {
healthcheck
}
Response
{"data": {"healthcheck": false}}
itemAssigned
Description
Subscribes to additions on the logged in user's assigned items
Response
Returns an Item!
Example
Query
subscription itemAssigned {
itemAssigned {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Response
{
"data": {
"itemAssigned": {
"id": 4,
"projectID": 4,
"localID": "4",
"name": "xyz789",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "abc123",
"indentationLevel": 123,
"itemLink": "abc123",
"links": [Link],
"hidden": false,
"watchers": [User],
"watching": false,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "xyz789"
}
}
}
itemDeleted
Description
Subscribes to deletions for an array of Item Ids and returns the item ID that was deleted
itemFieldUpdated
Description
Subscribes to changes for an array of Item IDs and returns the field of the item that changed
Response
Returns a FieldUpdated!
Arguments
| Name | Description |
|---|---|
itemIDs - [ID]!
|
A list of the unique ids of the items to listen for changes for |
Example
Query
subscription itemFieldUpdated($itemIDs: [ID]!) {
itemFieldUpdated(itemIDs: $itemIDs) {
itemID
}
}
Variables
{"itemIDs": [4]}
Response
{
"data": {
"itemFieldUpdated": {"itemID": "4"}
}
}
itemTypeUpdated
Description
Subscribes to item type changes for an array if Item IDs, returns the ID of the item that changed
Response
Returns an ID!
Arguments
| Name | Description |
|---|---|
itemIDs - [ID]!
|
A list of the unique ids of the items to listen for type changes for |
Example
Query
subscription itemTypeUpdated($itemIDs: [ID]!) {
itemTypeUpdated(itemIDs: $itemIDs)
}
Variables
{"itemIDs": [4]}
Response
{"data": {"itemTypeUpdated": 4}}
itemUnassigned
Description
Subscribes to removals on the logged in user's assigned items
Response
Returns an Item!
Example
Query
subscription itemUnassigned {
itemUnassigned {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Response
{
"data": {
"itemUnassigned": {
"id": 4,
"projectID": 4,
"localID": 4,
"name": "abc123",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "abc123",
"indentationLevel": 987,
"itemLink": "xyz789",
"links": [Link],
"hidden": false,
"watchers": [User],
"watching": false,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "abc123"
}
}
}
itemsCreated
Description
Subscribes to item creations on a specific project by ID and returns them
Response
Returns [Item]!
Arguments
| Name | Description |
|---|---|
projectID - ID!
|
The unique id of the project to listen for task creations |
Example
Query
subscription itemsCreated($projectID: ID!) {
itemsCreated(projectID: $projectID) {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Variables
{"projectID": "4"}
Response
{
"data": {
"itemsCreated": [
{
"id": 4,
"projectID": "4",
"localID": "4",
"name": "xyz789",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "abc123",
"indentationLevel": 123,
"itemLink": "xyz789",
"links": [Link],
"hidden": false,
"watchers": [User],
"watching": false,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "abc123"
}
]
}
}
loginWithSso
Description
Initiates SSO login and subscribes to updates from the Helix authentication service for the session
Response
Returns a SsoResponse!
Example
Query
subscription loginWithSso {
loginWithSso {
token {
access_token
}
ssoURL
}
}
Response
{
"data": {
"loginWithSso": {
"token": Token,
"ssoURL": "xyz789"
}
}
}
pipelineTaskStatusUpdated
Description
Subscribes to status changes to logged in user's assigned pipeline tasks
Response
Returns an Item!
Arguments
| Name | Description |
|---|---|
showOptions - ShowOptions
|
The show options that can be passed in the todo list. Will return item if pipeline task completion status changed and showPipelineTasksThatCannotStart is true. If not set, all status changes will be returned |
Example
Query
subscription pipelineTaskStatusUpdated($showOptions: ShowOptions) {
pipelineTaskStatusUpdated(showOptions: $showOptions) {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Variables
{"showOptions": ShowOptions}
Response
{
"data": {
"pipelineTaskStatusUpdated": {
"id": "4",
"projectID": 4,
"localID": 4,
"name": "abc123",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "xyz789",
"indentationLevel": 987,
"itemLink": "abc123",
"links": [Link],
"hidden": false,
"watchers": [User],
"watching": false,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "abc123"
}
}
}
projectActiveColumnsUpdated
Description
Subscribes to updates on a project's active columns, returns the updated list of the active columns
Example
Query
subscription projectActiveColumnsUpdated($id: ID!) {
projectActiveColumnsUpdated(id: $id) {
id
projectID
name
readOnly
}
}
Variables
{"id": "4"}
Response
{
"data": {
"projectActiveColumnsUpdated": [
{
"id": "4",
"projectID": 4,
"name": "abc123",
"readOnly": false
}
]
}
}
projectAdded
Description
Subscribes to project added events
Response
Returns a Project!
Example
Query
subscription projectAdded {
projectAdded {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
qa {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
users {
user {
id
name
sortName
isDeleted
isLocked
userLink
}
accessRights {
isMainManager
limitedVisibility
canAccessProjectHistory
}
}
userGroups {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
...BacklogFragment
}
qa {
...QaFragment
}
users {
...ProjectUserFragment
}
userGroups {
...UserGroupFragment
}
timesheetLock {
...TimesheetLockFragment
}
items {
...ItemFragment
}
workflows {
...WorkflowFragment
}
settings {
...ProjectSettingsFragment
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
timesheetLock {
activateLock
date
}
items {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
workflows {
id
projectID
name
icon
}
settings {
id
timeSpentCustomColumn {
id
projectID
name
readOnly
activated
}
priorityCustomColumn {
id
projectID
name
readOnly
activated
items {
...DropListItemFragment
}
}
commentsAllowed
}
}
}
Response
{
"data": {
"projectAdded": {
"id": "4",
"name": "xyz789",
"niceName": "abc123",
"sortName": "abc123",
"archivedStatus": true,
"schedulingMethod": "fixedDuration",
"taskCompletionMethod": "auto",
"defaultMode": "taskScheduling",
"methodTemplate": "scrum",
"backlog": Backlog,
"qa": Qa,
"users": [ProjectUser],
"userGroups": [UserGroup],
"timesheetLock": TimesheetLock,
"items": [Item],
"workflows": [Workflow],
"settings": ProjectSettings
}
}
}
projectColumnsUpdated
Description
Subscribes to updates on a project's columns, returns the updated list of the columns
Example
Query
subscription projectColumnsUpdated($id: ID!) {
projectColumnsUpdated(id: $id) {
id
projectID
name
readOnly
}
}
Variables
{"id": "4"}
Response
{
"data": {
"projectColumnsUpdated": [
{
"id": 4,
"projectID": 4,
"name": "abc123",
"readOnly": true
}
]
}
}
projectDeleted
Description
Subscribes to project deleted events
Response
Returns an ID!
Example
Query
subscription projectDeleted {
projectDeleted
}
Response
{"data": {"projectDeleted": "4"}}
projectSettingsUpdated
Description
Subscribes to updates to project settings for a project
Response
Returns a ProjectSettings!
Arguments
| Name | Description |
|---|---|
projectIDs - [ID]!
|
A list of unique ids of the projects to listen for project setting changes for |
Example
Query
subscription projectSettingsUpdated($projectIDs: [ID]!) {
projectSettingsUpdated(projectIDs: $projectIDs) {
id
timeSpentCustomColumn {
id
projectID
name
readOnly
activated
}
priorityCustomColumn {
id
projectID
name
readOnly
activated
items {
id
name
icon
}
}
commentsAllowed
}
}
Variables
{"projectIDs": [4]}
Response
{
"data": {
"projectSettingsUpdated": {
"id": "4",
"timeSpentCustomColumn": TimeSpentCustomColumn,
"priorityCustomColumn": SingleSelectionDropListCustomColumn,
"commentsAllowed": false
}
}
}
projectUpdated
Description
Subscribes to changes for a Project by ID
Response
Returns a Project!
Arguments
| Name | Description |
|---|---|
id - ID!
|
The unique id of the project to listen for changes for |
Example
Query
subscription projectUpdated($id: ID!) {
projectUpdated(id: $id) {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
qa {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
users {
user {
id
name
sortName
isDeleted
isLocked
userLink
}
accessRights {
isMainManager
limitedVisibility
canAccessProjectHistory
}
}
userGroups {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
...BacklogFragment
}
qa {
...QaFragment
}
users {
...ProjectUserFragment
}
userGroups {
...UserGroupFragment
}
timesheetLock {
...TimesheetLockFragment
}
items {
...ItemFragment
}
workflows {
...WorkflowFragment
}
settings {
...ProjectSettingsFragment
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
timesheetLock {
activateLock
date
}
items {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
workflows {
id
projectID
name
icon
}
settings {
id
timeSpentCustomColumn {
id
projectID
name
readOnly
activated
}
priorityCustomColumn {
id
projectID
name
readOnly
activated
items {
...DropListItemFragment
}
}
commentsAllowed
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"projectUpdated": {
"id": "4",
"name": "abc123",
"niceName": "xyz789",
"sortName": "xyz789",
"archivedStatus": false,
"schedulingMethod": "fixedDuration",
"taskCompletionMethod": "auto",
"defaultMode": "taskScheduling",
"methodTemplate": "scrum",
"backlog": Backlog,
"qa": Qa,
"users": [ProjectUser],
"userGroups": [UserGroup],
"timesheetLock": TimesheetLock,
"items": [Item],
"workflows": [Workflow],
"settings": ProjectSettings
}
}
}
projectUserAdded
Description
Subscribes to user added to project
Response
Returns a User!
Arguments
| Name | Description |
|---|---|
id - ID!
|
The unique id of the project to listen for user added events in |
Example
Query
subscription projectUserAdded($id: ID!) {
projectUserAdded(id: $id) {
id
name
sortName
isDeleted
isLocked
userLink
}
}
Variables
{"id": "4"}
Response
{
"data": {
"projectUserAdded": {
"id": "4",
"name": "xyz789",
"sortName": "xyz789",
"isDeleted": true,
"isLocked": false,
"userLink": "abc123"
}
}
}
projectUserGroupAdded
Description
Subscribes to user group added to project
Response
Returns a UserGroup!
Arguments
| Name | Description |
|---|---|
id - ID!
|
The unique id of the project to listen for user group added events in |
Example
Query
subscription projectUserGroupAdded($id: ID!) {
projectUserGroupAdded(id: $id) {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
id
items {
...ItemFragment
}
}
qa {
id
items {
...ItemFragment
}
}
users {
user {
...UserFragment
}
accessRights {
...ProjectUserAccessRightsFragment
}
}
userGroups {
id
project {
...ProjectFragment
}
name
sortName
users {
...UserFragment
}
}
timesheetLock {
activateLock
date
}
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
workflows {
id
projectID
name
icon
}
settings {
id
timeSpentCustomColumn {
...TimeSpentCustomColumnFragment
}
priorityCustomColumn {
...SingleSelectionDropListCustomColumnFragment
}
commentsAllowed
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"projectUserGroupAdded": {
"id": "4",
"project": Project,
"name": "abc123",
"sortName": "xyz789",
"users": [User]
}
}
}
projectUserGroupRemoved
Description
Subscribes to user group removed from project
Response
Returns a UserGroup!
Arguments
| Name | Description |
|---|---|
id - ID!
|
The unique id of the project to listen for user group removed events in |
Example
Query
subscription projectUserGroupRemoved($id: ID!) {
projectUserGroupRemoved(id: $id) {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
id
items {
...ItemFragment
}
}
qa {
id
items {
...ItemFragment
}
}
users {
user {
...UserFragment
}
accessRights {
...ProjectUserAccessRightsFragment
}
}
userGroups {
id
project {
...ProjectFragment
}
name
sortName
users {
...UserFragment
}
}
timesheetLock {
activateLock
date
}
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
workflows {
id
projectID
name
icon
}
settings {
id
timeSpentCustomColumn {
...TimeSpentCustomColumnFragment
}
priorityCustomColumn {
...SingleSelectionDropListCustomColumnFragment
}
commentsAllowed
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
}
Variables
{"id": "4"}
Response
{
"data": {
"projectUserGroupRemoved": {
"id": 4,
"project": Project,
"name": "abc123",
"sortName": "xyz789",
"users": [User]
}
}
}
projectUserRemoved
Description
Subscribes to user removed from project
Response
Returns a User!
Arguments
| Name | Description |
|---|---|
id - ID!
|
The unique id of the project to listen for user removed events in |
Example
Query
subscription projectUserRemoved($id: ID!) {
projectUserRemoved(id: $id) {
id
name
sortName
isDeleted
isLocked
userLink
}
}
Variables
{"id": 4}
Response
{
"data": {
"projectUserRemoved": {
"id": 4,
"name": "xyz789",
"sortName": "xyz789",
"isDeleted": true,
"isLocked": false,
"userLink": "xyz789"
}
}
}
securityPolicyUpdated
Description
Subscribes to updates to the security policy
Response
Returns a SecurityPolicy!
Example
Query
subscription securityPolicyUpdated {
securityPolicyUpdated {
minPasswordLength
minPasswordAlpha
minPasswordNumeric
minPasswordNonAlphaNumeric
minPasswordUpperCase
minPasswordLowerCase
passwordExpireDays
tokensExpireDays
passwordsInHistory
adminsCanChangePolicy
}
}
Response
{
"data": {
"securityPolicyUpdated": {
"minPasswordLength": 123,
"minPasswordAlpha": 123,
"minPasswordNumeric": 123,
"minPasswordNonAlphaNumeric": 123,
"minPasswordUpperCase": 123,
"minPasswordLowerCase": 123,
"passwordExpireDays": 123,
"tokensExpireDays": 123,
"passwordsInHistory": 123,
"adminsCanChangePolicy": true
}
}
}
todoTaskIsUncompleted
Description
Subscribes to status changes from complete to another status, i.e. an uncomplete status, for a task in a user's todo list
Response
Returns an Item!
Example
Query
subscription todoTaskIsUncompleted {
todoTaskIsUncompleted {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
}
subprojectPath
}
}
Response
{
"data": {
"todoTaskIsUncompleted": {
"id": "4",
"projectID": 4,
"localID": 4,
"name": "abc123",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "xyz789",
"indentationLevel": 123,
"itemLink": "xyz789",
"links": [Link],
"hidden": true,
"watchers": [User],
"watching": true,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "xyz789"
}
}
}
userAdded
Description
Subscribes to user added events
Response
Returns a User!
Example
Query
subscription userAdded {
userAdded {
id
name
sortName
isDeleted
isLocked
userLink
}
}
Response
{
"data": {
"userAdded": {
"id": "4",
"name": "xyz789",
"sortName": "abc123",
"isDeleted": true,
"isLocked": true,
"userLink": "abc123"
}
}
}
userAddedToProject
Description
Subscribes to user added to project events
Example
Query
subscription userAddedToProject($id: ID!) {
userAddedToProject(id: $id) {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
qa {
id
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
}
users {
user {
id
name
sortName
isDeleted
isLocked
userLink
}
accessRights {
isMainManager
limitedVisibility
canAccessProjectHistory
}
}
userGroups {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
...BacklogFragment
}
qa {
...QaFragment
}
users {
...ProjectUserFragment
}
userGroups {
...UserGroupFragment
}
timesheetLock {
...TimesheetLockFragment
}
items {
...ItemFragment
}
workflows {
...WorkflowFragment
}
settings {
...ProjectSettingsFragment
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
timesheetLock {
activateLock
date
}
items {
id
projectID
localID
name
createdBy {
id
name
sortName
isDeleted
isLocked
userLink
}
createdOn
lastUpdatedBy {
id
name
sortName
isDeleted
isLocked
userLink
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
fromItem {
...ItemFragment
}
relation
notes
}
hidden
watchers {
id
name
sortName
isDeleted
isLocked
userLink
}
watching
customFields {
id
taskID
}
attachments {
id
path
size
version
imageWidth
imageHeight
coverImage
addedBy {
...UserFragment
}
}
subprojectPath
}
workflows {
id
projectID
name
icon
}
settings {
id
timeSpentCustomColumn {
id
projectID
name
readOnly
activated
}
priorityCustomColumn {
id
projectID
name
readOnly
activated
items {
...DropListItemFragment
}
}
commentsAllowed
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"userAddedToProject": {
"id": "4",
"name": "xyz789",
"niceName": "xyz789",
"sortName": "abc123",
"archivedStatus": true,
"schedulingMethod": "fixedDuration",
"taskCompletionMethod": "auto",
"defaultMode": "taskScheduling",
"methodTemplate": "scrum",
"backlog": Backlog,
"qa": Qa,
"users": [ProjectUser],
"userGroups": [UserGroup],
"timesheetLock": TimesheetLock,
"items": [Item],
"workflows": [Workflow],
"settings": ProjectSettings
}
}
}
userDeleted
Description
Subscribes to user deleted events and returns the ID of the deleted user
Response
Returns an ID!
Example
Query
subscription userDeleted {
userDeleted
}
Response
{"data": {"userDeleted": "4"}}
userGroupAdded
Description
Subscribes to user group added events
Response
Returns a UserGroup!
Example
Query
subscription userGroupAdded {
userGroupAdded {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
id
items {
...ItemFragment
}
}
qa {
id
items {
...ItemFragment
}
}
users {
user {
...UserFragment
}
accessRights {
...ProjectUserAccessRightsFragment
}
}
userGroups {
id
project {
...ProjectFragment
}
name
sortName
users {
...UserFragment
}
}
timesheetLock {
activateLock
date
}
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
workflows {
id
projectID
name
icon
}
settings {
id
timeSpentCustomColumn {
...TimeSpentCustomColumnFragment
}
priorityCustomColumn {
...SingleSelectionDropListCustomColumnFragment
}
commentsAllowed
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
}
Response
{
"data": {
"userGroupAdded": {
"id": "4",
"project": Project,
"name": "xyz789",
"sortName": "abc123",
"users": [User]
}
}
}
userGroupDeleted
Description
Subscribes to user group deleted events and returns the ID of the deleted user group
Response
Returns an ID!
Example
Query
subscription userGroupDeleted {
userGroupDeleted
}
Response
{"data": {"userGroupDeleted": 4}}
userGroupUpdated
Description
Subscribes to changes for a list of user groups by IDs
Response
Returns a UserGroup!
Arguments
| Name | Description |
|---|---|
ids - [ID]!
|
A list of unique ids of the user groups to listen for changes for |
Example
Query
subscription userGroupUpdated($ids: [ID]!) {
userGroupUpdated(ids: $ids) {
id
project {
id
name
niceName
sortName
archivedStatus
schedulingMethod
taskCompletionMethod
defaultMode
methodTemplate
backlog {
id
items {
...ItemFragment
}
}
qa {
id
items {
...ItemFragment
}
}
users {
user {
...UserFragment
}
accessRights {
...ProjectUserAccessRightsFragment
}
}
userGroups {
id
project {
...ProjectFragment
}
name
sortName
users {
...UserFragment
}
}
timesheetLock {
activateLock
date
}
items {
id
projectID
localID
name
createdBy {
...UserFragment
}
createdOn
lastUpdatedBy {
...UserFragment
}
lastUpdatedOn
lastCommentedOn
color
hyperlink
indentationLevel
itemLink
links {
...LinkFragment
}
hidden
watchers {
...UserFragment
}
watching
customFields {
...CustomFieldFragment
}
attachments {
...AttachmentFragment
}
subprojectPath
}
workflows {
id
projectID
name
icon
}
settings {
id
timeSpentCustomColumn {
...TimeSpentCustomColumnFragment
}
priorityCustomColumn {
...SingleSelectionDropListCustomColumnFragment
}
commentsAllowed
}
}
name
sortName
users {
id
name
sortName
isDeleted
isLocked
userLink
}
}
}
Variables
{"ids": [4]}
Response
{
"data": {
"userGroupUpdated": {
"id": 4,
"project": Project,
"name": "xyz789",
"sortName": "abc123",
"users": [User]
}
}
}
userUpdated
Description
Subscribes to real time changes for a list of users by ID
Example
Query
subscription userUpdated($ids: [ID]!) {
userUpdated(ids: $ids) {
id
name
sortName
isDeleted
isLocked
userLink
}
}
Variables
{"ids": ["4"]}
Response
{
"data": {
"userUpdated": {
"id": "4",
"name": "abc123",
"sortName": "xyz789",
"isDeleted": false,
"isLocked": true,
"userLink": "abc123"
}
}
}
workflowAdded
Description
Subscribes to workflow added events
Response
Returns a Workflow!
Example
Query
subscription workflowAdded {
workflowAdded {
id
projectID
name
icon
}
}
Response
{
"data": {
"workflowAdded": {
"id": "4",
"projectID": 4,
"name": "xyz789",
"icon": "default"
}
}
}
workflowDeleted
Description
Subscribes to workflow deleted events and returns the ID of the deleted workflow
Response
Returns a WorkflowID!
Arguments
| Name | Description |
|---|---|
workflows - [WorkflowIDInput]!
|
A list of workflows to listen for changes for |
Example
Query
subscription workflowDeleted($workflows: [WorkflowIDInput]!) {
workflowDeleted(workflows: $workflows) {
id
projectID
}
}
Variables
{"workflows": [WorkflowIDInput]}
Response
{
"data": {
"workflowDeleted": {
"id": "4",
"projectID": "4"
}
}
}
workflowHideInTodoListUpdated
Description
Subscribes to todo list, task workflow statuses hide in todo flag changes
Response
Returns an ItemInTodoListWorkflowStatusHidden!
Example
Query
subscription workflowHideInTodoListUpdated {
workflowHideInTodoListUpdated {
itemID
hidden
}
}
Response
{
"data": {
"workflowHideInTodoListUpdated": {
"itemID": "4",
"hidden": true
}
}
}
workflowUpdated
Description
Subscribes to changes for a workflow
Response
Returns a Workflow!
Arguments
| Name | Description |
|---|---|
workflows - [WorkflowIDInput]!
|
A list of workflows to listen for changes for |
Example
Query
subscription workflowUpdated($workflows: [WorkflowIDInput]!) {
workflowUpdated(workflows: $workflows) {
id
projectID
name
icon
}
}
Variables
{"workflows": [WorkflowIDInput]}
Response
{
"data": {
"workflowUpdated": {
"id": "4",
"projectID": "4",
"name": "abc123",
"icon": "default"
}
}
}
Types
AddDocumentInput
AddDocumentsInput
Fields
| Input Field | Description |
|---|---|
comment - String
|
An add comment string |
deleteSourceFiles - Boolean!
|
Set to true to delete the local document after the operation has finished |
extraData - String
|
Optional Base64 encoded data that will be included in the response |
documents - [AddDocumentInput]!
|
The documents to add |
Example
{
"comment": "xyz789",
"deleteSourceFiles": true,
"extraData": "xyz789",
"documents": [AddDocumentInput]
}
AddExternalLinkInput
Description
The properties of the external link to add
Example
{
"fromItemID": "4",
"url": "abc123",
"relation": "relatedTo",
"notes": "xyz789"
}
AddInternaLinkInput
Description
The properties of the internal link to add
Example
{
"fromItemID": "4",
"toItemID": "4",
"relation": "relatedTo",
"notes": "abc123"
}
AdminSetting
Description
Administration settings for a database
Fields
| Field Name | Description |
|---|---|
securityPolicy - SecurityPolicy!
|
The security policy for the database |
Example
{"securityPolicy": SecurityPolicy}
AggregatedCustomField
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the custom field |
value - AggregatedValue!
|
The aggregated value of the custom field |
Example
{"id": 4, "value": AggregatedValue}
AggregatedFieldsSummary
Description
The aggregated summary values of items with children
Fields
| Field Name | Description |
|---|---|
points - AggregatedValue!
|
|
workRemaining - AggregatedValue!
|
|
estimatedDays - AggregatedValue!
|
|
customFields - [AggregatedCustomField!]
|
Example
{
"points": AggregatedValue,
"workRemaining": AggregatedValue,
"estimatedDays": AggregatedValue,
"customFields": [AggregatedCustomField]
}
AggregatedValue
Fields
| Field Name | Description |
|---|---|
projectValue - String
|
The aggregated value in the project the item was created in |
committedToProjectValue - String
|
The aggregated value of the project the item has been committed to if not committed then null will be returned |
originalValue - String
|
The original value set on the item |
Example
{
"projectValue": "abc123",
"committedToProjectValue": "abc123",
"originalValue": "abc123"
}
AppInfo
Description
General information about Helix Plan API and authentication methods
Fields
| Field Name | Description |
|---|---|
apiVersion - String!
|
The version of the Helix Plan API |
ssoEnabled - Boolean!
|
Indicates if SSO is enabled |
ssoRequired - Boolean!
|
Indicates if SSO is required |
baseURL - String
|
The base URL set on the Admin tab in Helix Plan |
helixCoreCommentType - HelixCoreCommentType!
|
The comment type that has been set for the helix core integration comments |
Example
{
"apiVersion": "abc123",
"ssoEnabled": false,
"ssoRequired": true,
"baseURL": "xyz789",
"helixCoreCommentType": "none"
}
AreaChart
AreaChartData
Fields
| Field Name | Description |
|---|---|
legendIsVisible - Boolean!
|
|
orientation - Orientation!
|
|
grouping - ChartGrouping!
|
|
dataLabels - ChartLabels!
|
|
yMaxValue - String
|
|
yMinValue - String
|
|
dimensions - [String]!
|
|
measures - [String]!
|
|
idealBurndown - IdealBurndown
|
|
forecastingIndex - Int!
|
|
datasets - [LineDataset]!
|
Example
{
"legendIsVisible": false,
"orientation": "horizontal",
"grouping": "none",
"dataLabels": "notVisible",
"yMaxValue": "abc123",
"yMinValue": "xyz789",
"dimensions": ["abc123"],
"measures": ["abc123"],
"idealBurndown": IdealBurndown,
"forecastingIndex": 987,
"datasets": [LineDataset]
}
AssignedUser
AssignedUserInput
Description
An assigned user to a task with the allocated percentage
Example
{"userID": "4", "percentageAllocation": 123}
Attachment
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The id of the attachment |
path - String!
|
The path of the attachment in the Hansoft document system. For retrieving the actual attachment the POST /attachment/:itemID api call can be used with the path as the body |
size - String!
|
The size of attachment in bytes |
version - String!
|
The version of the attachment |
imageWidth - Int!
|
If the attachment is an image and the width of the image is available, this is set to the width, otherwise '-1' |
imageHeight - Int!
|
If the attachment is an image and the height of the image is available, this is set to the height, otherwise '-1' |
coverImage - Boolean!
|
If the attachment is an image and the image is set as a cover image, this is set to true and false otherwise |
addedBy - User!
|
The user that added the attachment |
Example
{
"id": "4",
"path": "abc123",
"size": "abc123",
"version": "abc123",
"imageWidth": 123,
"imageHeight": 123,
"coverImage": false,
"addedBy": User
}
Backlog
BacklogTask
Description
A Helix Plan backlog task
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the backlog task |
projectID - ID!
|
The unique id of the project where the backlog task is listed. Can be a project or backlog. A backlog task can be listed in more than one project. Depending on the project, subprojectPath and indentationLevel can have different values |
localID - ID!
|
An id that is unique for the backlog task within the project where the backlog task was created (backlog project or planning project). |
committedToProjectID - ID
|
The unique id of the planning project that the task was committed to |
name - String
|
The name of the backlog task |
createdBy - User!
|
The user that created the backlog task |
createdOn - ISODateTime!
|
The time that the backlog task was created on |
lastUpdatedBy - User!
|
The user that last updated the backlog task |
lastUpdatedOn - ISODateTime!
|
The time that the backlog task was last updated on |
lastCommentedOn - ISODateTime
|
The time that the backlog task was last commented on |
status - Status!
|
The status set on the backlog task |
workflow - Workflow
|
The workflow set on the backlog task |
workflowStatus - WorkflowStatus
|
The workflow status set on the backlog task |
confidence - Confidence
|
Confidence set on the backlog task |
risk - Risk
|
Risk set on the backlog task |
color - Color
|
The color set on the task |
hyperlink - String
|
The hyperlink set on the task |
assignedTo - [AssignedUser!]
|
The users that the backlog task is assigned to |
subprojectPath - String
|
The subproject path of the backlog task |
points - Int
|
The points set on the backlog task |
customFields - [CustomField]
|
The custom fields of the backlog task |
indentationLevel - Int!
|
The Indentation level for n backlog task in project. A backlog task at the root of the item tree has an indentation level of 0 |
workRemaining - Float
|
The work remaining hours for a backlog task. Setting the number to zero sets the status to completed and can also effect the workflow status, depending on the workflow settings of the workflow set on the backlog task |
committedTo - Sprint
|
The sprint a backlog task is committed to |
customField - CustomField!
|
A custom field for a specified custom field id. The custom field ids are the ids of the custom columns |
Arguments
|
|
itemLink - String!
|
Link to the backlog task in the Helix Plan native client |
releases - [Release]!
|
The releases that the backlog task has been tagged to |
category - Category
|
The category of the backlog task |
sprintPriority - Priority
|
The sprint priority of the task |
backlogPriority - Priority
|
The backlog priority of the task |
estimatedDays - Float
|
The estimated days set on the backlog task. Can be displayed as days or hours depending on the project setting |
links - [Link]!
|
List of links to internal items or external sites |
hidden - Boolean!
|
The hidden status of the backlog task. If true, the backlog task is not shown by default |
boardLane - BoardLane
|
The current board lane of the backlog task if it belongs to a board |
boardColumn - BoardColumn
|
The current board column of the backlog task if it belongs to a board |
boardMembershipInfo - BoardMembershipInfo
|
Info about board membership if the backlog task belongs to a board |
epic - Boolean!
|
The epic status of the backlog task. If true the task is an epic, false otherwise |
isUserStory - Boolean!
|
The user story status of backlog task. If true the task is a user story and can have data in the user story field |
userStory - String
|
The user story of the backlog task. Will only have data if isUserStory is set to true. |
attachments - [Attachment]!
|
The attachments of the backlog task |
wbs - String!
|
The work breakdown structure of the backlog task. The WBS value is only available in the backlog |
watchers - [User]!
|
The users watching the backlog task |
watching - Boolean!
|
The watch status of the authenticated user. True if watching, false otherwise |
linkedToPipelineTask - Item
|
The pipeline task that automatically created this backlog task if it is part of a pipeline |
createdFromWorkflow - Boolean!
|
Indicates if the backlog task was created by a pipeline or workflow |
hasChildren - Boolean!
|
Indicates if the backlog task has children tasks |
aggregatedFieldsSummary - AggregatedFieldsSummary
|
The aggregated summary of the numeric fields of a backlog task with children |
Example
{
"id": 4,
"projectID": "4",
"localID": 4,
"committedToProjectID": 4,
"name": "abc123",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"status": "none",
"workflow": Workflow,
"workflowStatus": WorkflowStatus,
"confidence": "none",
"risk": "none",
"color": "notSet",
"hyperlink": "xyz789",
"assignedTo": [AssignedUser],
"subprojectPath": "xyz789",
"points": 987,
"customFields": [CustomField],
"indentationLevel": 123,
"workRemaining": 987.65,
"committedTo": Sprint,
"customField": CustomField,
"itemLink": "abc123",
"releases": [Release],
"category": "none",
"sprintPriority": "none",
"backlogPriority": "none",
"estimatedDays": 123.45,
"links": [Link],
"hidden": false,
"boardLane": BoardLane,
"boardColumn": BoardColumn,
"boardMembershipInfo": BoardMembershipInfo,
"epic": false,
"isUserStory": true,
"userStory": "xyz789",
"attachments": [Attachment],
"wbs": "xyz789",
"watchers": [User],
"watching": false,
"linkedToPipelineTask": Item,
"createdFromWorkflow": false,
"hasChildren": true,
"aggregatedFieldsSummary": AggregatedFieldsSummary
}
BarChart
BarChartData
Fields
| Field Name | Description |
|---|---|
legendIsVisible - Boolean!
|
|
orientation - Orientation!
|
|
grouping - ChartGrouping!
|
|
dataLabels - ChartLabels!
|
|
yMaxValue - String
|
|
yMinValue - String
|
|
dimensions - [String]!
|
|
measures - [String]!
|
|
datasets - [BarDataset]!
|
|
labels - [String]
|
Example
{
"legendIsVisible": false,
"orientation": "horizontal",
"grouping": "none",
"dataLabels": "notVisible",
"yMaxValue": "abc123",
"yMinValue": "abc123",
"dimensions": ["xyz789"],
"measures": ["xyz789"],
"datasets": [BarDataset],
"labels": ["xyz789"]
}
BarDataset
BoardColumn
BoardLane
BoardMembershipInfo
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
Bug
Description
A Helix Plan bug
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the bug |
projectID - ID!
|
The unique id of the project where the bug is listed. Can be a project or QA id. A bug can be listed in more than one project. Depending on the project, subprojectPath and indentationLevel can have different values |
localID - ID!
|
An id that is unique within the QA project |
committedToProjectID - ID
|
The unique id of the planning project that the task was committed to |
name - String
|
The name of the bug |
createdBy - User!
|
The user that reported the bug |
createdOn - ISODateTime!
|
The time that the bug was created on |
lastUpdatedBy - User!
|
The user that last updated the bug |
lastUpdatedOn - ISODateTime!
|
The time that the bug was last updated on |
lastCommentedOn - ISODateTime
|
The time that the bug was last commented on |
status - Status!
|
The status set on the bug |
workflow - Workflow
|
The workflow set on the bug |
workflowStatus - WorkflowStatus
|
The workflow status set on the bug |
assignedTo - [AssignedUser!]
|
The users that the bug is assigned to |
confidence - Confidence
|
Confidence set on the bug |
risk - Risk
|
Risk set on the bug |
severity - Severity
|
The severity set on the bug |
color - Color
|
The color set on the bug |
hyperlink - String
|
The hyperlink set on the bug |
subprojectPath - String
|
The subproject path of the bug |
customFields - [CustomField]
|
The custom fields of the bug |
indentationLevel - Int!
|
The Indentation level for a bug in project. The list of bugs is flat, so all bugs have an indentation level of 0. |
workRemaining - Float
|
The work remaining hours for a bug. Setting the number to zero sets the status to completed and can also effect the workflow status, depending on the workflow settings of the workflow set on the bug |
committedTo - Sprint
|
The sprint a bug is committed to |
customField - CustomField!
|
A custom field for a specified custom field id. The custom field ids are the ids of the custom columns |
Arguments
|
|
itemLink - String!
|
Link to the bug in the Helix Plan native client |
releases - [Release]!
|
The releases that the bug has been tagged to |
stepsToReproduce - String
|
The steps to reproduce the bug |
detailedDescription - String
|
The detailed description of the bug |
bugPriority - Priority
|
The bug priority of the bug |
sprintPriority - Priority
|
The sprint priority of the bug |
links - [Link]!
|
List of links to internal items or external sites |
hidden - Boolean!
|
The hidden status of the bug. If true, the bug is not shown by default in the planning view if committed |
boardLane - BoardLane
|
The current board lane of the bug if it belongs to a board |
boardColumn - BoardColumn
|
The current board column of the bug if it belongs to a board |
boardMembershipInfo - BoardMembershipInfo
|
Info about board membership if the bug belongs to a board |
attachments - [Attachment]!
|
The attachments of the bug |
watchers - [User]!
|
The users watching the bug |
watching - Boolean!
|
The watch status of the authenticated user. True if watching, false otherwise |
Example
{
"id": "4",
"projectID": "4",
"localID": 4,
"committedToProjectID": "4",
"name": "xyz789",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"status": "none",
"workflow": Workflow,
"workflowStatus": WorkflowStatus,
"assignedTo": [AssignedUser],
"confidence": "none",
"risk": "none",
"severity": "none",
"color": "notSet",
"hyperlink": "xyz789",
"subprojectPath": "xyz789",
"customFields": [CustomField],
"indentationLevel": 123,
"workRemaining": 987.65,
"committedTo": Sprint,
"customField": CustomField,
"itemLink": "abc123",
"releases": [Release],
"stepsToReproduce": "abc123",
"detailedDescription": "xyz789",
"bugPriority": "none",
"sprintPriority": "none",
"links": [Link],
"hidden": true,
"boardLane": BoardLane,
"boardColumn": BoardColumn,
"boardMembershipInfo": BoardMembershipInfo,
"attachments": [Attachment],
"watchers": [User],
"watching": true
}
Category
Description
Task category
Values
| Enum Value | Description |
|---|---|
|
|
No backlog category (unset) |
|
|
A requirement |
|
|
An enhancement |
|
|
A technology upgrade |
|
|
An A Bug |
|
|
A B Bug |
|
|
A C Bug |
|
|
A D Bug |
Example
"none"
Chart
ChartData
Possible Types
| ChartData Types |
|---|
Example
{
"dimensions": ["xyz789"],
"measures": ["abc123"]
}
ChartGrouping
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"none"
ChartLabels
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"notVisible"
CloneProjectInput
Description
The properties of the project to clone
Fields
| Input Field | Description |
|---|---|
sourceProjectID - ID!
|
Source project id for cloning |
name - String!
|
The name of the project |
sortName - String
|
Name used for sorting instead of the project name |
cloneUsers - Boolean
|
If true, users will be cloned with project |
cloneColumns - Boolean
|
If true, columns will be cloned with project |
cloneReports - Boolean
|
If true, reports will be cloned with project |
clonedReportsOwnerID - ID
|
New owner of cloned reports in case users were not cloned |
Example
{
"sourceProjectID": 4,
"name": "xyz789",
"sortName": "xyz789",
"cloneUsers": false,
"cloneColumns": false,
"cloneReports": false,
"clonedReportsOwnerID": "4"
}
Color
Description
Task color
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"notSet"
Column
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the column |
projectID - ID!
|
The unique id of the project of the column |
name - String!
|
The name of the column |
readOnly - Boolean!
|
Read-only state of the column |
Possible Types
| Column Types |
|---|
Example
{
"id": "4",
"projectID": "4",
"name": "xyz789",
"readOnly": true
}
Comment
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the comment |
item - Item!
|
The item that the comment is posted on |
text - String!
|
The text of the comment |
postedBy - User
|
The user who posted the comment, null will be returned if the user no longer exists |
postedAt - ISODateTime!
|
The the timestamp the comment was posted |
mentionedUsers - [User]!
|
The users mentioned in the comment |
Example
{
"id": "4",
"item": Item,
"text": "abc123",
"postedBy": User,
"postedAt": ISODateTime,
"mentionedUsers": [User]
}
CommunicationChannel
Fields
| Field Name | Description |
|---|---|
name - String!
|
The name of the channel. An empty channel name means the channel is owned by the server hosting the channel's database |
ownerSessionID - ID!
|
The session ID of the channel's owner |
databaseID - ID!
|
The globally unique id of the database where the channel was registered |
description - String!
|
A description of the channel, for example the name of the organization or integration owning it |
Example
{
"name": "xyz789",
"ownerSessionID": 4,
"databaseID": 4,
"description": "xyz789"
}
CommunicationChannelPackage
Fields
| Field Name | Description |
|---|---|
name - String!
|
The name of the communication channel the package was sent in |
data - String
|
The Base64 encoded data sent in this package |
toSessionID - ID!
|
The identifier of the session the packet was sent to, or 0 if the packet was sent to the channel's owner session |
fromSessionID - ID!
|
The identifier of the session that sent the packet |
Example
{
"name": "xyz789",
"data": "abc123",
"toSessionID": 4,
"fromSessionID": 4
}
Confidence
Description
Task confidence
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"none"
ConnectedStatus
Fields
| Field Name | Description |
|---|---|
connectedTo - WorkflowStatus!
|
The workflow status that is connected |
usersCanEditAllFields - Boolean!
|
True if users can edit all fields that must be set before transitioning to the next state, false otherwise |
requiredFields - [FieldID]!
|
The required fields that must be set before transitioning to the next state |
Example
{
"connectedTo": WorkflowStatus,
"usersCanEditAllFields": false,
"requiredFields": [FieldID]
}
CreateBacklogTaskInput
Description
The properties of the backlog task to create
Fields
| Input Field | Description |
|---|---|
name - String!
|
The name of the Task |
status - Status
|
The status to set on the task |
points - Int
|
The points to set on the task |
confidence - Confidence
|
The confidence to set on the task |
risk - Risk
|
The risk to set on the task |
color - Color
|
The color to set on the task |
hyperlink - String
|
The hyperlink to set on the task |
indentationLevel - PositiveInt
|
The tree indentation level of the item to create. A level of 0 sets the level to same as the previous item, a level of 1 sets it as a child of the previous item. The indentation level is always 0 or greater. |
workflowID - ID
|
The workflow id of the workflow to set on the task |
workflowStatusID - ID
|
The workflow status id of the workflow status to set on the task |
workRemaining - Float
|
The work remaining to set on the task. The backlog task must be committed to a sprint |
assignedTo - [AssignedUserInput]
|
The assigned users to set on the backlog task |
sprintID - ID
|
The id of the sprint to commit the backlog task to |
releaseIDs - [ID!]
|
The ids of the releases to tag the backlog task to, 'NoRelease' can be used for ID if the task should not inherit the parent's releases, and '-1' should be used to inherit the parent's releases |
category - Category
|
The category of the backlog task |
backlogPriority - Priority
|
The backlog priority of the task |
sprintPriority - Priority
|
The sprint priority of the task. Can only be set if the backlog task is committed to a sprint |
estimatedDays - Float
|
The estimated days set on the backlog task. Can be displayed as days or hours depending on the project setting. Cannot be set to negative |
hidden - Boolean
|
The hidden status of the backlog task |
epic - Boolean
|
The epic status of the backlog task |
isUserStory - Boolean
|
The user story status of backlog task. If true the task is a user story and can have data in the user story field |
userStory - String
|
The user story of the backlog task. Will be set if isUserStory is set to true. |
watchers - UsersOrGroupsInput
|
The users or groups watching the backlog task |
Example
{
"name": "abc123",
"status": "none",
"points": 123,
"confidence": "none",
"risk": "none",
"color": "notSet",
"hyperlink": "abc123",
"indentationLevel": 123,
"workflowID": 4,
"workflowStatusID": "4",
"workRemaining": 987.65,
"assignedTo": [AssignedUserInput],
"sprintID": 4,
"releaseIDs": [4],
"category": "none",
"backlogPriority": "none",
"sprintPriority": "none",
"estimatedDays": 123.45,
"hidden": false,
"epic": true,
"isUserStory": true,
"userStory": "xyz789",
"watchers": UsersOrGroupsInput
}
CreateBugInput
Description
The properties of the bug to create
Fields
| Input Field | Description |
|---|---|
name - String!
|
The name of the bug |
status - Status
|
The status to set on the bug |
confidence - Confidence
|
The confidence to set on the bug |
risk - Risk
|
The risk to set on the bug |
color - Color
|
The color to set on the bug |
severity - Severity
|
The severity to set on the bug |
hyperlink - String
|
The hyperlink to set on the task |
workflowID - ID
|
The workflow id of the workflow to set on the bug |
workflowStatusID - ID
|
The workflow status id of the workflow status to set on the bug |
workRemaining - Float
|
The work remaining to set on the bug |
assignedTo - [AssignedUserInput]
|
The assigned users to set on the bug |
sprintID - ID
|
The id of the sprint to commit the bug to |
releaseIDs - [ID!]
|
The ids of the releases to tag the bug to, 'NoRelease' can be used for ID if the bug should not inherit the parent's releases and '-1' should be used to inherit the parent's releases |
stepsToReproduce - String
|
The steps to reproduce the bug |
detailedDescription - String
|
The detailed description of the bug |
bugPriority - Priority
|
The bug priority of the bug |
sprintPriority - Priority
|
The sprint priority of the bug. Can only be set if the bug is committed to a sprint |
hidden - Boolean
|
The hidden status of the bug |
watchers - UsersOrGroupsInput
|
The users or groups watching the bug |
Example
{
"name": "abc123",
"status": "none",
"confidence": "none",
"risk": "none",
"color": "notSet",
"severity": "none",
"hyperlink": "abc123",
"workflowID": "4",
"workflowStatusID": 4,
"workRemaining": 987.65,
"assignedTo": [AssignedUserInput],
"sprintID": "4",
"releaseIDs": ["4"],
"stepsToReproduce": "xyz789",
"detailedDescription": "xyz789",
"bugPriority": "none",
"sprintPriority": "none",
"hidden": false,
"watchers": UsersOrGroupsInput
}
CreateCustomColumnInput
Description
The properties of the custom column to create
Example
{
"name": "abc123",
"readOnly": true,
"activated": false
}
CreateDateCustomColumnInput
Description
The properties of the date custom column to create
Fields
| Input Field | Description |
|---|---|
name - String!
|
The name of the column |
readOnly - Boolean!
|
Read-only state of the column |
activated - Boolean!
|
Set to true if the custom column is activated in the project, false otherwise |
updateOnNotDone - Boolean
|
Update date when the not done status is set on a task |
updateOnInProgress - Boolean
|
Update date when the in progress status is set on a task |
updateOnBlocked - Boolean
|
Update date when blocked status is set on a task |
updateOnToBeDeleted - Boolean
|
Update date when the to be deleted status is set on a task |
updateOnCompleted - Boolean
|
Update date when task status is set to completed |
updateOnCommitted - Boolean
|
Update date when a task is committed to the planning project |
updateOnNew - Boolean
|
Update date when a task is created |
updateOnlyFirstTime - Boolean
|
If set the current date will be set the first time any of the updateOn conditions are met, otherwise every time a condition is met |
Example
{
"name": "xyz789",
"readOnly": true,
"activated": true,
"updateOnNotDone": false,
"updateOnInProgress": true,
"updateOnBlocked": false,
"updateOnToBeDeleted": true,
"updateOnCompleted": false,
"updateOnCommitted": true,
"updateOnNew": true,
"updateOnlyFirstTime": false
}
CreateDropListCustomColumnInput
Description
The properties of the drop list custom column to create
Fields
| Input Field | Description |
|---|---|
name - String!
|
The name of the column |
readOnly - Boolean!
|
Read-only state of the column |
activated - Boolean!
|
Set to true if the custom column is activated in the project, false otherwise |
dropListItems - [DropListItemInput]
|
Example
{
"name": "abc123",
"readOnly": true,
"activated": false,
"dropListItems": [DropListItemInput]
}
CreateGhostUserInput
CreateNormalUserInput
Description
The properties of the normal user to create
Fields
| Input Field | Description |
|---|---|
name - String!
|
The name of the user |
password - String!
|
Password of the user |
sortName - String
|
Name used for sorting instead of the user name |
emailAddress - String
|
The email address of the user |
passwordConfigurations - PasswordConfigurationsInput
|
the password configurations of the user |
accessRights - NormalUserAccessRightsInput
|
the access rights of the user |
Example
{
"name": "abc123",
"password": "abc123",
"sortName": "xyz789",
"emailAddress": "abc123",
"passwordConfigurations": PasswordConfigurationsInput,
"accessRights": NormalUserAccessRightsInput
}
CreateNumberCustomColumnInput
Description
The properties of the number custom column to create
Example
{
"name": "abc123",
"readOnly": true,
"activated": true,
"unitName": "xyz789"
}
CreateProjectInput
Description
The properties of the project to create
Fields
| Input Field | Description |
|---|---|
name - String!
|
The name of the project |
sortName - String
|
Name used for sorting instead of the project name |
archivedStatus - Boolean
|
Archived status. Set to true to indicate that the project is archived. An archived project is kept in the database but is not synchronized to users connecting to the database saving network bandwidth and memory on the client |
schedulingMethod - SchedulingMethod
|
The scheduling method used. The default method is fixedDuration |
taskCompletionMethod - TaskCompletionMethod
|
The task completion method used. The default method is status |
defaultMode - DefaultMode
|
The default project mode for new users. The default mode is agile |
methodTemplate - MethodTemplate
|
The method template for the project. The default template is scrum |
timesheetLock - TimesheetLockInput
|
The timesheet lock settings for the project |
Example
{
"name": "xyz789",
"sortName": "abc123",
"archivedStatus": false,
"schedulingMethod": "fixedDuration",
"taskCompletionMethod": "auto",
"defaultMode": "taskScheduling",
"methodTemplate": "scrum",
"timesheetLock": TimesheetLockInput
}
CreateQaUserInput
Description
The properties of the QA user to create
Fields
| Input Field | Description |
|---|---|
name - String!
|
The name of the user |
password - String!
|
Password of the user |
sortName - String
|
Name used for sorting instead of the user name |
emailAddress - String
|
The email address of the user |
passwordConfigurations - PasswordConfigurationsInput
|
the password configurations of the user |
accessRights - QaUserAccessRightsInput
|
the access rights of the user |
Example
{
"name": "abc123",
"password": "abc123",
"sortName": "xyz789",
"emailAddress": "xyz789",
"passwordConfigurations": PasswordConfigurationsInput,
"accessRights": QaUserAccessRightsInput
}
CreateSdkUserInput
Description
The properties of the SDK user to create
Fields
| Input Field | Description |
|---|---|
name - String!
|
The name of the user |
password - String
|
Password of the user |
sortName - String
|
Name used for sorting instead of the user name |
passwordConfigurations - PasswordConfigurationsInput
|
the password configurations of the user |
syncMethod - SdkSyncMethod!
|
This decides how the SDK session connecting with this user sync projects |
isActiveAccount - Boolean
|
The SDK account is active. When the account is active the SDK can log on to the server, when inactive the SDK can not log in. |
Example
{
"name": "abc123",
"password": "xyz789",
"sortName": "abc123",
"passwordConfigurations": PasswordConfigurationsInput,
"syncMethod": "allMembersProjects",
"isActiveAccount": false
}
CreateTimeSpentCustomColumnInput
Description
The properties of the time spent custom column to create
Fields
| Input Field | Description |
|---|---|
name - String!
|
The name of the column |
readOnly - Boolean!
|
Read-only state of the column |
activated - Boolean!
|
Set to true if the custom column is activated in the project, false otherwise |
useForTimeReporting - Boolean
|
Use this column for time reporting and show it in the to do list |
updateWorkRemaining - Boolean
|
Update work remaining automatically when this column is updated |
Example
{
"name": "abc123",
"readOnly": true,
"activated": false,
"useForTimeReporting": true,
"updateWorkRemaining": false
}
CreateUserGroupInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
The name of the user group |
projectID - ID
|
The unique id of the project that if set makes this group a project specific user group |
sortName - String
|
Name used for sorting instead of the group name |
userIDs - [ID!]
|
The IDs of the users to be added as user group members |
Example
{
"name": "abc123",
"projectID": 4,
"sortName": "xyz789",
"userIDs": [4]
}
CustomColumn
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the column |
projectID - ID!
|
The unique id of the project of the custom column |
name - String!
|
The name of the column |
readOnly - Boolean!
|
Read-only state of the column |
activated - Boolean!
|
Set to true if the custom column is activated in the project, false otherwise |
Possible Types
| CustomColumn Types |
|---|
Example
{
"id": "4",
"projectID": 4,
"name": "xyz789",
"readOnly": false,
"activated": false
}
CustomField
CustomFieldID
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the custom field |
Example
{"id": "4"}
CustomFieldUpdated
CustomSettingsValue
DashboardLayout
Fields
| Field Name | Description |
|---|---|
style - LayoutStyle!
|
The layout of the dashboard page |
columns - [LayoutColumn]!
|
The columns in used for the set style on the dashboard page |
Example
{"style": "oneColumn", "columns": [LayoutColumn]}
DashboardPage
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the dashboard page |
name - String!
|
The name of the dashboard page |
charts - [Chart]!
|
The charts on the dashboard page |
layout - DashboardLayout!
|
The layout used for the dashboard page |
theme - ID!
|
The theme used for the dashboard page |
createdBy - User!
|
The user who created the dashboard page |
Example
{
"id": "4",
"name": "abc123",
"charts": [Chart],
"layout": DashboardLayout,
"theme": "4",
"createdBy": User
}
DatabaseSetting
Description
Global settings for the database
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique ID of the database |
Example
{"id": 4}
DateCustomColumn
Description
A date custom column
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the custom column |
projectID - ID!
|
The unique id of the project of the custom column |
name - String!
|
The name of the column |
readOnly - Boolean!
|
Read-only state of the column |
activated - Boolean!
|
Set to true if the custom column is activated in the project, false otherwise |
Example
{
"id": 4,
"projectID": 4,
"name": "abc123",
"readOnly": true,
"activated": true
}
DateCustomField
Description
A date custom field
Example
{
"id": "4",
"taskID": 4,
"dateValue": ISODate
}
DateTimeCustomColumn
Description
A date and time custom column
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the custom column |
projectID - ID!
|
The unique id of the project of the custom column |
name - String!
|
The name of the column |
readOnly - Boolean!
|
Read-only state of the column |
activated - Boolean!
|
Set to true if the custom column is activated in the project, false otherwise |
Example
{
"id": 4,
"projectID": "4",
"name": "xyz789",
"readOnly": true,
"activated": false
}
DateTimeCustomField
Description
A date and time custom field
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the custom field. The id is an id of a DateTimeCustomColumn |
taskID - ID!
|
The unique id of the task that the field is set on |
dateTimeValue - ISODateTime
|
The ISO date time value (YYYY-MM-DDTHH:MM:SS) set on the custom field |
Example
{
"id": 4,
"taskID": "4",
"dateTimeValue": ISODateTime
}
DecimalNumberCustomColumn
Description
A decimal number custom column
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the custom column |
projectID - ID!
|
The unique id of the project of the custom column |
name - String!
|
The name of the column |
unitName - String
|
Unit name |
readOnly - Boolean!
|
Read-only state of the column |
activated - Boolean!
|
Set to true if the custom column is activated in the project, false otherwise |
Example
{
"id": "4",
"projectID": "4",
"name": "abc123",
"unitName": "abc123",
"readOnly": false,
"activated": false
}
DecimalNumberCustomField
Description
A decimal number custom field
Example
{
"id": "4",
"taskID": "4",
"floatValue": 987.65
}
DefaultColumn
Example
{
"id": "4",
"projectID": "4",
"name": "abc123",
"readOnly": false
}
DefaultField
Description
The Default Field that changed
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"notApplicable"
DefaultFieldID
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the default field |
Example
{"id": "4"}
DefaultFieldUpdated
Fields
| Field Name | Description |
|---|---|
itemID - ID!
|
|
name - DefaultField!
|
Example
{"itemID": "4", "name": "notApplicable"}
DefaultMode
Description
Default project mode for new users
Values
| Enum Value | Description |
|---|---|
|
|
Task scheduling mode |
|
|
Agile mode |
Example
"taskScheduling"
DeleteCommentInput
DeleteDocumentInput
Fields
| Input Field | Description |
|---|---|
path - String!
|
Example
{"path": "xyz789"}
DeleteDocumentsInput
Fields
| Input Field | Description |
|---|---|
comment - String
|
|
permanentDelete - Boolean!
|
Set to true to permanently delete the documents on the Helix Plan server. When documents are deleted permanently you are not able to revert them later |
deleteLocally - Boolean!
|
Set to true to delete the documents on the local file system |
documents - [DeleteDocumentInput]!
|
The files to delete |
Example
{
"comment": "xyz789",
"permanentDelete": true,
"deleteLocally": false,
"documents": [DeleteDocumentInput]
}
DeleteExternalLinkInput
DeleteInternalLinkInput
Document
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique identifier of the document |
name - String!
|
The name of the document. Not the full path |
directory - Boolean!
|
Set to true if document is a directory |
size - String!
|
The size of the file. If the file is a directory this is the size of all files contained in the directory and its subdirectories |
date - ISODateTime!
|
The date the file was last changed |
checksum - String!
|
The MD5 checksum of the data in the file |
Example
{
"id": 4,
"name": "xyz789",
"directory": false,
"size": "abc123",
"date": ISODateTime,
"checksum": "abc123"
}
DropListItem
DropListItemInput
Description
The properties of the drop list item to create
Fields
| Input Field | Description |
|---|---|
name - String!
|
The name of the drop list item |
icon - UserIcon!
|
The icon of the drop list item |
autoAssignToUsers - [ID]
|
The users that will be auto assigned if this item is selected. |
autoAssignToUserGroups - [ID]
|
The user groups that will be auto assigned if this item is selected |
Example
{
"name": "abc123",
"icon": "default",
"autoAssignToUsers": [4],
"autoAssignToUserGroups": ["4"]
}
ExternalLink
Description
A link to an external item
Example
{
"fromItem": Item,
"relation": "relatedTo",
"url": "xyz789",
"notes": "abc123"
}
FieldID
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the field |
Possible Types
| FieldID Types |
|---|
Example
{"id": 4}
FieldUpdated
Fields
| Field Name | Description |
|---|---|
itemID - ID!
|
Possible Types
| FieldUpdated Types |
|---|
Example
{"itemID": 4}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
FunctionCustomColumn
Description
A custom column for function calculated values
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the custom column |
projectID - ID!
|
The unique id of the project of the custom column |
name - String!
|
The name of the column |
readOnly - Boolean!
|
Read-only state of the column |
activated - Boolean!
|
Set to true if the custom column is activated in the project, false otherwise |
Example
{
"id": "4",
"projectID": 4,
"name": "xyz789",
"readOnly": true,
"activated": false
}
FunctionCustomField
Description
A custom field for function calculated values
Example
{"id": 4, "taskID": 4, "value": "xyz789"}
Gauge
GaugeChartData
Fields
| Field Name | Description |
|---|---|
legendIsVisible - Boolean!
|
|
orientation - Orientation!
|
|
grouping - ChartGrouping!
|
|
dataLabels - ChartLabels!
|
|
dimensions - [String]!
|
|
measures - [String]!
|
|
lowerBound - Float!
|
|
upperBound - Float!
|
|
measure - String!
|
|
value - String!
|
Example
{
"legendIsVisible": false,
"orientation": "horizontal",
"grouping": "none",
"dataLabels": "notVisible",
"dimensions": ["abc123"],
"measures": ["xyz789"],
"lowerBound": 987.65,
"upperBound": 123.45,
"measure": "xyz789",
"value": "xyz789"
}
GhostUser
Description
A Helix Plan Ghost User. Ghost users are not full members of the project and you cannot log in to this account.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the user |
name - String!
|
The name of the user |
sortName - String!
|
Name used for sorting instead of the user name. If not set the name of the user is returned |
isDeleted - Boolean!
|
Flag that indicates if a user is deleted but still present in the database |
isLocked - Boolean!
|
Flag that indicates if a user is locked and cannot log in because they were shared from another Helix Plan server and the share was removed or disconnected |
userLink - String!
|
Link to the ghost user in the Helix Plan native client |
Example
{
"id": "4",
"name": "abc123",
"sortName": "xyz789",
"isDeleted": false,
"isLocked": true,
"userLink": "xyz789"
}
HelixCoreCommentType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"none"
HyperlinkCustomColumn
Description
A URL hyperlink custom column
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the custom column |
projectID - ID!
|
The unique id of the project of the custom column |
name - String!
|
The name of the column |
readOnly - Boolean!
|
Read-only state of the column |
activated - Boolean!
|
Set to true if the custom column is activated in the project, false otherwise |
Example
{
"id": "4",
"projectID": "4",
"name": "xyz789",
"readOnly": true,
"activated": false
}
HyperlinkCustomField
Description
A URL hyperlink custom field
Example
{
"id": "4",
"taskID": "4",
"value": "abc123"
}
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
ISODate
Description
Date in the ISO 8601 format YYYY-MM-DD
Example
ISODate
ISODateTime
Description
Date and time in the ISO 8601 format YYYY-MM-DDTHH:MM:SS
Example
ISODateTime
IdealBurndown
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
InternalLink
Description
A link to an item in the same Hansoft database
Example
{
"fromItem": Item,
"relation": "relatedTo",
"toItem": Item,
"notes": "abc123"
}
Item
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the item |
projectID - ID!
|
The unique id of the project where the item is listed. Depending on the project, indentationLevel can have different values |
localID - ID!
|
An id that is unique for the item within the project where the item was created (backlog project, planning project or QA project). |
name - String
|
The name of the item |
createdBy - User!
|
The user that created the item |
createdOn - ISODateTime!
|
The time that the item was created on |
lastUpdatedBy - User!
|
The user that last updated the item |
lastUpdatedOn - ISODateTime!
|
The time that the item was last updated on |
lastCommentedOn - ISODateTime
|
The time that the item was last commented on |
color - Color
|
The color set on the item |
hyperlink - String
|
The hyperlink set on the item |
indentationLevel - Int!
|
The Indentation level for an item in project. An item at the root of the item tree has an indentation level of 0. |
itemLink - String!
|
Link to the item in the Helix Plan native client |
links - [Link]!
|
List of links to internal items or external sites |
hidden - Boolean!
|
The hidden status of the item. If true, the item is not shown by default |
watchers - [User]!
|
The users watching the item |
watching - Boolean!
|
The watch status of the authenticated user. True if watching, false otherwise |
customFields - [CustomField]
|
The custom fields of the item |
attachments - [Attachment]!
|
The attachments of the item |
subprojectPath - String
|
The subproject path of the item |
Possible Types
| Item Types |
|---|
Example
{
"id": "4",
"projectID": "4",
"localID": 4,
"name": "xyz789",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "xyz789",
"indentationLevel": 987,
"itemLink": "abc123",
"links": [Link],
"hidden": true,
"watchers": [User],
"watching": true,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "abc123"
}
ItemDetail
Description
Detailed information about an item in the database
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the item |
name - String!
|
The name of the item |
description - String!
|
The detailed description of the item |
status - String!
|
The status of the item |
workflowStatus - String!
|
The workflow status of the item |
users - [String!]
|
The list of users assigned to the item |
Example
{
"id": 4,
"name": "abc123",
"description": "abc123",
"status": "abc123",
"workflowStatus": "xyz789",
"users": ["abc123"]
}
ItemInTodoListWorkflowStatusHidden
ItemView
ItemViewChartData
LayoutColumn
Fields
| Field Name | Description |
|---|---|
charts - [Chart]!
|
The charts in the column |
Example
{"charts": [Chart]}
LayoutStyle
Values
| Enum Value | Description |
|---|---|
|
|
One column (100) |
|
|
Two columns (50 50) |
|
|
Three columns (33 33 33) |
|
|
Four columns (25 25 25) |
|
|
Highway (20 30 30 20) |
|
|
Center lane (30 40 30) |
|
|
Sidewalk (40 60) |
Example
"oneColumn"
LineChart
LineChartData
Fields
| Field Name | Description |
|---|---|
legendIsVisible - Boolean!
|
|
orientation - Orientation!
|
|
grouping - ChartGrouping!
|
|
dataLabels - ChartLabels!
|
|
yMaxValue - String
|
|
yMinValue - String
|
|
dimensions - [String]!
|
|
measures - [String]!
|
|
idealBurndown - IdealBurndown
|
|
forecastingIndex - Int!
|
|
datasets - [LineDataset]!
|
Example
{
"legendIsVisible": false,
"orientation": "horizontal",
"grouping": "none",
"dataLabels": "notVisible",
"yMaxValue": "xyz789",
"yMinValue": "xyz789",
"dimensions": ["xyz789"],
"measures": ["abc123"],
"idealBurndown": IdealBurndown,
"forecastingIndex": 987,
"datasets": [LineDataset]
}
LineDataset
Example
{
"label": "abc123",
"labelColor": "abc123",
"borderColor": "abc123",
"measureIndex": 987,
"backgroundColor": "abc123",
"data": [LinePoint]
}
LinePoint
Link
ListChartData
Possible Types
| ListChartData Types |
|---|
Example
{
"columns": ["abc123"],
"rows": ["abc123"]
}
LoginUserInput
MethodTemplate
Description
Method template. Customizable method naming of project properties
Values
| Enum Value | Description |
|---|---|
|
|
SCRUM template |
|
|
Extreme programing template |
|
|
Lean template |
|
|
Custom template 1 |
|
|
Custom template 2 |
|
|
Custom template 3 |
|
|
Custom template 4 |
|
|
Custom template 5 |
Example
"scrum"
MultilineTextCustomColumn
Description
A multiline text custom column
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the custom column |
projectID - ID!
|
The unique id of the project of the custom column |
name - String!
|
The name of the column |
readOnly - Boolean!
|
Read-only state of the column |
activated - Boolean!
|
Set to true if the custom column is activated in the project, false otherwise |
Example
{
"id": 4,
"projectID": "4",
"name": "xyz789",
"readOnly": false,
"activated": false
}
MultilineTextCustomField
Description
A multiline text custom field
Example
{"id": 4, "taskID": 4, "value": "abc123"}
MultipleSelectionDropListCustomColumn
Description
A drop list custom column with multiple selection
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the custom column |
projectID - ID!
|
The unique id of the project of the custom column |
name - String!
|
The name of the column |
readOnly - Boolean!
|
Read-only state of the column |
activated - Boolean!
|
Set to true if the custom column is activated in the project, false otherwise |
items - [DropListItem]!
|
The drop list items that can be set on a task in the column |
Example
{
"id": 4,
"projectID": "4",
"name": "xyz789",
"readOnly": false,
"activated": false,
"items": [DropListItem]
}
MultipleSelectionDropListCustomField
Description
A drop list custom field with multiple selection
Example
{
"id": 4,
"taskID": "4",
"multipleSelectionDropListValue": [4]
}
NormalUser
Description
A Helix Plan Normal User.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the user |
name - String!
|
The name of the user |
sortName - String!
|
Name used for sorting instead of the user name. If not set the name of the user is returned |
emailAddress - String
|
The email address of a user |
accessRights - UserAccessRights!
|
Helix Plan Features accessible to the user |
passwordConfigurations - PasswordConfigurations!
|
User's password configurations |
isDeleted - Boolean!
|
Flag that indicates if a user is deleted but still present in the database |
isLocked - Boolean!
|
Flag that indicates if a user is locked and cannot log in because they were shared from another Helix plan server and the share was removed or disconnected |
userLink - String!
|
Link to the normal user in the Helix Plan native client |
hasAvatar - Boolean!
|
Has the user uploaded an avatar. For retrieving the actual avatar the POST /avatar api call can be used with the user id as the body |
Example
{
"id": 4,
"name": "xyz789",
"sortName": "abc123",
"emailAddress": "xyz789",
"accessRights": UserAccessRights,
"passwordConfigurations": PasswordConfigurations,
"isDeleted": true,
"isLocked": true,
"userLink": "abc123",
"hasAvatar": false
}
NormalUserAccessRightsInput
Description
The access rights of the normal user to create
Fields
| Input Field | Description |
|---|---|
isActiveAccount - Boolean
|
The user account is active. When the account is active the user can log on to the server, when inactive the user can not log in. Default is false |
admin - Boolean
|
The user has administrative access and is able to manage users and projects in the database. Default is false |
portfolioAllocation - Boolean
|
The user has access to portfolio allocation pane in client. Default is false |
documentManagement - Boolean
|
The user has access to document management pane in client. Default is false |
avatarManagement - Boolean
|
The user is able to manage user avatars. Default is false |
chat - Boolean
|
The user has access to chat. Default is false |
dashboards - Boolean
|
The user has access to dashboards. Default is false |
dashboardPageShare - Boolean
|
The user can share dashboard pages to other users. Default is false |
Example
{
"isActiveAccount": false,
"admin": false,
"portfolioAllocation": true,
"documentManagement": true,
"avatarManagement": false,
"chat": false,
"dashboards": true,
"dashboardPageShare": false
}
NumberCustomColumn
Description
An number custom column
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the custom column |
projectID - ID!
|
The unique id of the project of the custom column |
name - String!
|
The name of the column |
unitName - String
|
Unit name |
readOnly - Boolean!
|
Read-only state of the column |
activated - Boolean!
|
Set to true if the custom column is activated in the project, false otherwise |
Example
{
"id": "4",
"projectID": 4,
"name": "xyz789",
"unitName": "xyz789",
"readOnly": false,
"activated": false
}
NumberCustomField
Description
An number custom field
Example
{"id": 4, "taskID": "4", "intValue": 123}
Orientation
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"horizontal"
PasswordConfigurations
Fields
| Field Name | Description |
|---|---|
mustChangePasswordNextLogon - Boolean!
|
The user must change the password next login. |
passwordNeverExpires - Boolean!
|
The user's password never expires. |
cannotChangePassword - Boolean!
|
The user cannot change its password. |
passwordDisabled - Boolean!
|
The user cannot log in using the built-in Helix Plan authentication protocol. |
Example
{
"mustChangePasswordNextLogon": false,
"passwordNeverExpires": false,
"cannotChangePassword": true,
"passwordDisabled": false
}
PasswordConfigurationsInput
Description
The password configurations of the user to create
Fields
| Input Field | Description |
|---|---|
mustChangePasswordNextLogon - Boolean
|
The user must change the password next login. Default is true |
passwordNeverExpires - Boolean
|
The user's password never expires. Default is false |
cannotChangePassword - Boolean
|
The user cannot change its password. Default is false |
passwordDisabled - Boolean
|
The user cannot log in using the built-in Hansoft authentication protocol. Default is false |
Example
{
"mustChangePasswordNextLogon": false,
"passwordNeverExpires": false,
"cannotChangePassword": true,
"passwordDisabled": false
}
PieChart
PieChartData
Fields
| Field Name | Description |
|---|---|
legendIsVisible - Boolean!
|
|
orientation - Orientation!
|
|
grouping - ChartGrouping!
|
|
dataLabels - ChartLabels!
|
|
dimensions - [String]!
|
|
measures - [String]!
|
|
datasets - [PieDataset]!
|
Example
{
"legendIsVisible": false,
"orientation": "horizontal",
"grouping": "none",
"dataLabels": "notVisible",
"dimensions": ["abc123"],
"measures": ["abc123"],
"datasets": [PieDataset]
}
PieDataset
Example
{
"labels": ["abc123"],
"data": [123],
"firstDimensionLookup": [123],
"previousDimensionLookup": ["xyz789"],
"backgroundColors": ["abc123"],
"labelColors": ["abc123"]
}
PipelineWorkflow
Description
A pipeline workflow where several steps in the workflow can be active at once.
Example
{
"id": 4,
"projectID": 4,
"name": "abc123",
"icon": "default"
}
PositiveInt
Description
Integer with positive values
Example
123
PostCommentInput
Priority
Description
Priority
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"none"
Project
Description
A Helix Plan project is the top-level container for structuring work and plans for your team.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the project |
name - String!
|
The name of the project |
niceName - String!
|
The nice name of the project. A name that is safe to use in the file system. Converted from name internally and can not be set |
sortName - String!
|
Name used for sorting instead of the project name. If not set the name of the project is returned |
archivedStatus - Boolean!
|
Archived status. Set to true to indicate that the project is archived. An archived project is kept in the database but is not synchronized to users connecting to the database saving network bandwidth and memory on the client |
schedulingMethod - SchedulingMethod!
|
The scheduling method used |
taskCompletionMethod - TaskCompletionMethod!
|
The task completeion method used |
defaultMode - DefaultMode!
|
The default project mode for new users |
methodTemplate - MethodTemplate!
|
The method template for the project |
backlog - Backlog!
|
The backlog section of the project |
qa - Qa!
|
The QA section of the project |
users - [ProjectUser]!
|
The users that are members of the project. All ghost users are always members of all projects |
userGroups - [UserGroup]!
|
The user groups added to the project |
timesheetLock - TimesheetLock!
|
The timesheet lock settings for the project |
items - [Item]!
|
The items in the main project |
workflows - [Workflow]!
|
The workflows in the main project |
settings - ProjectSettings!
|
The settings for the project |
Example
{
"id": "4",
"name": "abc123",
"niceName": "abc123",
"sortName": "xyz789",
"archivedStatus": false,
"schedulingMethod": "fixedDuration",
"taskCompletionMethod": "auto",
"defaultMode": "taskScheduling",
"methodTemplate": "scrum",
"backlog": Backlog,
"qa": Qa,
"users": [ProjectUser],
"userGroups": [UserGroup],
"timesheetLock": TimesheetLock,
"items": [Item],
"workflows": [Workflow],
"settings": ProjectSettings
}
ProjectSettings
Description
Settings for a project
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the project for the settings |
timeSpentCustomColumn - TimeSpentCustomColumn
|
The time spent custom column used for reporting time spent in user's to do lists. Set to null if not used |
priorityCustomColumn - SingleSelectionDropListCustomColumn
|
The custom column used for priority. Set to null if not used |
commentsAllowed - Boolean!
|
If true all project members can comment on all items |
Example
{
"id": 4,
"timeSpentCustomColumn": TimeSpentCustomColumn,
"priorityCustomColumn": SingleSelectionDropListCustomColumn,
"commentsAllowed": false
}
ProjectUser
Description
The settings for a user in a Helix Plan project.
Fields
| Field Name | Description |
|---|---|
user - User!
|
The user that is a member of the project |
accessRights - ProjectUserAccessRights!
|
The access rights for the user in the project |
Example
{
"user": User,
"accessRights": ProjectUserAccessRights
}
ProjectUserAccessRights
Example
{
"isMainManager": false,
"limitedVisibility": true,
"canAccessProjectHistory": false
}
ProjectUserAccessRightsInput
Fields
| Input Field | Description |
|---|---|
isMainManager - Boolean
|
Is the user main manager for the project. Can not be true if limitedVisibility is true. Default is false |
limitedVisibility - Boolean
|
The project user has limited visibility in this project. Can not be true if isMainManager is true. Default is false |
canAccessProjectHistory - Boolean
|
The user can access the project history for the project. Default is false |
Example
{
"isMainManager": true,
"limitedVisibility": false,
"canAccessProjectHistory": true
}
Qa
QaUser
Description
A Helix Plan QA User. This user can only be used to report and manage bugs. No To do list view or project management is available for this user.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the user |
name - String!
|
The name of the user |
sortName - String!
|
Name used for sorting instead of the user name. If not set the name of the user is returned |
emailAddress - String
|
The email address of a user |
accessRights - QaUserAccessRights!
|
Hansoft Features accessible to the user
|
passwordConfigurations - PasswordConfigurations!
|
User's password configurations |
isDeleted - Boolean!
|
Flag that indicates if a user is deleted but still present in the database |
isLocked - Boolean!
|
Flag that indicates if a user is locked and cannot log in because they were shared from another Helix Plan server and the share was removed or disconnected |
userLink - String!
|
Link to the qa user in the Helix Plan native client |
hasAvatar - Boolean!
|
Has the user uploaded an avatar. For retrieving the actual avatar the POST /avatar api call can be used with the user id as the body |
Example
{
"id": 4,
"name": "xyz789",
"sortName": "xyz789",
"emailAddress": "abc123",
"accessRights": QaUserAccessRights,
"passwordConfigurations": PasswordConfigurations,
"isDeleted": true,
"isLocked": true,
"userLink": "abc123",
"hasAvatar": true
}
QaUserAccessRights
Fields
| Field Name | Description |
|---|---|
isActiveAccount - Boolean!
|
The user account is active. When the account is active the user can log on to the server, when inactive the user can not log in. |
documentManagement - Boolean!
|
The user has access to document management pane in client. |
avatarManagement - Boolean!
|
The user is able to manage user avatars |
chat - Boolean!
|
The user has access to chat |
Example
{
"isActiveAccount": true,
"documentManagement": true,
"avatarManagement": false,
"chat": true
}
QaUserAccessRightsInput
Description
The access rights of the qa user to create
Fields
| Input Field | Description |
|---|---|
isActiveAccount - Boolean
|
The user account is active. When the account is active the user can log on to the server, when inactive the user can not log in. Default is false |
documentManagement - Boolean
|
The user has access to document management pane in client. Default is false |
avatarManagement - Boolean
|
The user is able to manage user avatars. Default is false |
chat - Boolean
|
The user has access to chat. Default is false |
Example
{
"isActiveAccount": false,
"documentManagement": true,
"avatarManagement": true,
"chat": true
}
Relation
Description
Link relation
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"relatedTo"
Release
Description
A Helix Plan release
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the release |
projectID - ID!
|
The unique id of the project where the release is listed |
localID - ID!
|
An id that is unique within the planning project |
name - String
|
The name of the release |
createdBy - User!
|
The user that created the release |
createdOn - ISODateTime!
|
The time that the release was created on |
lastUpdatedBy - User!
|
The user that last updated the release |
lastUpdatedOn - ISODateTime!
|
The time that the release was last updated on |
lastCommentedOn - ISODateTime
|
The time that the release was last commented on |
color - Color
|
The color set on the release |
hyperlink - String
|
The hyperlink set on the release |
indentationLevel - Int!
|
The Indentation level for a release in project. A release at the root of the item tree has an indentation level of 0. |
itemLink - String!
|
Link to the release in the Helix Plan native client |
date - ISODate!
|
The date of the release |
links - [Link]!
|
List of links to internal items or external sites |
hidden - Boolean!
|
The hidden status of the release. If true, the release is not shown by default |
watchers - [User]!
|
The users watching the release |
watching - Boolean!
|
The watch status of the authenticated user. True if watching, false otherwise |
customFields - [CustomField]!
|
The custom fields of the release |
attachments - [Attachment]!
|
The attachments of the release |
subprojectPath - String
|
The subproject path of the release |
Example
{
"id": 4,
"projectID": "4",
"localID": 4,
"name": "xyz789",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"color": "notSet",
"hyperlink": "abc123",
"indentationLevel": 123,
"itemLink": "abc123",
"date": ISODate,
"links": [Link],
"hidden": true,
"watchers": [User],
"watching": true,
"customFields": [CustomField],
"attachments": [Attachment],
"subprojectPath": "xyz789"
}
Risk
Description
Task risk
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"none"
ScatterChart
ScatterChartData
Fields
| Field Name | Description |
|---|---|
legendIsVisible - Boolean!
|
|
orientation - Orientation!
|
|
grouping - ChartGrouping!
|
|
dataLabels - ChartLabels!
|
|
dimensions - [String]!
|
|
measures - [String]!
|
|
axisLabels - [String]!
|
|
datasets - [ScatterDataset]!
|
Example
{
"legendIsVisible": false,
"orientation": "horizontal",
"grouping": "none",
"dataLabels": "notVisible",
"dimensions": ["abc123"],
"measures": ["xyz789"],
"axisLabels": ["abc123"],
"datasets": [ScatterDataset]
}
ScatterDataset
Fields
| Field Name | Description |
|---|---|
labels - [String]!
|
|
label - String!
|
|
backgroundColor - String!
|
|
data - [ScatterPoint]!
|
Example
{
"labels": ["xyz789"],
"label": "abc123",
"backgroundColor": "abc123",
"data": [ScatterPoint]
}
ScatterPoint
ScheduledTask
Description
A Helix Plan scheduled task
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the scheduled task |
projectID - ID!
|
The unique id of the project where the scheduled task is listed. Can be a project or backlog id. A scheduled task can be listed in more than one project. Depending on the project, subprojectPath and indentationLevel can have different values |
localID - ID!
|
An id that is unique for the scheduled task within the project where the scheduled task was created (backlog project or planning project). |
committedToProjectID - ID
|
The unique id of the planning project that the task was committed to |
name - String
|
The name of the scheduled task |
createdBy - User!
|
The user that created the scheduled task |
createdOn - ISODateTime!
|
The time that the scheduled task was created on |
lastUpdatedBy - User!
|
The user that last updated the scheduled task |
lastUpdatedOn - ISODateTime!
|
The time that the scheduled task was last updated on |
lastCommentedOn - ISODateTime
|
The time that the scheduled task was last commented on |
status - Status!
|
The status set on the scheduled task |
workflow - Workflow
|
The workflow set on the scheduled task |
workflowStatus - WorkflowStatus
|
The workflow status set on the scheduled task |
confidence - Confidence
|
Confidence set on the scheduled task |
risk - Risk
|
Risk set on the scheduled task |
color - Color
|
The color set on the scheduled task |
hyperlink - String
|
The hyperlink set on the scheduled task |
assignedTo - [AssignedUser!]
|
The users that the scheduled task is assigned to |
subprojectPath - String
|
The subproject path of the scheduled task |
points - Int
|
The points set on the scheduled task |
customFields - [CustomField]
|
The custom fields of the scheduled task |
indentationLevel - Int!
|
The Indentation level for A scheduled task in project. A scheduled task at the root of the item tree has an indentaion level of 0. |
customField - CustomField!
|
A custom field for a specified custom field id. The custom field ids are the ids of the custom columns |
Arguments
|
|
itemLink - String!
|
Link to the scheduled task in the Helix Plan native client |
timeSpans - [TimeSpan]!
|
The list of time spans of the scheduled task, A scheduled task can be split into several time spans |
releases - [Release]!
|
The releases that the scheduled task has been tagged to |
category - Category
|
The category of the scheduled task |
backlogPriority - Priority
|
The backlog priority of the task |
estimatedDays - Float
|
The estimated days set on the scheduled task. Can be displayed as days or hours depending on the project setting |
links - [Link]!
|
List of links to internal items or external sites |
hidden - Boolean!
|
The hidden status of the scheduled task. If true, the scheduled task is not shown by default |
duration - Int!
|
The duration in days of the scheduled task |
isUserStory - Boolean!
|
The user story status of scheduled task. If true the task is a user story and can have data in the user story field |
userStory - String
|
The user story of the scheduled task. Will only have data if isUserStory is set to true. |
attachments - [Attachment]!
|
The attachments of the scheduled task |
wbs - String!
|
The work breakdown structure of the scheduled task. The WBS value is only available in the backlog |
watchers - [User]!
|
The users watching the scheduled task |
watching - Boolean!
|
The watch status of the authenticated user. True if watching, false otherwise |
linkedToPipelineTask - Item
|
The pipeline task that automatically created this scheduled task if it is part of a pipeline |
createdFromWorkflow - Boolean!
|
Indicates if the scheduled task was created by a pipeline or workflow |
hasChildren - Boolean!
|
Indicates if the scheduled task has children tasks |
aggregatedFieldsSummary - AggregatedFieldsSummary
|
The aggregated summary of the numeric fields of a scheduled task with children |
Example
{
"id": 4,
"projectID": "4",
"localID": "4",
"committedToProjectID": 4,
"name": "xyz789",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"status": "none",
"workflow": Workflow,
"workflowStatus": WorkflowStatus,
"confidence": "none",
"risk": "none",
"color": "notSet",
"hyperlink": "abc123",
"assignedTo": [AssignedUser],
"subprojectPath": "abc123",
"points": 987,
"customFields": [CustomField],
"indentationLevel": 123,
"customField": CustomField,
"itemLink": "xyz789",
"timeSpans": [TimeSpan],
"releases": [Release],
"category": "none",
"backlogPriority": "none",
"estimatedDays": 123.45,
"links": [Link],
"hidden": true,
"duration": 123,
"isUserStory": false,
"userStory": "xyz789",
"attachments": [Attachment],
"wbs": "abc123",
"watchers": [User],
"watching": false,
"linkedToPipelineTask": Item,
"createdFromWorkflow": false,
"hasChildren": true,
"aggregatedFieldsSummary": AggregatedFieldsSummary
}
SchedulingMethod
Description
Project scheduling method
Values
| Enum Value | Description |
|---|---|
|
|
This task scheduling method is commonly used in all types of development projects. The duration of tasks will be constant in the schedule independent of the amount of users allocated to them |
|
|
This task scheduling method is preferably used when a time budget is used for the project and its sub projects and tasks. An additional budgeted work column is added. Tasks behave differently from the fixed duration setup in the sense that the duration will adjust to the allocated amount of users and time budgeted. |
Example
"fixedDuration"
SdkSyncMethod
Values
| Enum Value | Description |
|---|---|
|
|
SDK session only syncs only projects that this SDK user is a member of. |
|
|
SDK session only syncs all projects. |
Example
"allMembersProjects"
SdkUser
Description
A Helix Plan SDK user. This user can only be used by an SDK connecting to the server and cannot be logged in to from the client. This is the only type of user that an SDK can log in with.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the user |
name - String!
|
The name of the user |
sortName - String!
|
Name used for sorting instead of the user name. If not set the name of the user is returned |
syncMethod - SdkSyncMethod!
|
This decides how the SDK session connecting with this user sync projects |
passwordConfigurations - PasswordConfigurations!
|
User's password configurations |
isDeleted - Boolean!
|
Flag that indicates if a user is deleted but still present in the database |
isLocked - Boolean!
|
Flag that indicates if a user is locked and cannot log in because they were shared from another Helix Plan server and the share was removed or disconnected |
authenticationProvider - Boolean!
|
The SDK user is allowed to provide custom authentication services. |
credentialCheckProvider - Boolean!
|
The SDK is allowed to provide credential check services. |
chatUser - Boolean!
|
The SDK user will be available for chat |
isActiveAccount - Boolean!
|
The SDK account is active. When the account is active the SDK can log on to the server, when inactive the SDK can not log in. |
userLink - String!
|
Link to the sdk user in the Helix Plan native client |
Example
{
"id": "4",
"name": "xyz789",
"sortName": "abc123",
"syncMethod": "allMembersProjects",
"passwordConfigurations": PasswordConfigurations,
"isDeleted": true,
"isLocked": false,
"authenticationProvider": false,
"credentialCheckProvider": true,
"chatUser": false,
"isActiveAccount": false,
"userLink": "xyz789"
}
SecurityPolicy
Description
Different security settings that is the database security policy
Fields
| Field Name | Description |
|---|---|
minPasswordLength - PositiveInt!
|
Minimum password length. 0 means that this setting is ignored |
minPasswordAlpha - PositiveInt!
|
Minimum number of alphabetic characters in passwords. 0 means that this setting is ignored |
minPasswordNumeric - PositiveInt!
|
Minimum number of numeric characters in passwords. 0 means that this setting is ignored |
minPasswordNonAlphaNumeric - PositiveInt!
|
Minimum number of symbol characters in passwords. 0 means that this setting is ignored |
minPasswordUpperCase - PositiveInt!
|
Minimum number of upper case characters in passwords. 0 means that this setting is ignored |
minPasswordLowerCase - PositiveInt!
|
Minimum number of lower case characters in passwords. 0 means that this setting is ignored |
passwordExpireDays - PositiveInt!
|
Number of days until passwords expire. 0 means that this setting is ignored |
tokensExpireDays - PositiveInt!
|
Number of days until tokens expire. 0 means that this setting is ignored |
passwordsInHistory - PositiveInt!
|
Number of passwords to save in history. 0 means that this setting is ignored |
adminsCanChangePolicy - Boolean!
|
Can users with administration rights change the security policy |
Example
{
"minPasswordLength": 123,
"minPasswordAlpha": 123,
"minPasswordNumeric": 123,
"minPasswordNonAlphaNumeric": 123,
"minPasswordUpperCase": 123,
"minPasswordLowerCase": 123,
"passwordExpireDays": 123,
"tokensExpireDays": 123,
"passwordsInHistory": 123,
"adminsCanChangePolicy": true
}
SetItemInternalDataInput
Description
The data needed to set internal data on an item
Example
{
"id": 4,
"identifier": "abc123",
"data": "xyz789"
}
Severity
Description
Bug severity
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"none"
ShowOptions
Description
The show options that can be passed with the todolist
Fields
| Input Field | Description |
|---|---|
showCompleted - Boolean
|
Flag to include completed tasks in the todolist |
showOnlyNextFourWeeksOfTasks - Boolean
|
Flag to only tasks that should be started in the next 4 weeks |
showPipelineTasksThatCannotStart - Boolean
|
Flag to include pipeline tasks that cannot start yet |
showHidden - Boolean
|
Flag to include tasks that are marked as hidden |
Example
{
"showCompleted": true,
"showOnlyNextFourWeeksOfTasks": true,
"showPipelineTasksThatCannotStart": false,
"showHidden": false
}
SingleSelectionDropListCustomColumn
Description
A drop list custom column with single selection
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the custom column |
projectID - ID!
|
The unique id of the project of the custom column |
name - String!
|
The name of the column |
readOnly - Boolean!
|
Read-only state of the column |
activated - Boolean!
|
Set to true if the custom column is activated in the project, false otherwise |
items - [DropListItem]!
|
The drop list items that can be set on a task in the column |
Example
{
"id": "4",
"projectID": "4",
"name": "abc123",
"readOnly": false,
"activated": true,
"items": [DropListItem]
}
SingleSelectionDropListCustomField
Description
A drop list custom field with single selection
Example
{
"id": 4,
"taskID": "4",
"singleSelectionDropListValue": "4"
}
Sprint
Description
A Helix Plan sprint
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the sprint |
projectID - ID!
|
The unique id of the project where the sprint is listed |
localID - ID!
|
An id that is unique within the planning project |
name - String
|
The name of the sprint |
createdBy - User!
|
The user that created the sprint |
createdOn - ISODateTime!
|
The time that the sprint was created on |
lastUpdatedBy - User!
|
The user that last updated the sprint |
lastUpdatedOn - ISODateTime!
|
The time that the sprint was last updated on |
lastCommentedOn - ISODateTime
|
The time that the sprint was last commented on |
confidence - Confidence
|
Confidence set on the sprint |
color - Color
|
The color set on the sprint |
risk - Risk
|
Risk set on the sprint |
hyperlink - String
|
The hyperlink set on sprint |
indentationLevel - Int!
|
The Indentation level for an sprint in project. A sprint at the root of the item tree has an indentaion level of 0. |
itemLink - String!
|
Link to the sprint in the Helix Plan native client |
start - ISODate!
|
The start date of the sprint |
finish - ISODate!
|
The finish date of the sprint |
releases - [Release]!
|
The releases that the sprint has been tagged to |
links - [Link]!
|
List of links to internal items or external sites |
hidden - Boolean!
|
The hidden status of the sprint. If true, the sprint is not shown by default |
board - Boolean!
|
The board state of a sprint. If true the sprint is also sprint board |
duration - Int!
|
The duration in days of the sprint |
watchers - [User]!
|
The users watching the sprint |
watching - Boolean!
|
The watch status of the authenticated user. True if watching, false otherwise |
membersHaveFullAccessRights - Boolean!
|
Indicates if the members of the sprint have full access rights, returns false otherwise |
customFields - [CustomField]
|
The custom fields of the sprint |
attachments - [Attachment]!
|
The attachments of the sprint |
workRemaining - Float
|
The work remaining hours for a sprint. |
estimatedDays - Float
|
The aggregated estimated days on the sprint. Can be displayed as days or hours depending on the project setting and cannot be set manually on sprints |
status - Status!
|
The aggregated status of a sprint and cannot be set manually on sprints |
points - Int
|
The aggregated points set on the sprint and cannot be set manually on sprints |
aggregatedFieldsSummary - AggregatedFieldsSummary
|
The aggregated summary of the numeric fields of a sprint with children |
subprojectPath - String
|
The subproject path of the sprint |
allocations - [SprintUser!]
|
The users that are allocated to the sprint |
Example
{
"id": 4,
"projectID": 4,
"localID": 4,
"name": "xyz789",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"confidence": "none",
"color": "notSet",
"risk": "none",
"hyperlink": "abc123",
"indentationLevel": 987,
"itemLink": "abc123",
"start": ISODate,
"finish": ISODate,
"releases": [Release],
"links": [Link],
"hidden": true,
"board": false,
"duration": 123,
"watchers": [User],
"watching": true,
"membersHaveFullAccessRights": false,
"customFields": [CustomField],
"attachments": [Attachment],
"workRemaining": 123.45,
"estimatedDays": 123.45,
"status": "none",
"points": 987,
"aggregatedFieldsSummary": AggregatedFieldsSummary,
"subprojectPath": "abc123",
"allocations": [SprintUser]
}
SprintUser
SsoResponse
Description
The Response communication when authenticating through SSO
Example
{
"token": Token,
"ssoURL": "abc123"
}
Status
Description
Task status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"none"
StatusToWorkflowStatus
StatusWorkflow
Description
A status workflow where only one step of the workflow can be active at once.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the linear workflow |
projectID - ID!
|
The unique id of the project of the linear workflow |
name - String
|
The name of the linear workflow |
icon - UserIcon
|
The icon of the linear workflow |
statuses - [WorkflowStatus]
|
A list of the available workflow statuses |
hideItemStatus - Boolean!
|
Determines whether the normal status of the item should be hidden |
showInQA - Boolean!
|
Determines whether status workflow is shown in the QA project |
showInPlanning - Boolean!
|
Determines whether status workflow is shown in the Planning and Backlog project |
Example
{
"id": "4",
"projectID": "4",
"name": "abc123",
"icon": "default",
"statuses": [WorkflowStatus],
"hideItemStatus": false,
"showInQA": true,
"showInPlanning": true
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
Table
TableChartData
Task
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the task |
projectID - ID!
|
The unique id of the project where the task is listed. Can be a project, backlog or QA id. A task can be listed in more than one project. Depending on the project, subprojectPath and indentationLevel can have different values |
localID - ID!
|
An id that is unique for the task within the project where the task was created (backlog project, planning project or QA project). |
committedToProjectID - ID
|
The unique id of the planning project that the task was committed to |
name - String
|
The name of the task |
createdBy - User!
|
The user that created the task |
createdOn - ISODateTime!
|
The time that the task was created on |
lastUpdatedBy - User!
|
The user that last updated the task |
lastUpdatedOn - ISODateTime!
|
The time that the task was last updated on |
lastCommentedOn - ISODateTime
|
The time that the task was last commented on |
status - Status!
|
The status set on the task |
subprojectPath - String
|
The subproject path of the task |
customFields - [CustomField]
|
The custom fields of the task |
confidence - Confidence
|
Confidence set on the task |
risk - Risk
|
Risk set on the task |
color - Color
|
The color set on the task |
hyperlink - String
|
The hyperlink set on the task |
assignedTo - [AssignedUser!]
|
The users that the scheduled task is assigned to |
workflow - Workflow
|
The workflow set on the task |
workflowStatus - WorkflowStatus
|
The workflow status set on the task |
indentationLevel - Int!
|
The Indentation level for a task in project. A task at the root of the item tree has an indentation level of 0. |
customField - CustomField!
|
A custom field for a specified custom field id. The custom field ids are the ids of the custom columns |
Arguments
|
|
itemLink - String!
|
Link to the task in the Helix Plan native client |
releases - [Release]!
|
The releases that the task has been tagged to |
links - [Link]!
|
List of links to internal items or external sites |
hidden - Boolean!
|
The hidden status of the task. If true, the task is not shown by default |
attachments - [Attachment]!
|
The attachments of the task |
watchers - [User]!
|
The users watching the task |
watching - Boolean!
|
The watch status of the authenticated user. True if watching, false otherwise |
Possible Types
| Task Types |
|---|
Example
{
"id": 4,
"projectID": 4,
"localID": 4,
"committedToProjectID": "4",
"name": "xyz789",
"createdBy": User,
"createdOn": ISODateTime,
"lastUpdatedBy": User,
"lastUpdatedOn": ISODateTime,
"lastCommentedOn": ISODateTime,
"status": "none",
"subprojectPath": "abc123",
"customFields": [CustomField],
"confidence": "none",
"risk": "none",
"color": "notSet",
"hyperlink": "xyz789",
"assignedTo": [AssignedUser],
"workflow": Workflow,
"workflowStatus": WorkflowStatus,
"indentationLevel": 123,
"customField": CustomField,
"itemLink": "xyz789",
"releases": [Release],
"links": [Link],
"hidden": false,
"attachments": [Attachment],
"watchers": [User],
"watching": false
}
TaskCompletionMethod
Description
Project task completion method
Values
| Enum Value | Description |
|---|---|
|
|
The completion method is determined by the project scheduling method. If scheduling method is set to fixed duration, the completion method is status, if scheduling method is fixed work, completion method is percent |
|
|
Use only Status column to complete scheduled tasks |
|
|
Use Percentage and Status column to complete a scheduled task |
Example
"auto"
TextCustomColumn
Description
A text custom column
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the custom column |
projectID - ID!
|
The unique id of the project of the custom column |
name - String!
|
The name of the column |
readOnly - Boolean!
|
Read-only state of the column |
activated - Boolean!
|
Set to true if the custom column is activated in the project, false otherwise |
Example
{
"id": 4,
"projectID": "4",
"name": "xyz789",
"readOnly": true,
"activated": true
}
TextCustomField
Description
A text custom field
Example
{"id": 4, "taskID": 4, "value": "xyz789"}
TimeSpan
Description
A period of time between start and end date for ta specific time span of a scheduled task, a scheduled task can be split into several time spans.
Example
{
"start": ISODate,
"finish": ISODate
}
TimeSpentCustomColumn
Description
A custom column for adding time spent
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the custom column |
projectID - ID!
|
The unique id of the project of the custom column |
name - String!
|
The name of the column |
readOnly - Boolean!
|
Read-only state of the column |
activated - Boolean!
|
Set to true if the custom column is activated in the project, false otherwise |
Example
{
"id": 4,
"projectID": 4,
"name": "abc123",
"readOnly": false,
"activated": true
}
TimeSpentCustomField
Description
A custom field for adding time spent
Example
{"id": 4, "taskID": 4, "timeSpentValue": 123.45}
TimesheetLock
Description
The settings for timesheet lock in a Helix Plan project
Example
{"activateLock": false, "date": ISODate}
TimesheetLockInput
Description
The input settings for timesheet lock in a Helix Plan project
Example
{"activateLock": false, "date": ISODate}
Token
Description
Authentication token in JWT format
Fields
| Field Name | Description |
|---|---|
access_token - String!
|
Example
{"access_token": "xyz789"}
UpdateBacklogTaskInput
Description
The properties of the backlog task to update
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The unique id of the backlog task to update |
name - String
|
The name to set |
status - Status
|
The status to set on the task |
points - PositiveInt
|
The points to set on the task |
confidence - Confidence
|
The confidence to set on the task |
risk - Risk
|
The risk to set on the task |
color - Color
|
The color to set on the task |
hyperlink - String
|
The hyperlink to set on the task |
workflowID - ID
|
The workflow id of the workflow to set on the task |
workflowStatusID - ID
|
The workflow status id of the workflow status to set on the task |
workRemaining - Float
|
The work remaining to set on the task. The task must be committed to a sprint |
assignedTo - [AssignedUserInput]
|
The assigned users to set on the task |
sprintID - ID
|
The id of the sprint to commit the backlog task to |
releaseIDs - [ID!]
|
The ids of the releases to tag the backlog task to, 'NoRelease' can be used for ID if the task should not inherit the parent's releases and '-1' should be used to inherit the parent's releases |
category - Category
|
The category of the backlog task |
backlogPriority - Priority
|
The backlog priority of the task |
sprintPriority - Priority
|
The sprint priority of the task. Can only be set if the backlog task is committed to a sprint |
estimatedDays - Float
|
The estimated days set on the scheduled task. Can be displayed as days or hours depending on the project setting. Cannot be set to negative |
hidden - Boolean
|
The hidden status of the backlog task |
epic - Boolean
|
The epic status of the backlog task |
isUserStory - Boolean
|
The user story status of backlog task. If true the task is a user story and can have data in the user story field |
userStory - String
|
The user story of the backlog task. Will be set if isUserStory was previously set or set in the same command |
watchers - UsersOrGroupsInput
|
The users or groups watching the backlog task |
Example
{
"id": "4",
"name": "abc123",
"status": "none",
"points": 123,
"confidence": "none",
"risk": "none",
"color": "notSet",
"hyperlink": "xyz789",
"workflowID": "4",
"workflowStatusID": 4,
"workRemaining": 987.65,
"assignedTo": [AssignedUserInput],
"sprintID": "4",
"releaseIDs": [4],
"category": "none",
"backlogPriority": "none",
"sprintPriority": "none",
"estimatedDays": 123.45,
"hidden": false,
"epic": true,
"isUserStory": false,
"userStory": "abc123",
"watchers": UsersOrGroupsInput
}
UpdateBugInput
Description
The properties of the bug to update
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The unique id of the bug to update |
name - String
|
The name to set on the bug |
status - Status
|
The status to set on the bug |
confidence - Confidence
|
The confidence to set on the bug |
risk - Risk
|
The risk to set on the bug |
color - Color
|
The color to set on the bug |
severity - Severity
|
The severity to set on the bug |
hyperlink - String
|
The hyperlink to set on the bug |
workflowID - ID
|
The workflow id of the workflow to set on the bug |
workflowStatusID - ID
|
The workflow status id of the workflow status to set on the bug |
workRemaining - Float
|
The work remaining to set on the bug |
assignedTo - [AssignedUserInput]
|
The assigned users to set on the bug |
sprintID - ID
|
The id of the sprint to commit the backlog task to |
releaseIDs - [ID!]
|
The ids of the releases to tag the bug to, 'NoRelease' can be used for ID if the task should not inherit the parent's releases |
stepsToReproduce - String
|
The steps to reproduce the bug |
detailedDescription - String
|
The detailed description of the bug |
bugPriority - Priority
|
The bug priority of the bug |
sprintPriority - Priority
|
The sprint priority of the task |
hidden - Boolean
|
The hidden status of the bug |
watchers - UsersOrGroupsInput
|
The users or groups watching the bug |
Example
{
"id": 4,
"name": "abc123",
"status": "none",
"confidence": "none",
"risk": "none",
"color": "notSet",
"severity": "none",
"hyperlink": "abc123",
"workflowID": 4,
"workflowStatusID": 4,
"workRemaining": 123.45,
"assignedTo": [AssignedUserInput],
"sprintID": 4,
"releaseIDs": ["4"],
"stepsToReproduce": "abc123",
"detailedDescription": "abc123",
"bugPriority": "none",
"sprintPriority": "none",
"hidden": false,
"watchers": UsersOrGroupsInput
}
UpdateCommentInput
UpdateExpiredPasswordInput
Description
The required credentials to update a user's expired password
Example
{
"username": "abc123",
"existingPassword": "xyz789",
"newPassword": "xyz789"
}
UpdateExternalLinkInput
Description
The properties of the external link to update
Example
{
"fromItemID": "4",
"url": "xyz789",
"relation": "relatedTo",
"notes": "abc123"
}
UpdateGhostUserInput
UpdateInternalLinkInput
Description
The properties of the internal link to update
Example
{
"fromItemID": "4",
"toItemID": "4",
"relation": "relatedTo",
"notes": "abc123"
}
UpdateNormalUserInput
Description
The properties of the normal user to update
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The unique id of the user |
name - String
|
The name of the user |
password - String
|
Password of the user |
sortName - String
|
Name used for sorting instead of the user name |
emailAddress - String
|
The email address of the user |
passwordConfigurations - PasswordConfigurationsInput
|
the password configurations of the user |
accessRights - NormalUserAccessRightsInput
|
the access rights of the user |
Example
{
"id": 4,
"name": "xyz789",
"password": "xyz789",
"sortName": "xyz789",
"emailAddress": "xyz789",
"passwordConfigurations": PasswordConfigurationsInput,
"accessRights": NormalUserAccessRightsInput
}
UpdateProjectInput
Description
The properties of the project to update. Only updates set properties.
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The project id of the project to update |
name - String
|
The name of the project |
sortName - String
|
Name used for sorting instead of the project name |
archivedStatus - Boolean
|
Archived status. Set to true to indicate that the project is archived. An archived project is kept in the database but is not synchronized to users connecting to the database saving network bandwidth and memory on the client |
schedulingMethod - SchedulingMethod
|
The scheduling method used |
taskCompletionMethod - TaskCompletionMethod
|
The task completeion method used |
defaultMode - DefaultMode
|
The default project mode for new users |
methodTemplate - MethodTemplate
|
The method template for the project |
timesheetLock - TimesheetLockInput
|
The timesheet lock settings for the project |
Example
{
"id": "4",
"name": "abc123",
"sortName": "xyz789",
"archivedStatus": false,
"schedulingMethod": "fixedDuration",
"taskCompletionMethod": "auto",
"defaultMode": "taskScheduling",
"methodTemplate": "scrum",
"timesheetLock": TimesheetLockInput
}
UpdateQaUserInput
Description
The properties of the QA user to update
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The unique id of the user |
name - String
|
The name of the user |
password - String
|
Password of the user |
sortName - String
|
Name used for sorting instead of the user name |
emailAddress - String
|
The email address of the user |
passwordConfigurations - PasswordConfigurationsInput
|
the password configurations of the user |
accessRights - QaUserAccessRightsInput
|
the access rights of the user |
Example
{
"id": "4",
"name": "abc123",
"password": "abc123",
"sortName": "abc123",
"emailAddress": "abc123",
"passwordConfigurations": PasswordConfigurationsInput,
"accessRights": QaUserAccessRightsInput
}
UpdateReleaseInput
Description
The properties of the release to update
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The unique id of the release to update |
name - String
|
The name to set on the release |
color - Color
|
The color to set on the sprint |
hyperlink - String
|
The hyperlink to set on the sprint |
hidden - Boolean
|
The hidden status to set on the sprint |
watchers - UsersOrGroupsInput
|
The users or groups watching the sprint |
Example
{
"id": "4",
"name": "abc123",
"color": "notSet",
"hyperlink": "abc123",
"hidden": false,
"watchers": UsersOrGroupsInput
}
UpdateScheduledTaskInput
Description
The properties of the scheduled task to update
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The unique id of the scheduled task to update |
name - String
|
The name to set on the scheduled Task |
status - Status
|
The status to set on scheduled the task |
points - Int
|
The points to set on the scheduled task |
confidence - Confidence
|
The confidence to set on the scheduled task |
risk - Risk
|
The risk to set on the scheduled task |
color - Color
|
The color to set on the scheduled task |
hyperlink - String
|
The hyperlink to set on the scheduled task |
workflowID - ID
|
The workflow id of the workflow to set on the scheduled task |
workflowStatusID - ID
|
The workflow status id of the workflow status to set on the scheduled task |
assignedTo - [AssignedUserInput]
|
The assigned users to set on the scheduled task |
releaseIDs - [ID!]
|
The ids of the releases to tag the scheduled task to, 'NoRelease' can be used for ID if the task should not inherit the parent's releases and '-1' should be used to inherit the parent's releases |
category - Category
|
The category to set on the scheduled task |
backlogPriority - Priority
|
The backlog priority to set on the scheduled task |
estimatedDays - Float
|
The estimated days set on the scheduled task. Can be displayed as days or hours depending on the project setting. Cannot be set to negative |
hidden - Boolean
|
The hidden status to set on the scheduled task |
watchers - UsersOrGroupsInput
|
The users or groups watching the scheduled task |
isUserStory - Boolean
|
The user story status of backlog task. If true the task is a user story and can have data in the user story field |
userStory - String
|
The user story of the backlog task. Will be set if isUserStory was previously set or set in the same command |
Example
{
"id": 4,
"name": "xyz789",
"status": "none",
"points": 987,
"confidence": "none",
"risk": "none",
"color": "notSet",
"hyperlink": "xyz789",
"workflowID": 4,
"workflowStatusID": "4",
"assignedTo": [AssignedUserInput],
"releaseIDs": ["4"],
"category": "none",
"backlogPriority": "none",
"estimatedDays": 987.65,
"hidden": true,
"watchers": UsersOrGroupsInput,
"isUserStory": false,
"userStory": "abc123"
}
UpdateSdkUserInput
Description
The properties of the SDK user to update
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The unique id of the user |
name - String
|
The name of the user |
password - String
|
Password of the user |
sortName - String
|
Name used for sorting instead of the user name |
passwordConfigurations - PasswordConfigurationsInput
|
the password configurations of the user |
syncMethod - SdkSyncMethod
|
This decides how the SDK session connecting with this user sync projects |
isActiveAccount - Boolean
|
The SDK account is active. When the account is active the SDK can log on to the server, when inactive the SDK can not log in. |
Example
{
"id": "4",
"name": "abc123",
"password": "xyz789",
"sortName": "xyz789",
"passwordConfigurations": PasswordConfigurationsInput,
"syncMethod": "allMembersProjects",
"isActiveAccount": true
}
UpdateSprintInput
Description
The properties of the sprint to update
Fields
| Input Field | Description |
|---|---|
id - ID!
|
The unique id of the sprint to update |
name - String
|
The name to set on the sprint |
confidence - Confidence
|
The confidence to set on the sprint |
risk - Risk
|
The risk to set on the sprint |
color - Color
|
The color to set on the sprint |
hyperlink - String
|
The hyperlink to set on the sprint |
releaseIDs - [ID!]
|
The ids of the releases to tag the sprint to, 'NoRelease' can be used for ID if the sprint should not inherit the parent's releases and '-1' should be used to inherit the parent's releases |
hidden - Boolean
|
The hidden status to set on the sprint |
watchers - UsersOrGroupsInput
|
The users or groups watching the sprint |
Example
{
"id": 4,
"name": "xyz789",
"confidence": "none",
"risk": "none",
"color": "notSet",
"hyperlink": "xyz789",
"releaseIDs": [4],
"hidden": false,
"watchers": UsersOrGroupsInput
}
UpdateUserGroupInput
Example
{
"id": "4",
"name": "xyz789",
"sortName": "abc123",
"userIDs": [4]
}
User
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the user |
name - String!
|
The name of the user |
sortName - String!
|
Name used for sorting instead of the user name. If not set the name of the user is returned |
isDeleted - Boolean!
|
Flag that indicates if a user is deleted but still present in the database |
isLocked - Boolean!
|
Flag that indicates if a user is locked and cannot log in because they were shared from another Helix Plan server and the share was removed or disconnected |
userLink - String!
|
Link to the user in the Helix Plan native client |
Possible Types
| User Types |
|---|
Example
{
"id": 4,
"name": "abc123",
"sortName": "abc123",
"isDeleted": false,
"isLocked": true,
"userLink": "xyz789"
}
UserAccessRights
Fields
| Field Name | Description |
|---|---|
isActiveAccount - Boolean!
|
The user account is active. When the account is active the user can log on to the server, when inactive the user can not log in. |
admin - Boolean!
|
The user has administrative access and is able to manage users and projects in the database. |
portfolioAllocation - Boolean!
|
The user has access to portfolio allocation pane in client. |
documentManagement - Boolean!
|
The user has access to document management pane in client. |
avatarManagement - Boolean!
|
The user is able to manage user avatars |
chat - Boolean!
|
The user has access to chat |
dashboards - Boolean!
|
The user has access to dashboards. |
dashboardPageShare - Boolean!
|
The user can share dashboard pages to other users |
Example
{
"isActiveAccount": true,
"admin": true,
"portfolioAllocation": true,
"documentManagement": false,
"avatarManagement": true,
"chat": false,
"dashboards": true,
"dashboardPageShare": true
}
UserCustomColumn
Description
A custom column with users
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the custom column |
projectID - ID!
|
The unique id of the project of the custom column |
name - String!
|
The name of the column |
readOnly - Boolean!
|
Read-only state of the column |
activated - Boolean!
|
Set to true if the custom column is activated in the project, false otherwise |
Example
{
"id": "4",
"projectID": 4,
"name": "xyz789",
"readOnly": true,
"activated": true
}
UserCustomField
Description
A custom field with users
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the custom field. The id is an id of a UserCustomColumn |
taskID - ID!
|
The unique id of the task that the field is set on |
userAndGroupValue - [UserOrGroup]
|
The user or group ids set on the custom field |
Example
{
"id": 4,
"taskID": "4",
"userAndGroupValue": [NormalUser]
}
UserGroup
Description
User groups are groupings of users. They can be
- global and used across multiple projects in a Helix Plan database, or
- project specific to group users in a specific Helix Plan project
When created, a project user group can be edited to become a global group, but project groups can not be changed to a different project, nor can global groups be made a project group
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the user group |
project - Project
|
The project the user group is part of. If null then the user group is a global user group |
name - String!
|
The name of the user group |
sortName - String!
|
Name used for sorting instead of the group name. If not set the name of the group is returned |
users - [User]!
|
The users that are members of the group |
Example
{
"id": "4",
"project": Project,
"name": "abc123",
"sortName": "xyz789",
"users": [User]
}
UserIcon
Description
List of available user icons
Values
| Enum Value | Description |
|---|---|
|
|
Default icon (redDot) |
|
|
White box |
|
|
Green box |
|
|
Yellow box |
|
|
Red box |
|
|
Blue box |
|
|
Magenta box |
|
|
Orange box |
|
|
Check |
|
|
Red dot |
|
|
Blue face |
|
|
Grey face |
|
|
Orange face |
|
|
Gold face |
|
|
Locked |
|
|
Unlocked |
|
|
Re-open bug |
|
|
New bug |
|
|
Assigned bug |
|
|
Fixed bug |
|
|
Verified bug |
|
|
Closed bug |
|
|
Group |
|
|
Grey group |
|
|
Light grey group |
|
|
Green circle |
|
|
Yellow circle |
|
|
Red circle |
|
|
Blue circle |
|
|
Magenta circle |
|
|
Orange circle |
|
|
Yes box |
|
|
No box |
|
|
Question box |
|
|
Project |
|
|
Deleted user |
|
|
Workflow |
|
|
Progress |
|
|
Step |
|
|
Pipeline |
|
|
Report |
|
|
Very high priority box |
|
|
High priority box |
|
|
Medium priority box |
|
|
Low priority box |
|
|
Very low priority |
|
|
Disabled |
|
|
Plus |
|
|
No icon |
|
|
Red warning triangle |
|
|
Yellow warning triangle |
|
|
Exclamation mark |
|
|
Information |
|
|
Pause |
|
|
Stop |
Example
"default"
UserOrGroup
Types
| Union Types |
|---|
Example
NormalUser
UsersOrGroupsInput
VisualChartData
Fields
| Field Name | Description |
|---|---|
legendIsVisible - Boolean!
|
|
orientation - Orientation!
|
|
grouping - ChartGrouping!
|
|
dataLabels - ChartLabels!
|
Possible Types
| VisualChartData Types |
|---|
Example
{
"legendIsVisible": true,
"orientation": "horizontal",
"grouping": "none",
"dataLabels": "notVisible"
}
Workflow
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the workflow |
projectID - ID!
|
The unique id of the project of the workflow |
name - String
|
The name of the workflow |
icon - UserIcon
|
The icon of the workflow |
Possible Types
| Workflow Types |
|---|
Example
{
"id": 4,
"projectID": "4",
"name": "abc123",
"icon": "default"
}
WorkflowID
WorkflowIDInput
WorkflowStatus
Description
A workflow status step set in a status workflow. A Helix Plan item that has a workflow set on it can have a workflow status set
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The unique id of the workflow status |
workflowID - ID!
|
The unique id of the parent workflow |
projectID - ID!
|
The unique id of the project where the workflow was created |
name - String!
|
The name of the workflow status |
icon - UserIcon
|
The icon of the workflow status |
connectedStatuses - [ConnectedStatus]
|
List of connected statuses that the authenticated user can go to |
statusToWorkflowStatuses - [StatusToWorkflowStatus]
|
List of status to workflow status actions, i.e. when the item status changes a workflow status change event will take place |
Example
{
"id": 4,
"workflowID": "4",
"projectID": "4",
"name": "xyz789",
"icon": "default",
"connectedStatuses": [ConnectedStatus],
"statusToWorkflowStatuses": [StatusToWorkflowStatus]
}