Helix Plan GraphQL API Documentation

For information about installation and setup, see Helix Plan API Server Setup Guide

Contact

Helix Plan Support

support@perforce.com

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

Response

Returns a Chart!

Arguments
Name Description
id - ID! The unique id of the chart to find

Example

Query
query chart($id: ID!) {
  chart(id: $id) {
    id
    name
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "chart": {"id": 4, "name": "xyz789"}
  }
}

charts

Description

Returns a list of charts on a dashboard page

Response

Returns [Chart]!

Arguments
Name Description
id - ID! The unique id of the dashboard page of the charts

Example

Query
query charts($id: ID!) {
  charts(id: $id) {
    id
    name
  }
}
Variables
{"id": 4}
Response
{
  "data": {
    "charts": [
      {
        "id": "4",
        "name": "xyz789"
      }
    ]
  }
}

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

Arguments
Name Description
id - ID! The unique id of the task the custom field is set on
customFieldID - ID! The unique id of the custom field.

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

Response

Returns a String!

Arguments
Name Description
id - ID! The unique identifier for the settings, e.g. 'com.example.myintegration'

Example

Query
query globalCustomSettings($id: ID!) {
  globalCustomSettings(id: $id)
}
Variables
{"id": 4}
Response
{"data": {"globalCustomSettings": "xyz789"}}

item

Description

Returns one item if it is available to the authenticated user

Response

Returns an Item

Arguments
Name Description
id - ID! The unique id of the item to find

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

Arguments
Name Description
id - ID! The unique id of the item to get the internally stored data for
identifier - String! An identifier for the stored data, e.g. 'com.example.mydata'

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]

Arguments
Name Description
id - ID! The unique id of the project to list items in
findQuery - String A Helix Plan find query, this field is optional

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

Response

Returns a Project

Arguments
Name Description
id - ID! The unique id of the project to find

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

Arguments
Name Description
projectID - ID! The unique id of the project to find the user in
userID - ID! The unique id of the user to find

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

Response

Returns a User

Arguments
Name Description
id - ID! The unique id of the user to find

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

Arguments
Name Description
projectID - ID! The unique id of the project to the workflow in find
id - ID! The unique id of the workflow to find

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"}}

addProjectUser

Description

Adds a user to a project

Response

Returns a Project!

Arguments
Name Description
projectID - ID! The id of the project to add the user to
userID - ID! The id of the user to add to the 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!

Arguments
Name Description
projectID - ID! The id of the project to add the user group to
userGroupID - ID! The id of the global user group to add to the 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

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

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"}}

deleteProject

Description

Deletes a project

Response

Returns an ID

Arguments
Name Description
id - ID! The unique id of the project to delete

Example

Query
mutation deleteProject($id: ID!) {
  deleteProject(id: $id)
}
Variables
{"id": "4"}
Response
{"data": {"deleteProject": 4}}

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

Response

Returns an ID!

Arguments
Name Description
userID - ID! The id of the user to delete

Example

Query
mutation deleteSdkUser($userID: ID!) {
  deleteSdkUser(userID: $userID)
}
Variables
{"userID": "4"}
Response
{"data": {"deleteSdkUser": 4}}

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

Response

Returns an ID!

Arguments
Name Description
userID - ID! The id of the user to delete

Example

Query
mutation deleteUser($userID: ID!) {
  deleteUser(userID: $userID)
}
Variables
{"userID": 4}
Response
{"data": {"deleteUser": "4"}}

deleteUserGroup

Description

Deletes a user group

Response

Returns an ID

Arguments
Name Description
id - ID! The unique id of the user group to delete

Example

Query
mutation deleteUserGroup($id: ID!) {
  deleteUserGroup(id: $id)
}
Variables
{"id": 4}
Response
{"data": {"deleteUserGroup": 4}}

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!

Arguments
Name Description
name - String! The name to uniquely identify the communication channel, e.g com.example.myintegration
description - String An optional description of the channel, for example the name of the organization or integration owning it

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!

Arguments
Name Description
id - ID! The unique identifier for the settings
settings - String! The settings to register

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!

Arguments
Name Description
projectID - ID! The id of the project to remove the user from
userID - ID! The id of the user to remove from the 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!

Arguments
Name Description
projectID - ID! The id of the project to remove the user group from
userGroupID - ID! The id of the user group to remove from the 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!

Arguments
Name Description
taskID - ID! The id of the task to set the date on
customFieldID - ID! The id of the date custom field. The id is an id of a DateCustomColumn
value - ISODate! The date to set on the task

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!

Arguments
Name Description
taskID - ID! The id of the task to set the decimal number on
customFieldID - ID! The id of the decimal number custom field. The id is an id of a DecimalNumberCustomColumn
value - Float! The decimal number to set on the task

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!

Arguments
Name Description
taskID - ID! The id of the task to set the hyperlink on
customFieldID - ID! The id of the hyperlink custom field. The id is an id of a HyperlinkCustomColumn
value - String! The hyperlink to set on the task

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!

Arguments
Name Description
taskID - ID! The id of the task to set the multiline text on
customFieldID - ID! The id of the multiline text custom field. The id is an id of a MultilinetextCustomColumn
value - String! The multiline text to set on the task

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!

Arguments
Name Description
taskID - ID! The id of the task to set the number on
customFieldID - ID! The id of the number custom field. The id is an id of a NumberCustomColumn
value - Int! The number to set on the task

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!

Arguments
Name Description
taskID - ID! The id of the task to set the text on
customFieldID - ID! The id of the text custom field. The id is an id of a TextCustomColumn
value - String! The text to set on the task

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!

Arguments
Name Description
itemID - ID! The id of the item to set the watching status on
watching - Boolean! The watching status to set for the authenticated user. True if the user should receive watch notification, false otherwise

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!

Arguments
Name Description
taskID - ID! The id of the task to set the workflow on
workflowID - ID! The id of the workflow to set on the 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

Response

Returns a User!

Arguments
Name Description
userID - ID! The id of the user to soft delete

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

Response

Returns a User!

Arguments
Name Description
userID - ID! The id of the user to soft delete

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

Response

Returns an ID!

Arguments
Name Description
id - ID! The unique identifier for the settings

Example

Query
mutation unregisterGlobalCustomSettings($id: ID!) {
  unregisterGlobalCustomSettings(id: $id)
}
Variables
{"id": "4"}
Response
{
  "data": {
    "unregisterGlobalCustomSettings": "4"
  }
}

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}}

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"
    }
  }
}

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
        }