Share this page

# Working with timelines

You use the timeline API to query the phases of an entity’s timeline.

In this topic:

## Overview

A timeline helps you track and analyze a release's progress and its quality.

The timeline API call lets you query an entity to learn more about its progress. A common use of this API is to measure the cycle time and waste statistics. The timeline API is also supported for OData.

The syntax for using this API is:

1. Call the timeline API.

   `.../api/shared_spaces/<shared-space-id>/workspaces/<workspace-id>/timelines?`

2. Specify the entity whose timeline you want to query.

   `&$select=<entity_name1,entity_name2>`

3. Add a filter to show results for a specific case.

   `&$filter=(<field>/<type> eq 'expression1' and 'expression2')`

The request will return all records in the timeline per phase, and the waste time within the phase, if waste time was included in the request.

Note: The timeline API does not support the greater or less than operators. Instead use a filter within ALM Octane after you retrieve all instances.

Back to top

## Example

The following example extracts the cycle time of all instances of the intesting phase for feature 2003.

    GET.../api/shared_spaces/1001/workspaces/1002/timelines?

    $expand=owner_work_item($select=id),phase($select=logical_name)&

    $select=cycle_time,owner_work_item&

    $filter=(phase/logical_name eq 'phase.feature.intesting'and owner_work_item/id eq '2003')

Back to top

See also:

- Working with entities

- Timeline view

https://admhelp.microfocus.com ALM Octane 8942
Tips to improve your search results... ALM Octane Help Center ALM Octane Help 23.4-24.3 All View Local Help Center View Online Help Center Version: