Resources

Resources are identified by URIs, and can be either:

A strict set of request methods are allowed for a resource type. Resources support the JSON representation type.

Tip: For a comprehensive list of supported public resources and their details, see the description of the Interactive API client.

Supported, public resources

Public, supported resources include:

Metadata resources Generic resources CI/CD resources Custom resources
  • epics

  • features

  • stories

  • defects

  • list_nodes

  • product_areas (also known as application modules)

  • phases

  • transitions

  • users

  • roles

  • workspaces

  • workspace_users

  • builds

  • ci_servers

  • pipelines

  For documentation on the generic and CI/CD resources, see the Interactive API client.  

You do not need to send any additional headers (other than the content-type header) when sending REST API requests for public resources.

Non-public resources (in technical preview)

Resources not listed above as public are a technical preview, and subject to change until declared public. To access non-public resources, Send REST API requests with a header:

Header:  HPECLIENTTYPE

Value: HPE_REST_API_TECH_PREVIEW

Back to top

Resource hierarchy

Resources are built as a hierarchy of collections and instances.

Some resources are singleton resources, such as: test-results, sign_in, and sign_out.

Example: Start with a resource collection of humans. This collection contains resource instances of human. Since humans have limbs, every human contains a collection of limbs. This collection contains resource instances of limb. Since limbs have fingers, every limb contains a collection of fingers. This collection contains resource instances of finger.

humans
     human
          limbs
               limb
                    fingers
                         finger
                         finger
               limb
                    fingers
                         finger
                         finger
     human
          limbs
...

Back to top

Resource naming conventions

Back to top

See also: