Generate Launch-in context URL

Owned by sneha.tripathi
Last updated: Jul 18, 2022 by Kishore Surisetty
2 min read

Luma Automation API 'Generate Launch-in context URL' is used to fetch the Automation URL with the workflow execution status. The URL provides a graphical representation of the current workflow execution status. It can be embedded into your application enabling the users to view the workflow execution status from the client application without the need to log in to the Luma Automation portal. Based on the Workflow Trigger ID, the web service retrieves the automation launch-in context URL with the temporary access key. You can launch the URL in an Iframe or new browser tab depending on the user experience required.

Use the following details to configure the API:

  1. Capture the tenant access token created during the Automation tenant provisioning. This token is sent as the Header to the API. Header → itas-api-access-key: <Tenant Access Token>.
    You can also use Regenerate Tenant Access Token API to regenerate and fetch the tenant access token.

  2. URI: /gateway/api/v1/launchincontexturl/generate

  3. HTTP Method for the operation: POST

  4. Send Content-Type: application/json as the Header to the API.

  5. Pass the following as Outbound Payload or Request to the Web Service. The request is passed in the following JSON format.

    1. triggerId: The Trigger ID is generated when the Workflow is Automation Workflow is triggered. You can use Trigger Workflow API to trigger the workflow and fetch the Trigger ID.

      { "launchContext": "WORKFLOW_EXECUTION_STATUS", "contextInfo": { "triggerId":"982dada1-331b-4292-aff9-fe5af7a5f7bb" //pass the triggered id captured from the response of trigger workflow API } }

  6. As a response, the web service generates an automation launch-in context URL with the temporary access key. Response from the web service is received in the following format:

    { "status": "Success", "statusCode": 0, "statusLine": "Successfully generated the launch in context URL.", "errors": null, "resultData": " http://itasdevops.automationsaqa1.com/execution/982dada1-331b-4292-aff9-fe5af7a5f7bb?esaAuthTempKey=sOQfST%2FmuHYPez%2B7XU1BnD7Qa%2FuB1vFwFclIZTr6d7bmKEyxkSHWlUqgKFwpDYLOqP29Ev8aaMRivtJFbdUE%2Fa6W1MhuTbMCIK%2B3C6w%2B9VXz9REnvDaHVayjMtF%2FL9PYyLNFoswQr1oQAVPmdbd%2BaYaWHGJuEzfTcJJyvDiEZ3m0yY47lpPevpuza8E4fZoGDgogb2w%2BRQOPDMJLkAo75g%3D%3D", // Use this automation URL to launch the execution status screen in Iframe or new browser tab. "warnings": [], "timestamp": 1646060754512, "reasonPhrase": null, "metaInfo": null }

    1. ‘status’ represents the execution status of the API call. Success represents that the web service operation was successfully executed.

    2. ‘statusCode’ represents the status code.

    3. ‘statusLine’ represents the response message received from the web service. The message "Successfully generated the launch in context URL." represents that the URL is successfully retrieved.

    4. ‘errors’ indicate the error received in case the web service execution fails.

    5. ‘resultData’ section contains the URL details. You can use this automation URL to launch the execution status screen in Iframe or a new browser tab.

    6. 'warnings’ field contains any warning received from web service execution.

    7. ‘timestamp’ represents the time (Epoch time) of web service execution.

    8. ‘reasonPhrase’ represents the error, in case web service execution fails.