Share this page

# Common flows and ER diagrams

This section provides common end-to-end flows and entity relationship (ER) diagrams for working with the REST API.

In this topic:

## Overview

Common, end-to-end flows demonstrate REST API calls that access multiple entities.

For demonstration purposes, the flows and entity relationship diagrams include both public and non-public (technical preview) resources.

Public and technical preview APIs

Public APIs | Technical Preview APIs
--- | ---
To access public resources, you do not need to send any additional headers; only the content-type header is necessary. For a list of public, supported resources, see Public resources. | Technical preview resources are subject to change until declared public. To access these resources, send requests with a header: Header: ALM-OCTANE-TECH-PREVIEW Value: true

Back to top

## Areas described in flows

The following table provides a list of flows and which areas are covered by each flow.

Flow | Relevant entities
--- | ---
Get my new user stories for a release | Backlog, stories, releases, sprints, My Work
Get opened defects that I must test for a sprint | Backlog, stories, releases, sprints, defects, My Work
Get the comments for my manual tests | Comments, My Work, manual tests and their runs, Gherkin tests and their runs, test suites and their runs
Add an attachment to a manual test script | Attachments, manual tests and their runs, Gherkin tests and their runs, test suites and their runs
Get and update Gherkin tests that are ready for automation | My Work, manual tests and their runs, Gherkin tests and their runs, test suites and their runs, backlog, stories, releases, sprints
Get a list of planned runs for manual tests, Gherkin tests, and test suites | My Work, manual tests and their runs, Gherkin tests and their runs, test suites and their runs, backlog, stories, releases, sprints
Get the environments for test results for specific releases | Manual tests and their runs, Gherkin tests and their runs, test suites and their runs, backlog, stories, releases, sprints
Get tagged automated tests associated with an application module | Automated tests and their runs, tags, environments, application modules
Get recent failed automated tests for a release | Automated tests and their runs, backlog, stories, releases, sprints
Get application modules whose tests recently failed | Automated tests and their runs, application modules
Get features whose automated tests recently failed | Automated tests and their runs, backlog, stories, releases, sprints
Get open, high-severity defects associated with any application module | Defects, application modules
Get closed defects associated with a failed test run | Automated tests and their runs, manual tests and their runs, Gherkin tests and their runs, test suites and their runs, application modules
Get open defects associated with a successful test run | Automated tests and their runs, manual tests and their runs, Gherkin tests and their runs, test suites and their runs, application modules
Report results from a pipeline | CI/CD integration
Failure results | CI/CD integration, automated tests and their runs, tags, environments, defects
Get failed runs by checking the run history | CI/CD integration, automated tests and their runs, and the special resource: Run history
Create a manual test run | Manual tests and their runs, Gherkin tests and their runs, test suites and their runs
Create a test suite with manual and Gherkin tests | Manual tests and their runs, Gherkin tests and their runs, test suites and their runs
Plan a test suite run | Manual tests and their runs, Gherkin tests and their runs, test suites and their runs
Add "test" tasks to work items that have none | Work items, tasks, list nodes
Mark stories done if tasks are completed | Manual tests
Mark features done if stories are completed | Work items
User-defined fields | Work items
Create a document report with descendants | Document reports

Back to top

https://admhelp.microfocus.com Software Delivery Management 8942
Tips to improve your search results... OpenText™ Software Delivery Management Help Center OpenText™ Software Delivery Management Help 26.1 All View Local Help Center View Online Help Center Version: