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/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/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/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/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/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/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/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/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/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/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/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.