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