OBJECT

Query

link GraphQL Schema definition

1type Query {
2
3# Returns the folder for the given projectId with the specified Path along with its child folders.
4#
5#
6# Arguments
7# projectId: the project id of the Folder.
8# testPlanId: the Test Plan id of the Folder.
9# path: the path of the Folder.
10getFolder(projectId: String, testPlanId: String, path: String!): FolderResults
11
12# Returns a Test by issueId.
13#
14#
15# Arguments
16# issueId: the id of the Test issue to be returned.
17getTest(issueId: String): Test
18
19# Returns multiple tests by jql, issue ids, project id or test type.
20#
21#
22# Arguments
23# jql: the jql that defines the search.
24# issueIds: the ids of the Test issues to be returned.
25# projectId: the id of the project of the Test issues to be returned.
26# testType: the Test Type of the Test issues to be returned.
27# modifiedSince: all tests modified after this date will be returned
28# limit: the maximum amount of Tests to be returned. The maximum is 100.
29# start: the index of the first item to return in the page of results (page offset).
30# folder: the folder information required to filter the Test issues to be returned.
31getTests(jql: String, issueIds: [String], projectId: String, testType: TestTypeInput, modifiedSince: String, limit: Int!, start: Int, folder: FolderSearchInput): TestResults
32
33# Returns a Precondition by issue id.
34#
35#
36# Arguments
37# issueId: the issue id of the Precondition to be returned.
38getPrecondition(issueId: String): Precondition
39
40# Returns multiple Preconditions by jql, issueIds, projectId or Precondition Type.
41#
42#
43# Arguments
44# jql: the jql that defines the search.
45# issueIds: the ids of the Precondition issues to be returned.
46# projectId: the id of the project of the Precondition issues to be returned.
47# preconditionType: the Precondition Type of the Precondition issues to be returned.
48# limit: the maximum amount of Preconditions to be returned. The maximum is 100.
49# start: the index of the first item to return in the page of results (page offset).
50# modifiedSince: all Preconditions modified after this date will be returned
51getPreconditions(jql: String, issueIds: [String], projectId: String, preconditionType: TestTypeInput, limit: Int!, start: Int, modifiedSince: String): PreconditionResults
52
53# Returns a Test Set by issueId
54#
55#
56# Arguments
57# issueId: the id of the Test Set issue to be returned.
58getTestSet(issueId: String): TestSet
59
60# Returns multiple Test Sets by jql, issueIds or projectId.
61#
62#
63# Arguments
64# jql: the jql that defines the search.
65# issueIds: the ids of the Test Set issues to be returned.
66# projectId: the id of the project of the Test Set issues to be returned.
67# limit: the maximum amount of Test Sets to be returned. The maximum is 100.
68# start: the index of the first item to return in the page of results (page offset).
69# modifiedSince: all test sets modified after this date will be returned
70getTestSets(jql: String, issueIds: [String], projectId: String, limit: Int!, start: Int, modifiedSince: String): TestSetResults
71
72# Returns a Test Plan by issue id.
73#
74#
75# Arguments
76# issueId: the issue id of the Test Plan issue to be returned.
77getTestPlan(issueId: String): TestPlan
78
79# Returns multiple Test Plans by jql, issue ids or project id.
80#
81#
82# Arguments
83# jql: the jql that defines the search.
84# issueIds: the ids of the Test Plan issues to be returned.
85# projectId: the id of the project of the Test Plan issues to be returned.
86# limit: the maximum amount of Test Plans to be returned. The maximum is 100.
87# start: the index of the first item to return in the page of results (page offset).
88# modifiedSince: all Test Plans modified after this date will be returned
89getTestPlans(jql: String, issueIds: [String], projectId: String, limit: Int!, start: Int, modifiedSince: String): TestPlanResults
90
91# Returns a Test Execution by issue id.
92#
93#
94# Arguments
95# issueId: the id of the Test Plan issue to be returned.
96getTestExecution(issueId: String): TestExecution
97
98# Returns multiple Test Executions by jql, issue ids or project id.
99#
100#
101# Arguments
102# jql: the jql that defines the search.
103# issueIds: the ids of the Test Executions issues to be returned.
104# projectId: the id of the project of the Test Execution issues to be returned.
105# limit: the maximum amount of Test Executions to be returned. The maximum is 100.
106# start: the index of the first item to return in the page of results (page offset).
107# modifiedSince: all Test Executions modified after this date will be returned
108getTestExecutions(jql: String, issueIds: [String], projectId: String, limit: Int!, start: Int, modifiedSince: String): TestExecutionResults
109
110# Returns a Test Run by Test issue id and Test Execution issue id.
111#
112# Arguments
113# testIssueId: the issue id of the Test of the Test Run.
114# testExecIssueId: the issue id of the Test Execution of the Test Run.
115getTestRun(testIssueId: String, testExecIssueId: String): TestRun
116
117# Returns a Test Run by id.
118#
119# Arguments
120# id: the id of the Test Run.
121getTestRunById(id: String): TestRun
122
123# Returns multiple Test Runs testIssueIds and/or testExecIssueIds.
124#
125#
126# Arguments
127# testIssueIds: the issue ids of the Test of the Test Runs.
128# testExecIssueIds: the issue ids of the Test Execution of the Test Runs.
129# testRunAssignees: the user account ids of the assignee of the Test Runs.
130# limit: the maximum amount of Test Runs to be returned. The maximum is 100.
131# start: the index of the first item to return in the page of results (page offset).
132# modifiedSince: all TestRuns modified after this date will be returned
133getTestRuns(testIssueIds: [String], testExecIssueIds: [String], testRunAssignees: [String], limit: Int!, start: Int, modifiedSince: String): TestRunResults
134
135# Returns multiple Test Runs by id.
136#
137# Arguments
138# ids: the ids of the Test Runs.
139# limit: the maximum amount of Test Runs to be returned. The maximum is 100.
140# start: the index of the first item to return in the page of results (page offset).
141getTestRunsById(ids: [String], limit: Int!, start: Int): TestRunResults
142
143# Returns a Status by Test Run Step Status name.
144#
145# Arguments
146# name: the status name of test run step status
147getStepStatus(name: String): StepStatus
148
149# Returns a Status by Test Run Status name.
150#
151# Arguments
152# name: the status name of Test Run Status
153getStatus(name: String): Status
154
155# Returns all Test Run Status.
156getStatuses: [Status]
157
158# Returns all Test Run Step Status.
159getStepStatuses: [StepStatus]
160
161# Returns the Project Settings of a Project.
162#
163# Arguments
164# projectIdOrKey: Project Id
165getProjectSettings(projectIdOrKey: String): ProjectSettings
166
167# Returns the Issue Link Types
168getIssueLinkTypes: [IssueLinkType]
169
170}