Share this page
Resources
This topic describes resource URI patterns and the public resource groups available through the REST API.
Resource types
| Type | URI pattern and workspace example |
|---|---|
| Collection |
URI pattern: Workspace example: |
| Item |
URI pattern: Workspace example: |
Public resources
The following public resources and custom entities can be accessed. You do not need to send any additional headers, other than the content-type header, when sending REST API requests. A comprehensive list of supported public resources and their details is available in the Interactive API client.
| Area | Resources |
|---|---|
| Metadata | Entity metadata reference, Field metadata reference |
| CI/CD | builds, ci_servers, pipelines, pipeline_runs, pipeline_nodes, ci_builds, scm_commits |
| Backlog | epics, features, stories, defects, tasks, work_items, work_item_roots, application_modules (also known as product_area), bdd_specs |
| Planning | releases, sprints, team_sprints, teams, phases, metaphases (GET only), transitions |
| Requirements | requirements, requirement_documents, requirement_folders, requirement_roots |
| Testing | tests, manual_tests, scenario_tests, gherkin_tests, test_suites, test_suite_link_to_automated_tests, test_suite_link_to_gherkin_tests, test_suite_link_to_manual_tests |
| Test runs | runs, automated_runs, manual_runs, suite_runs, run_steps, previous_runs |
| Users and workspaces | users, user_items, roles, workspaces, workspace_roles, workspace_users, user_tags (GET and POST) |
| Taxonomy and classification | taxonomy_category_nodes, taxonomy_item_nodes, taxonomy_nodes, list_nodes |
| Collaboration | timelines, attachments, comments |
| Custom entities | The collection names for custom entities keep the singular form. Example: entity_a, entity_b |
| Custom actions | sign_in, sign_out, steps, Automated test results API reference, Add vulnerability issues |
For the full list of resources, their features and relationships, see Entity metadata reference.
Non-public resources (technical preview)
Resources not listed above as public are subject to change until declared public. To access these resources, send REST API requests with a header:
Header: ALM-OCTANE-TECH-PREVIEW
Value: true
Two examples of technical preview resources are coverage and logs. For details, see Add coverage (technical preview) and Add a log (technical preview).
