Make API Call activity - Precisely Data Integrity Suite

Data Integrity Suite
Product
Spatial_Analytics
Data_Integration
Data_Enrichment
Data_Governance
Precisely_Data_Integrity_Suite
geo_addressing_1
Data_Observability
Data_Quality
dis_core_foundation
Services
Spatial Analytics
Data Integration
Data Enrichment
Data Governance
Geo Addressing
Data Observability
Data Quality
Core Foundation
ft:title
Data Integrity Suite
ft:locale
en-US
PublicationType
pt_product_guide
copyrightfirst
2000
copyrightlast
2026

The Make API Call activity enables workflows within Data Integrity Suite to interact with external APIs. This allows you to seamlessly connect with external systems and supports the automation of processes such as opening tickets, sending notifications, or handling resources on third-party platforms.

The purpose of the Make API Call activity is to include an API request and response as a single step within a workflow, extending workflows beyond internal steps to support dynamic and responsive process automation.

Configure the request

Set up the API request details including the URI, HTTP method, headers, and body. The request section defines how your workflow will communicate with the external API endpoint.

  1. Enter the URI of the external API endpoint in the URI field.
    The URI must start with a protocol prefix, such as http:// or https://. You can use the Insert token button to include variables in the URI, as needed. When the workflow runs, tokens are replaced with their value.
  2. Select the HTTP method in the Method field.
    This defines the type of action the request will perform on the specified URI. Choose from:
    • GET
    • POST
    • PATCH
    • PUT
    • DELETE
  3. Add any additional request headers in the Header (optional) field, as needed.
    The default Content-Type: application/json header is added automatically.
  4. Enter the request body in the Body (optional) field, depending on the selected method.
    The body is required for methods such as POST, PATCH, and PUT, but optional for GET and DELETE.

Configure the connection

Set up authentication and authorization for the external API. The connection section defines how your workflow authenticates with the external API based on its security requirements.

Select the appropriate authorization type in the Authorization Type field.
Choose the option that matches the security requirements of the external API you are connecting to:
  • None: Choose this option if the API does not require any authentication or authorization.
  • OAuth2: Choose this option if the API uses OAuth 2.0 protocol for secure authorization, typically involving an access token obtained through an OAuth flow.
  • Token: Choose this option if the API requires a static token for authentication.

Define outputs

Configure the outputs that will be available as variables in downstream workflow activities. The Outputs tab lists the outputs that will be available as variables in downstream workflow activities. These are the standard outputs:

  • Status code
  • Response body
  • Response headers
  1. Upload a sample response payload to identify custom single-value outputs.
  2. Custom outputs are extracted from the sample payload and made available for use in subsequent workflow steps.

Example: Create a Jira ticket

The exact settings required to configure the Make API Call activity vary depending on the external API you are connecting to. The Make API Call activity accommodates various HTTP methods, custom headers, and payloads for versatile applications. Embedding API calls reduces manual effort and improves operational efficiency within workflows.

This example shows how to send a POST request to the Jira API to create a new Jira ticket.

Configure the request details

Set up the request to send ticket information to your Jira instance.

  1. Enter a URI that points to your Jira instance and the specific API endpoint in the URI field.
    For example: https://example.atlassian.net/rest/api/3/issue/
  2. Select POST in the Method field.
    This sends the necessary ticket information to your Jira instance.
  3. Use JSON in the Body (optional) field to reference the Jira project key and fields.
    For example: 
    {
  "fields": {
      "project":
      {
        "key": "TEST"
      },
      "summary": "Data quality issue",
      "description": "A data quality issue has been raised in Data Integrity Suite.",
      "issuetype": {
        "name": "Bug"
      }
  }
}
    This creates a new Jira bug in the "TEST" project, with a summary and description that matches the information included in the request body.

Configure the connection

Set up authentication for your Jira instance.

Select the appropriate authorization method in the Authorization Type field based on your Jira instance's security configuration.
Depending on the choice, you'll need to provide specific credentials or tokens.

  • None: No additional information is required. Use this only if your Jira instance does not require authentication (rare).

  • Token: Provide a static API token or personal access token to authenticate your requests. For Jira Cloud, you can generate a personal access token from your Atlassian account under "Security" settings. Store your token securely as it grants access to your Jira resources.

    Note: Ensure that the token has the necessary permissions to perform the API actions you require.

  • OAuth2: If you choose this option, you will need to set up an OAuth 2.0 client in Jira and obtain the following:

    • URI: The authorization server's endpoint URL where the OAuth2 authorization request is sent. This is typically provided by your OAuth provider or Jira's OAuth configuration.
    • Client ID: The unique identifier assigned to your application during OAuth client registration. It tells the authorization server which application is requesting access.
    • Client secret: The secret key associated with your OAuth client registration. It is used to authenticate your application with the authorization server and should be kept secure.
    • Scope: The permissions or access levels that your application is requesting. For example, in Jira, this might include permissions such as read:issue or write:issue.
      Note: OAuth setup might require coordination with your Jira administrator or OAuth provider.

Define custom outputs

Extract custom outputs from the Jira API response.

Upload a sample response payload to identify custom single-value outputs. For example: 
{
  "issue": {
    "startdate": "Mon, 08 Sep 2025 16:06:00 GMT",
    "id": "GOV-12345",
    "summary": "This is the summary"
  },
  "epic": {
    "id": "GOV-21211"
  }
}
This sample payload creates these custom outputs:
  • issue.startdate
  • issue.id
  • issue.summary
  • epic.id