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 Precondition by issue id.
67#
68#
69# Arguments
70# issueId: the issue id of the Precondition to be returned.
71getPrecondition(issueId: String): Precondition
72
73# Returns multiple Preconditions by jql, issueIds, projectId or Precondition Type.
74#
75#
76# Arguments
77# jql: the jql that defines the search.
78# issueIds: the ids of the Precondition issues to be returned.
79# projectId: the id of the project of the Precondition issues to be returned.
80# preconditionType: the Precondition Type of the Precondition issues to be returned.
81# limit: the maximum amount of Preconditions to be returned. The maximum is 100.
82# start: the index of the first item to return in the page of results (page offset).
83# modifiedSince: all Preconditions modified after this date will be returned
84# folder: the folder information required to filter the Test issues to be returned.
85getPreconditions(
86jql: String,
87issueIds: [String],
88projectId: String,
89preconditionType: TestTypeInput,
90limit: Int!,
91start: Int,
92modifiedSince: String,
93folder: PreconditionFolderSearchInput
94): PreconditionResults
95
96# Returns a Test Set by issueId
97#
98#
99# Arguments
100# issueId: the id of the Test Set issue to be returned.
101getTestSet(issueId: String): TestSet
102
103# Returns multiple Test Sets by jql, issueIds or projectId.
104#
105#
106# Arguments
107# jql: the jql that defines the search.
108# issueIds: the ids of the Test Set issues to be returned.
109# projectId: the id of the project of the Test Set issues to be returned.
110# limit: the maximum amount of Test Sets to be returned. The maximum is 100.
111# start: the index of the first item to return in the page of results (page offset).
112# modifiedSince: all test sets modified after this date will be returned
113getTestSets(jql: String, issueIds: [String], projectId: String, limit: Int!, start: Int, modifiedSince: String): TestSetResults
114
115# Returns a Test Plan by issue id.
116#
117#
118# Arguments
119# issueId: the issue id of the Test Plan issue to be returned.
120getTestPlan(issueId: String): TestPlan
121
122# Returns multiple Test Plans by jql, issue ids or project id.
123#
124#
125# Arguments
126# jql: the jql that defines the search.
127# issueIds: the ids of the Test Plan issues to be returned.
128# projectId: the id of the project of the Test Plan issues to be returned.
129# limit: the maximum amount of Test Plans to be returned. The maximum is 100.
130# start: the index of the first item to return in the page of results (page offset).
131# modifiedSince: all Test Plans modified after this date will be returned
132getTestPlans(jql: String, issueIds: [String], projectId: String, limit: Int!, start: Int, modifiedSince: String): TestPlanResults
133
134# Returns a Test Execution by issue id.
135#
136#
137# Arguments
138# issueId: the id of the Test Execution issue to be returned.
139getTestExecution(issueId: String): TestExecution
140
141# Returns multiple Test Executions by jql, issue ids or project id.
142#
143#
144# Arguments
145# jql: the jql that defines the search.
146# issueIds: the ids of the Test Executions issues to be returned.
147# projectId: the id of the project of the Test Execution issues to be returned.
148# limit: the maximum amount of Test Executions to be returned. The maximum is 100.
149# start: the index of the first item to return in the page of results (page offset).
150# modifiedSince: all Test Executions modified after this date will be returned
151getTestExecutions(jql: String, issueIds: [String], projectId: String, limit: Int!, start: Int, modifiedSince: String): TestExecutionResults
152
153# Returns a Test Run by Test issue id and Test Execution issue id.
154#
155# Arguments
156# testIssueId: the issue id of the Test of the Test Run.
157# testExecIssueId: the issue id of the Test Execution of the Test Run.
158getTestRun(testIssueId: String, testExecIssueId: String): TestRun
159
160# Returns a Test Run by id.
161#
162# Arguments
163# id: the id of the Test Run.
164getTestRunById(id: String): TestRun
165
166# Returns multiple Test Runs testIssueIds and/or testExecIssueIds.
167#
168#
169# Arguments
170# testIssueIds: the issue ids of the Test of the Test Runs.
171# testExecIssueIds: the issue ids of the Test Execution of the Test Runs.
172# testRunAssignees: the user account ids of the assignee of the Test Runs.
173# limit: the maximum amount of Test Runs to be returned. The maximum is 100.
174# start: the index of the first item to return in the page of results (page offset).
175# modifiedSince: all TestRuns modified after this date will be returned
176getTestRuns(testIssueIds: [String], testExecIssueIds: [String], testRunAssignees: [String], limit: Int!, start: Int, modifiedSince: String): TestRunResults
177
178# Returns multiple Test Runs by id.
179#
180# Arguments
181# ids: the ids of the Test Runs.
182# limit: the maximum amount of Test Runs to be returned. The maximum is 100.
183# start: the index of the first item to return in the page of results (page offset).
184getTestRunsById(ids: [String], limit: Int!, start: Int): TestRunResults
185
186# Returns a Status by Test Run Step Status name.
187#
188# Arguments
189# name: the status name of test run step status
190getStepStatus(name: String): StepStatus
191
192# Returns a Status by Test Run Status name.
193#
194# Arguments
195# name: the status name of Test Run Status
196getStatus(name: String): Status
197
198# Returns all Test Run Status.
199getStatuses: [Status]
200
201# Returns all Test Run Step Status.
202getStepStatuses: [StepStatus]
203
204# Returns the Project Settings of a Project.
205#
206# Arguments
207# projectIdOrKey: Project Id
208getProjectSettings(projectIdOrKey: String): ProjectSettings
209
210# Returns the Issue Link Types
211getIssueLinkTypes: [IssueLinkType]
212
213}