Entity relation diagrams and common flow samples

This section provides entity relationship diagrams and descriptions about how the entities relate to each other.

Note: Some resources are a technical preview. Until made public, send an HPECLIENTTYPE header with the value: HPE_REST_API_TECH_PREVIEW in your requests to try out the flows.

The entity relationship diagrams are based on end-to-end flows for working with the REST API. Each flow includes:

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

For a list of public, supported resources, see the ALM Octane Developer Guide.

Other resources are a technical preview, and subject to change until declared public.

Accessing public resources Accessing non-public resources
You do not need to send any additional headers; only the content-type header is necessary.

Send requests with a header:

Header:  HPECLIENTTYPE

Value: HPE_REST_API_TECH_PREVIEW

Flows

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

  Automated tests and runs Manual tests and runs Environments and tags CI/CD integration Backlog, stories, releases and sprints My work Defects Application modules Comments and attachments Special resources
Get my new user stories for a release                
Get opened defects that I must test for a sprint              
Get the comments for my manual tests              
Get and update Gherkin tests that are ready for automation                
Get a list of planned runs for manual tests, Gherkin tests, and suites              
Get the environments for test results for specific releases              
Get tagged automated tests associated with an application module              
Get recent failed automated tests for a release                
Get application modules whose tests recently failed                
Get features whose tests recently failed                
Get open, high-severity defects associated with any application module                
Get closed defects associated with a failed test run              
Get open defects associated with a successful test run              
Report results from a pipeline to ALM Octane                  
Report results (without pipeline context) to ALM Octane            
Get failed runs by checking the run history               Run history