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