Query

Every GraphQL schema has a root type for both queries and mutations. The query type defines GraphQL operations that retrieve data from the server.

Fields

costRecords ([CostRecord])

queries for cost records

Argument Type Description
filter CostsFilterInput

The default value is {}.

orderBy CostOrder
costTypes ([CostTypeDescription])

Provides description for system wide cost types

Argument Type Description
filter CostTypeDescriptionFilterInput

The default value is {}.

currentUser (User)
license (License)

Provides license information for this server or the current cloud site

planVersion (ProjectPlanVersion)
Deprecation notice

use project->plan->version

Argument Type Description
id Long!
pool (Pool)
Argument Type Description
name String
id Long
pools ([Pool])
Argument Type Description
filter ResourceFilterInput

The default value is {}.

orderBy ResourceOrder
portfolio (Portfolio)

gets a portfolio given its id or name or the root portfolio

Argument Type Description
name String
id Long
portfolios ([Portfolio])
Argument Type Description
filter ProjectsFilterInput

The default value is {}.

orderBy ProjectOrder
project (Project)

gets a project given its id or name

Argument Type Description
name String
id Long
projectCriteria ([ProjectCriterion])
projectNode (ProjectNode)

gets a project node given its id

Argument Type Description
name String
id Long
projectNodes ([ProjectNode])

gets projects and portfolios using an optional filter

Argument Type Description
filter ProjectsFilterInput

The default value is {}.

orderBy ProjectOrder
projectStatus ([ProjectStatus])
projectWebhook (ProjectWebhook)

gets a webhook by its id

Argument Type Description
id String
projects ([Project])

gets projects using an optional filter

Argument Type Description
filter ProjectsFilterInput

The default value is {}.

orderBy ProjectOrder
resource (Resource)
Argument Type Description
name String
id Long
resourceNode (ResourceNode)
Deprecation notice

use pool or resource

Argument Type Description
name String
id Long
resourceNodes ([ResourceNode])
Argument Type Description
filter ResourceFilterInput

The default value is {}.

orderBy ResourceOrder
resources ([Resource])
Argument Type Description
filter ResourceFilterInput

The default value is {}.

orderBy ResourceOrder
rootPool (Pool)
Deprecation notice

use pool

rootPortfolio (Portfolio)
Deprecation notice

use portfolio

gets the root portfolio

template (Template)

gets a template given its id or name

Argument Type Description
name String
id Long
templates ([Template])
Argument Type Description
filter ProjectsFilterInput

The default value is {}.

orderBy ProjectOrder
timeRecords ([TimeRecord])

Query for work records

Argument Type Description
filter TimeFilterInput

The default value is {}.

orderBy TimeOrder
user (User)
Argument Type Description
name String
id Long
viewTypes ([ViewType])
Argument Type Description
type String
workRecords ([WorkRecord])

Query for work records

Argument Type Description
filter WorkFilterInput

The default value is {}.

orderBy WorkOrder