Helix REST API Endpoints

Helix REST API Endpoints

The Helix ALM REST API has several endpoints that developers can use for interfacing with their organization’s Helix ALM instance. The wide variety of endpoints provide many possibilities for developers to create tools or scripts to aid in their organization’s workflow, with few limitations.

The REST API is available at:

				
					https://{organization}:{port}/helix-alm/api/v0/
				
			

and the Swagger UI interactive documentation tool is available at:

				
					https://{organization}:{port}
				
			

where {organization} is the address of the REST API server.
The address can be configured in the JSON configuration file of the REST API, typically located at:

				
					../Perforce/Helix ALM/helix-alm-rest-api/config/config.json
				
			

on the server that is running the Helix ALM instance.

To learn more or get help from our experts, contact us at your earliest convenience. We’re excited to see what you will build!

Good setup of your workflows

Good setup of your workflows

It’s always worth thinking about how you initially set up a system before using it, adding data, and later realizing that the initial work needs to be redone due to customizations. When setting up Helix ALM workflows, it is even more important to carefully plan the initial setup.

The workflow works like a state event machine, consisting of states and transitions (events), with these components linked to concrete data in the underlying database. As soon as data has been added to the database, the ability to change the workflow is severely limited, as existing states can no longer be removed, while improvements such as adding additional states and transitions are still possible.

We support you in setting up workflows and show you workarounds to ensure flexibility and scope for further changes.