Common flows and ER diagrams

This section provides:

  • Common, end-to-end flows for working with the REST API. These flows demonstrate REST API calls that access multiple entities.

  • Entity relationship (ER) diagrams and descriptions about how the entities relate to each other. These ER diagrams are based on end-to-end flows.

Each flow includes:

  • A description of the flow.

    Unless indicated otherwise, the flow assumes the context of workspaces in an isolated space.

  • An ER diagram and a description of the diagram.

  • A list of the areas demonstrated in the flow, such as environments, defects, or CI/CD integration.

  • Key points and descriptions about the entities, relationships, and any filtering necessary for the flow.

  • In some cases, snippets of JavaScript that demonstrate relationships between, and how to access, the entities. A lik to the full source code is also provided.

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 Supported, 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

Matrix of ALM Octane areas described in flows

See this table for a list of flows and what ALM Octane areas covered by each flow.

Flow Relevent 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 to ALM Octane CI/CD integration
Report results (without pipeline context) to ALM Octane 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 Work items, tasks
Mark features done if stories are completed Work items