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 test (with the call test steps expanded) by issue id and version id.
34#
35# Arguments
36# issueId: the id of the test issue to be returned.
37# versionId: the id of a Test version. If not given, will get the default Test version.
38getExpandedTest(issueId: String!, versionId: Int): ExpandedTest
39
40# Returns multiple tests (with the call test steps expanded) by jql, issue ids, project id or test type.
41#
42#
43#
44# Arguments
45# jql: the jql that defines the search.
46# issueIds: the ids of the Test issues with default Test versions to be returned. Cannot be used with tests.
47# tests: the ids of the Test versions and Tests. If not given Test Version, will get the default Test version. Cannot be used with issueIds.
48# projectId: the id of the project of the Test issues to be returned.
49# testType: the Test Type of the Test issues to be returned.
50# modifiedSince: all tests modified after this date will be returned
51# limit: the maximum amount of Tests to be returned. The maximum is 100.
52# start: the index of the first item to return in the page of results (page offset).
53# folder: the folder information required to filter the Test issues to be returned.
54getExpandedTests(
55jql: String,
56issueIds: [String],
57tests: [TestWithVersionInput],
58projectId: String,
59testType: TestTypeInput,
60modifiedSince: String,
61limit: Int!,
62start: Int,
63folder: FolderSearchInput
64): ExpandedTestResults
65
66# Returns a Coverable Issue by issueId.
67#
68#
69# Arguments
70# issueId: the id of the Coverable Issue to be returned.
71getCoverableIssue(issueId: String!): CoverableIssue
72
73# Returns multiple coverable issues by jql or issue ids.
74#
75# Arguments
76# jql: the jql that defines the search.
77# issueIds: the ids of the Coverable Issues to be returned.
78# limit: the maximum amount of Tests to be returned. The maximum is 100.
79# start: the index of the first item to return in the page of results (page offset).
80getCoverableIssues(jql: String, issueIds: [String], limit: Int!, start: Int): CoverableIssueResults
81
82# Returns a Dataset by its testIssueId.
83#
84# Arguments
85# testIssueId: The unique identifier of the Dataset to be returned.
86# testExecIssueId: (Optional) The unique identifier of the Test Execution.
87# testPlanIssueId: (Optional) The unique identifier of the Test Plan.
88# callTestIssueId: (Optional) The unique identifier of the Test Call.
89getDataset(testIssueId: String!, testExecIssueId: String, testPlanIssueId: String, callTestIssueId: String): Dataset
90
91# Returns multiple Datasets based on optional filters.
92#
93# Arguments
94# testIssueIds: Filter by test issue IDs.
95# testExecIssueIds: (Optional) Filter by Test ExecutionIds.
96# testPlanIssueIds: (Optional) Filter by Test PlanIds.
97getDatasets(testIssueIds: [String], testExecIssueIds: [String], testPlanIssueIds: [String]): [Dataset]
98
99# Returns a Precondition by issue id.
100#
101#
102# Arguments
103# issueId: the issue id of the Precondition to be returned.
104getPrecondition(issueId: String): Precondition
105
106# Returns multiple Preconditions by jql, issueIds, projectId or Precondition Type.
107#
108#
109# Arguments
110# jql: the jql that defines the search.
111# issueIds: the ids of the Precondition issues to be returned.
112# projectId: the id of the project of the Precondition issues to be returned.
113# preconditionType: the Precondition Type of the Precondition issues to be returned.
114# limit: the maximum amount of Preconditions to be returned. The maximum is 100.
115# start: the index of the first item to return in the page of results (page offset).
116# modifiedSince: all Preconditions modified after this date will be returned
117# folder: the folder information required to filter the Test issues to be returned.
118getPreconditions(
119jql: String,
120issueIds: [String],
121projectId: String,
122preconditionType: TestTypeInput,
123limit: Int!,
124start: Int,
125modifiedSince: String,
126folder: PreconditionFolderSearchInput
127): PreconditionResults
128
129# Returns a Test Set by issueId
130#
131#
132# Arguments
133# issueId: the id of the Test Set issue to be returned.
134getTestSet(issueId: String): TestSet
135
136# Returns multiple Test Sets by jql, issueIds or projectId.
137#
138#
139# Arguments
140# jql: the jql that defines the search.
141# issueIds: the ids of the Test Set issues to be returned.
142# projectId: the id of the project of the Test Set issues to be returned.
143# limit: the maximum amount of Test Sets to be returned. The maximum is 100.
144# start: the index of the first item to return in the page of results (page offset).
145# modifiedSince: all test sets modified after this date will be returned
146getTestSets(jql: String, issueIds: [String], projectId: String, limit: Int!, start: Int, modifiedSince: String): TestSetResults
147
148# Returns a Test Plan by issue id.
149#
150#
151# Arguments
152# issueId: the issue id of the Test Plan issue to be returned.
153getTestPlan(issueId: String): TestPlan
154
155# Returns multiple Test Plans by jql, issue ids or project id.
156#
157#
158# Arguments
159# jql: the jql that defines the search.
160# issueIds: the ids of the Test Plan issues to be returned.
161# projectId: the id of the project of the Test Plan issues to be returned.
162# limit: the maximum amount of Test Plans to be returned. The maximum is 100.
163# start: the index of the first item to return in the page of results (page offset).
164# modifiedSince: all Test Plans modified after this date will be returned
165getTestPlans(jql: String, issueIds: [String], projectId: String, limit: Int!, start: Int, modifiedSince: String): TestPlanResults
166
167# Returns a Test Execution by issue id.
168#
169#
170# Arguments
171# issueId: the id of the Test Execution issue to be returned.
172getTestExecution(issueId: String): TestExecution
173
174# Returns multiple Test Executions by jql, issue ids or project id.
175#
176#
177# Arguments
178# jql: the jql that defines the search.
179# issueIds: the ids of the Test Executions issues to be returned.
180# projectId: the id of the project of the Test Execution issues to be returned.
181# limit: the maximum amount of Test Executions to be returned. The maximum is 100.
182# start: the index of the first item to return in the page of results (page offset).
183# modifiedSince: all Test Executions modified after this date will be returned
184getTestExecutions(jql: String, issueIds: [String], projectId: String, limit: Int!, start: Int, modifiedSince: String): TestExecutionResults
185
186# Returns a Test Run by Test issue id and Test Execution issue id.
187#
188# Arguments
189# testIssueId: the issue id of the Test of the Test Run.
190# testExecIssueId: the issue id of the Test Execution of the Test Run.
191getTestRun(testIssueId: String, testExecIssueId: String): TestRun
192
193# Returns a Test Run by id.
194#
195# Arguments
196# id: the id of the Test Run.
197getTestRunById(id: String): TestRun
198
199# Returns multiple Test Runs testIssueIds and/or testExecIssueIds.
200#
201#
202# Arguments
203# testIssueIds: the issue ids of the Test of the Test Runs.
204# testExecIssueIds: the issue ids of the Test Execution of the Test Runs.
205# testRunAssignees: the user account ids of the assignee of the Test Runs.
206# limit: the maximum amount of Test Runs to be returned. The maximum is 100.
207# start: the index of the first item to return in the page of results (page offset).
208# modifiedSince: all TestRuns modified after this date will be returned
209getTestRuns(testIssueIds: [String], testExecIssueIds: [String], testRunAssignees: [String], limit: Int!, start: Int, modifiedSince: String): TestRunResults
210
211# Returns multiple Test Runs by id.
212#
213# Arguments
214# ids: the ids of the Test Runs.
215# limit: the maximum amount of Test Runs to be returned. The maximum is 100.
216# start: the index of the first item to return in the page of results (page offset).
217getTestRunsById(ids: [String], limit: Int!, start: Int): TestRunResults
218
219# Returns a Status by Test Run Step Status name.
220#
221# Arguments
222# name: the status name of test run step status
223getStepStatus(name: String): StepStatus
224
225# Returns a Status by Test Run Status name.
226#
227# Arguments
228# name: the status name of Test Run Status
229getStatus(name: String): Status
230
231# Returns all Test Run Status.
232getStatuses: [Status]
233
234# Returns all Test Run Step Status.
235getStepStatuses: [StepStatus]
236
237# Returns the Project Settings of a Project.
238#
239# Arguments
240# projectIdOrKey: Project Id
241getProjectSettings(projectIdOrKey: String): ProjectSettings
242
243# Returns the Issue Link Types
244getIssueLinkTypes: [IssueLinkType]
245
246}