This document covers the HTTP/REST based API of Klaros-Testmanagement.

Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

path methods description
  • /api/v1/resources/attachments
  • GET
Returns the global list of attachments.
  • /api/v1/resources/attachments/id/{id}
  • GET
Returns the newest version of an attachment by its id.
  • /api/v1/resources/attachments/id/{id}/data
  • GET
Returns the binary attachment data by id.
  • /api/v1/resources/attachments/id/{id}/data/version/{version}
  • GET
Returns an attachment by its id and version number.
  • /api/v1/resources/iterations
  • GET
Returns the global list of iterations.
  • /api/v1/resources/iterations/id/{id}
  • GET
Returns an iteration by its id.
  • /api/v1/resources/iterations/id/{id}/attachments
  • GET
This service provides methods for retrieving test iterations.
  • /api/v1/resources/iterations/id/{id}/jobs
  • GET
Returns the list of jobs assigned to the specified iteration.
  • /api/v1/resources/iterations/id/{id}/requirements
  • GET
Returns the list of requirements assigned to the specified iteration.
  • /api/v1/resources/iterations/id/{id}/systemsUnderTest
  • GET
Returns the list of systems under test assigned to the specified iteration.
  • /api/v1/resources/iterations/id/{id}/testEnvironments
  • GET
Returns the list of test environments assigned to the specified iteration.
  • /api/v1/resources/iterations/id/{id}/testRuns
  • GET
Returns the list of test runs executed in the specified iteration.
  • /api/v1/resources/iterations/projectId/{projectId}
  • GET
Returns the list of iterations for for the specified project.
  • /api/v1/resources/iterations/projectId/{projectId}/name/{name}
  • GET
Returns the iteration for the specified project id and name.
  • /api/v1/resources/iterations/projectName/{projectName}
  • GET
Returns the list of iterations for the specified project.
  • /api/v1/resources/iterations/projectName/{projectName}/name/{name}
  • GET
Returns the iteration for the specified project name and name.
  • /api/v1/resources/jobs
  • GET
Returns the global list of jobs.
  • /api/v1/resources/jobs/id/{id}
  • GET
Returns a job by its id.
  • /api/v1/resources/jobs/id/{id}/attachments
  • GET
This service provides methods for retrieving test jobs.
  • /api/v1/resources/jobs/id/{id}/subJobs
  • GET
Returns the list of sub jobs of the specified job.
  • /api/v1/resources/jobs/id/{id}/testCases
  • GET
Returns the list of test cases assigned to this job.
  • /api/v1/resources/jobs/id/{id}/testRuns
  • GET
Returns the list of test runs of this job.
  • /api/v1/resources/jobs/id/{id}/testSuites
  • GET
Returns the list of test suites assigned to this job.
  • /api/v1/resources/jobs/projectId/{projectId}
  • GET
Returns the list of jobs for the specified project.
  • /api/v1/resources/jobs/projectId/{projectId}/name/{name}
  • GET
Returns the job for the specified project id and name.
  • /api/v1/resources/jobs/projectName/{projectName}
  • GET
Returns the list of jobs for the specified project.
  • /api/v1/resources/jobs/projectName/{projectName}/name/{name}
  • GET
Returns the job for the specified project name and name.
  • /api/v1/resources/projects
  • GET
Returns the list of projects.
  • /api/v1/resources/projects/id/{id}
  • GET
Returns an project by its id.
  • /api/v1/resources/projects/id/{id}/attachments
  • GET
This service provides methods for retrieving test projects.
  • /api/v1/resources/projects/id/{id}/iterations
  • GET
Returns the iterations of the specified project.
  • /api/v1/resources/projects/id/{id}/jobs
  • GET
Returns the jobs of the specified project.
  • /api/v1/resources/projects/id/{id}/requirements
  • GET
Returns the requirements of the specified project.
  • /api/v1/resources/projects/id/{id}/systemsUnderTest
  • GET
Returns the systems under test of the specified project.
  • /api/v1/resources/projects/id/{id}/testCases
  • GET
Returns the test cases of the specified project.
  • /api/v1/resources/projects/id/{id}/testEnvironments
  • GET
Returns the test environments of the specified project.
  • /api/v1/resources/projects/id/{id}/testRuns
  • GET
Returns the test runs of the specified project.
  • /api/v1/resources/projects/id/{id}/testSegments
  • GET
Returns the test segments of the specified project.
  • /api/v1/resources/projects/id/{id}/testSuites
  • GET
Returns the test suites of the specified project.
  • /api/v1/resources/projects/name/{name}
  • GET
Returns an project by name.
  • /api/v1/resources/requirements
  • GET
Returns the global list of requirements.
  • /api/v1/resources/requirements/id/{id}
  • GET
Returns a requirement by its id.
  • /api/v1/resources/requirements/id/{id}/attachments
  • GET
This service provides methods for retrieving test requirements.
  • /api/v1/resources/requirements/id/{id}/iterations
  • GET
Returns the iterations the specified requirement belongs to.
  • /api/v1/resources/requirements/id/{id}/testCases
  • GET
Returns the test cases assigned to the specified requirement.
  • /api/v1/resources/requirements/projectId/{projectId}
  • GET
Returns the list of requirements for the specified project.
  • /api/v1/resources/requirements/projectId/{projectId}/name/{name}
  • GET
Returns the requirements for the specified project id and name. Multiple revisions of the same requirement may be returned here.
  • /api/v1/resources/requirements/projectId/{projectId}/name/{name}/revisionId/{revisionId}
  • GET
Returns the requirement for the specified project id, name and revision id.
  • /api/v1/resources/requirements/projectName/{projectName}
  • GET
Returns the list of requirements for the specified project.
  • /api/v1/resources/requirements/projectName/{projectName}/name/{name}
  • GET
Returns the requirements for the specified project name and name. Multiple revisions of the same requirement may be returned here.
  • /api/v1/resources/requirements/projectName/{projectName}/name/{name}/revisionId/{revisionId}
  • GET
Returns the requirement for the specified project name, name and revision id.
  • /api/v1/resources/systemsUnderTest
  • GET
Returns the global list of systems under test.
  • /api/v1/resources/systemsUnderTest/id/{id}
  • GET
Returns a system under test by its id.
  • /api/v1/resources/systemsUnderTest/id/{id}/attachments
  • GET
This service provides methods for retrieving systems under test.
  • /api/v1/resources/systemsUnderTest/id/{id}/iterations
  • GET
Returns the iterations this system under test is assigned to.
  • /api/v1/resources/systemsUnderTest/id/{id}/testRuns
  • GET
Returns the test runs executed for this system under test.
  • /api/v1/resources/systemsUnderTest/projectId/{projectId}
  • GET
Returns the list of systems under test for the specified project.
  • /api/v1/resources/systemsUnderTest/projectId/{projectId}/name/{name}
  • GET
Returns the system under test for the specified project id and name.
  • /api/v1/resources/systemsUnderTest/projectName/{projectName}
  • GET
Returns the list of systems under test for the specified project.
  • /api/v1/resources/systemsUnderTest/projectName/{projectName}/name/{name}
  • GET
Returns the system under test for the specified project name and name.
  • /api/v1/resources/testCaseResults
  • GET
Returns the global list of test case results.
  • /api/v1/resources/testCaseResults/envId/{envId}
  • GET
Returns the list of test case results for the specified test environment.
  • /api/v1/resources/testCaseResults/id/{id}
  • GET
Returns a test case by its id.
  • /api/v1/resources/testCaseResults/id/{id}/attachments
  • GET
This service provides methods for retrieving test case results.
  • /api/v1/resources/testCaseResults/iterationId/{iterationId}
  • GET
Returns the list of test case results for the specified iteration.
  • /api/v1/resources/testCaseResults/projectId/{projectId}
  • GET
Returns the list of test case results for the specified project.
  • /api/v1/resources/testCaseResults/projectId/{projectId}/name/{name}
  • GET
Returns the test case result for the specified project id and name.
  • /api/v1/resources/testCaseResults/projectName/{projectName}
  • GET
Returns the list of test case results for the specified project.
  • /api/v1/resources/testCaseResults/projectName/{projectName}/name/{name}
  • GET
Returns the test case result for the specified project name and name.
  • /api/v1/resources/testCaseResults/sutId/{sutId}
  • GET
Returns the list of test case results for the specified system under test.
  • /api/v1/resources/testCases
  • GET
Returns the global list of test cases.
  • /api/v1/resources/testCases/id/{id}
  • GET
Returns a test case by its id.
  • /api/v1/resources/testCases/id/{id}/attachments
  • GET
This service provides methods for retrieving test cases.
  • /api/v1/resources/testCases/projectId/{projectId}
  • GET
Returns the list of test cases for the specified project.
  • /api/v1/resources/testCases/projectId/{projectId}/name/{name}
  • GET
Returns the test cases for the specified project id and name. Multiple revisions of the same test case may be returned here.
  • /api/v1/resources/testCases/projectId/{projectId}/name/{name}/revisionId/{revisionId}
  • GET
Returns the test case for the specified project id, name and revision id.
  • /api/v1/resources/testCases/projectName/{projectName}
  • GET
Returns the list of test cases for the specified project.
  • /api/v1/resources/testCases/projectName/{projectName}/name/{name}
  • GET
Returns the test cases for the specified project name and name. Multiple revisions of the same test case may be returned here.
  • /api/v1/resources/testCases/projectName/{projectName}/name/{name}/revisionId/{revisionId}
  • GET
Returns the test case for the specified project name, name and revision id.
  • /api/v1/resources/testEnvironments
  • GET
Returns the global list of test environments.
  • /api/v1/resources/testEnvironments/id/{id}
  • GET
Returns a test environment by its id.
  • /api/v1/resources/testEnvironments/id/{id}/attachments
  • GET
This service provides methods for retrieving test environments.
  • /api/v1/resources/testEnvironments/id/{id}/iterations
  • GET
Returns the list of iterations this test environment is assigned to.
  • /api/v1/resources/testEnvironments/id/{id}/testRuns
  • GET
Returns the test runs executed in this test environment.
  • /api/v1/resources/testEnvironments/projectId/{projectId}
  • GET
Returns the list of test environments for the specified project.
  • /api/v1/resources/testEnvironments/projectId/{projectId}/name/{name}
  • GET
Returns the test environment for the specified project id and name.
  • /api/v1/resources/testEnvironments/projectName/{projectName}
  • GET
Returns the list of test environments for the specified project.
  • /api/v1/resources/testEnvironments/projectName/{projectName}/name/{name}
  • GET
Returns the test environment for the specified project name and name.
  • /api/v1/resources/testRuns
  • GET
Returns the global list of test runs.
  • /api/v1/resources/testRuns/envId/{envId}
  • GET
Returns the list of test runs for the specified test environment.
  • /api/v1/resources/testRuns/id/{id}
  • GET
Returns a test run by its id.
  • /api/v1/resources/testRuns/id/{id}/attachments
  • GET
This service provides methods for retrieving test runs.
  • /api/v1/resources/testRuns/id/{id}/testCaseResults
  • GET
Returns the test case results of the specified test run.
  • /api/v1/resources/testRuns/iterationId/{iterationId}
  • GET
Returns the list of test runs for the specified iteration.
  • /api/v1/resources/testRuns/projectId/{projectId}
  • GET
Returns the list of test runs for the specified project.
  • /api/v1/resources/testRuns/projectId/{projectId}/name/{name}
  • GET
Returns the test run for the specified project id and name.
  • /api/v1/resources/testRuns/projectName/{projectName}
  • GET
Returns the list of test runs for the specified project.
  • /api/v1/resources/testRuns/projectName/{projectName}/name/{name}
  • GET
Returns the test run for the specified project name and name.
  • /api/v1/resources/testRuns/sutId/{sutId}
  • GET
Returns the list of test runs for the specified system under test.
  • /api/v1/resources/testSegments
  • GET
Returns the list of test segments.
  • /api/v1/resources/testSegments/id/{id}
  • GET
Returns a test segment by its id.
  • /api/v1/resources/testSegments/id/{id}/attachments
  • GET
This service provides methods for retrieving test segments.
  • /api/v1/resources/testSegments/projectId/{projectId}
  • GET
Returns the list of test segments for a specific project.
  • /api/v1/resources/testSegments/projectId/{projectId}/name/{name}
  • GET
Returns the test segment for the specified project id and name.
  • /api/v1/resources/testSegments/projectName/{projectName}
  • GET
Returns the list of test segments for the specified project.
  • /api/v1/resources/testSegments/projectName/{projectName}/name/{name}
  • GET
Returns the test segment for the specified project name and name.
  • /api/v1/resources/testSuiteResults
  • GET
Returns the list of test suite results.
  • /api/v1/resources/testSuiteResults/envId/{envId}
  • GET
Returns the list of test suite results for the specified test environment.
  • /api/v1/resources/testSuiteResults/id/{id}
  • GET
Returns a test suite result by its id.
  • /api/v1/resources/testSuiteResults/id/{id}/attachments
  • GET
This service provides methods for retrieving test suite results.
  • /api/v1/resources/testSuiteResults/id/{id}/testCaseResults
  • GET
Returns the list of test case results for the specified test suite result.
  • /api/v1/resources/testSuiteResults/iterationId/{iterationId}
  • GET
Returns the list of test suite results for the specified iteration.
  • /api/v1/resources/testSuiteResults/projectId/{projectId}
  • GET
Returns the list of test suite results for the specified project.
  • /api/v1/resources/testSuiteResults/projectId/{projectId}/name/{name}
  • GET
Returns the test suite result for the specified project id and name.
  • /api/v1/resources/testSuiteResults/projectName/{projectName}
  • GET
Returns the list of test suite results for the specified project.
  • /api/v1/resources/testSuiteResults/projectName/{projectName}/name/{name}
  • GET
Returns the test suite result for the specified project name and name.
  • /api/v1/resources/testSuiteResults/sutId/{sutId}
  • GET
Returns the list of test suite results for the specified system under test.
  • /api/v1/resources/testSuites
  • GET
Returns the list of test suites.
  • /api/v1/resources/testSuites/id/{id}
  • GET
Returns a test suite by its id.
  • /api/v1/resources/testSuites/id/{id}/attachments
  • GET
This service provides methods for retrieving test suites.
  • /api/v1/resources/testSuites/id/{id}/testCases
  • GET
Returns the test cases of the specified test suite.
  • /api/v1/resources/testSuites/projectId/{projectId}
  • GET
Returns the list of test suites for a specific project.
  • /api/v1/resources/testSuites/projectId/{projectId}/name/{name}
  • GET
Returns the test suites for the specified project id and name. Multiple revisions of the same test suite may be returned here.
  • /api/v1/resources/testSuites/projectId/{projectId}/name/{name}/revisionId/{revisionId}
  • GET
Returns the test suite for the specified project id, name and revision id.
  • /api/v1/resources/testSuites/projectName/{projectName}
  • GET
Returns the list of test suites for the specified project.
  • /api/v1/resources/testSuites/projectName/{projectName}/name/{name}
  • GET
Returns the test suites for the specified project name and name. Multiple revisions of the same test suite may be returned here.
  • /api/v1/resources/testSuites/projectName/{projectName}/name/{name}/revisionId/{revisionId}
  • GET
Returns the test suite for the specified project name, name and revision id.
  • /api/v1/resources/users
  • GET
Returns the list of users.
  • /api/v1/resources/users/id/{id}
  • GET
Returns a user by his or her id.
  • /api/v1/resources/users/id/{id}/attachments
  • GET
This service provides methods for retrieving users.
  • /api/v1/resources/users/name/{name}
  • GET
Returns a user by his or her name.
  • /api/v1/resources/users/username/{username}
  • GET
Returns a user by his or her Klaros username.

Data Types

JSON

type description
Attachment A binary attachment.
Attachments A collection of attachment objects.
CustomProperty A custom property of an object.
ErrorResponse The response message in case of an error.
Iteration A Klaros-Testmanagement project iteration.
Iterations A collection of iteration objects.
Job A Klaros-Testmanagement job.
JobComment A single job comment.
JobWork A single job work entry.
Jobs A collection of job objects.
LabeledObject The base class for user visible objects.
NamedEntity The base class for objects belonging to a project and containing custom properties.
PersistentObject The persistent object base class.
Project A Klaros-Testmanagement project.
Projects A collection of project objects.
Requirement A Klaros-Testmanagement requirement.
Requirements A collection of requirement objects.
Result The base class for result objects.
RevisionableEntity The base class for revisionable objects.
SystemUnderTest A Klaros-Testmanagement system under test.
SystemsUnderTest A collection of system under test objects.
TestCase A test case object.
TestCaseResult A test case result object.
TestCaseResults A collection of test case result objects.
TestCaseStep A single test case step.
TestCaseStepResult A test case step result object.
TestCases A collection of test case objects.
TestEnvironment A Klaros-Testmanagement test environment.
TestEnvironments A collection of test environment objects.
TestRun A test run object.
TestRuns A collection of test run objects.
TestSegment A single test case step.
TestSegments A collection of test segments.
TestSuite A test suite.
TestSuiteResult A test suite result object.
TestSuiteResults A collection of test suite result objects.
TestSuites A collection of test suite objects.
User A Klaros-Testmanagement user.
Users A collection of user objects.

XML

Namespace http://klaros-testmanagement.com/api/v1/resources
type description
errorResponse The response message in case of an error.
attachment A binary attachment.
attachments A collection of attachment objects.
iteration A Klaros-Testmanagement project iteration.
iterations A collection of iteration objects.
job A Klaros-Testmanagement job.
jobComment A single job comment.
jobWork A single job work entry.
jobs A collection of job objects.
project A Klaros-Testmanagement project.
projects A collection of project objects.
requirement A Klaros-Testmanagement requirement.
requirements A collection of requirement objects.
systemUnderTest A Klaros-Testmanagement system under test.
systemsUnderTest A collection of system under test objects.
testCase A test case object.
testCaseResult A test case result object.
testCaseResults A collection of test case result objects.
testCaseStep A single test case step.
testCaseStepResult A test case step result object.
testCases A collection of test case objects.
testEnvironment A Klaros-Testmanagement test environment.
testEnvironments A collection of test environment objects.
testRun A test run object.
testRuns A collection of test run objects.
testSegment A single test case step.
testSegments A collection of test segments.
testSuite A test suite.
testSuiteResult A test suite result object.
testSuiteResults A collection of test suite result objects.
testSuites A collection of test suite objects.
user A Klaros-Testmanagement user.
users A collection of user objects.
labeledObject The base class for user visible objects.
namedEntity The base class for objects belonging to a project and containing custom properties.
persistentObject The persistent object base class.
result The base class for result objects.
revisionableEntity The base class for revisionable objects.
customProperty A custom property of an object.