Search

Programmatically Generating Orchestration Report URLs via API

Overview

This guide explains how to programmatically generate URLs for Functionize orchestration reports using the API. You can create two types of links: standard report URLs, which require users to be logged into Functionize, and public, shareable links that do not require a login.

How It Works

This section covers the API workflows for generating both standard and shareable links.

Generating Standard Report URLs (Requires Login)

Standard orchestration report URLs in the Functionize UI use a numeric ID, but the primary /orchestration API endpoint returns a hexadecimal ID. To construct the correct URL, you must first map the hexadecimal ID to the corresponding numeric ID.

  1. Make a GET request to the /orchestration endpoint to retrieve the list of your orchestrations. This will provide the hexadecimal deployment_id for each.
  2. Using the hexadecimal ID of the desired orchestration, make a GET request to the /orchestration/{orchestration_id}/group endpoint.
  3. In the JSON response from this second call, the id field will contain the required numeric orchestration ID.
  4. Construct the final URL using the numeric ID and the specific run ID in the following format: https://app.functionize.com/v1/orchestrations-report/{numeric_id}/{run_id}.

Generating Shareable Report Links (Public)

For sharing results with stakeholders who may not have a Functionize account, you can generate a public, token-based link. While there is no direct endpoint for this, you can generate the link using the orchestration CSV report endpoint.

  1. Make a GET request to the /orchestration/{orchestration_id}/csvreport endpoint. Use the hexadecimal orchestration ID for the {orchestration_id} parameter.
  2. In the JSON response body, locate the Details key.
  3. The value associated with the Details key is the complete, shareable URL for the orchestration report. This link can be accessed publicly without requiring a Functionize login.

Limitations

  • There is no single API endpoint that directly provides the numeric orchestration ID needed for standard UI URLs. A two-step process is required to map the hexadecimal ID to the numeric ID.
  • There is no dedicated API endpoint for generating shareable links. This functionality is available as part of the response from the /orchestration/{orchestration_id}/csvreport endpoint.

Related Information

To use the Functionize API, you must first generate an access token.

  1. Log in to your Functionize account.
  2. Click on your username in the user profile menu.
  3. Select API Documentation.
  4. Click on API Documents to open the Swagger interface.
  5. Under the Account Management section, you can generate a new token.