Deployment with pre-selected parameters

You can construct a URL with query parameters such as applicationId, environmentId, versionIds, and description, which can be embedded into the build applications. By using the URL, you can navigate directly to the deployment request page in HCL DevOps Deploy (Deploy) with the specified values pre-populated when the URL is accessed. This process eliminates the need for manual selection of deployment context and supports automation scenarios where consistent and repeatable deployments are required.

You must run the following API request for the scheduled deployment (pre-filled) form page:
GET https://{hostname}:{port}
/applicationId={value}&environmentId={environmentid}&versionIds={versionid}&Description={description}&onlyChanged={true}
The following URL is an example with default parameter values:
https://localhost:8443/?applicationId=abcd&environmentId=helloDeploy&versionIds=78e87602-cd9f-4937-8828-02eea631a615&description=Description updated from API&onlyChanged=true
The default built-in query parameters page corresponding to the application process deploy page is displayed. The following table provides a description and action to be performed for the default query parameters in the form:
Parameter Description and Action
applicationId Enter the application name. The application can be redundant.
environmentId Enter the environment name.
description (Optional) Enter the description of the deployment.
applicationProcessId Enter the application process name.
versionIds Displays the component version IDs.
snapshotId Displays the snapshot name.
onlyChanged Select True to select and False to clear the selection.
scheduleDateTime Select the Date and Time in the msec time stamp to schedule the deployment.
RecurrencePattern Select D for Daily, W for weekly, or M for Monthly recurrence pattern.
property/propertyname Select the property values to be associated with the deployment.

After entering the required parameters, you must replace the Deploy Run Applications Process page URL with the URL that includes these parameters page. You can see the Application Process Request page displayed with pre-filled deployment parameter values. You must verify the information and submit the process.

Note: The applicationId and applicationProcessId parameters are required to ensure that the versionIds or snapshotId and their properties load properly.