Govern API Call - Data360_DQ+ - Latest

Data360 DQ+ Help

Product type
Software
Portfolio
Verify
Product family
Data360
Product
Data360 DQ+
Version
Latest
Language
English
Product name
Data360 DQ+
Title
Data360 DQ+ Help
Copyright
2024
First publish date
2016
ft:lastEdition
2024-07-09
ft:lastPublication
2024-07-09T15:09:58.774265

The Govern API Call node enables you to connect to Data360 Govern by calling the Data360 Govern REST APIs.

Note: For the Govern API Call node to work, cross-origin resource sharing (CORS) needs to be configured in Data360 Govern. See the Data360 Govern Admin Guide > Customizing the application > Security - Cross-origin resource sharing for more details.
  1. By default, the Govern API Call node uses the URL specified on the Environments page to connect to Data360 Govern. To view this value:
    1. Navigate to Admin >Environments.
    2. Select the environment that contains the analysis with the Govern API Call node, or the environment where you plan to create an analysis with this node.
    3. Select the Govern tab.

      The ServerURL field displays the default value that will be used to connect to Data360 Govern, unless you choose to override this value when you configure the Govern API Call node.

  2. In an analysis, select the Govern API Call node. The Properties panel has four tabs:
    • Request - Configure the Request tab properties to define your request to the Data360 Govern REST service, see Request tab.
    • Response - Configure the Response tab properties to define the fields that will accept the contents of the response to the REST call, see Response tab.
    • Output - Configure the Output tab to choose input fields to include in the output, see Output tab.
    • Proxy - Configure the Proxy tab to enable a proxy configuration, see Proxy tab.
  3. When you have finished configuring the node properties, click Accept Changes.

Example

You want to retrieve a list of Data360 Govern assets for a specified asset type, and you want to filter this list to only include assets that are owned by a Business Steward.

  1. On the Request tab, ensure that the Govern Instance URL is populated. By default, this value is taken from the Govern settings on the Admin > Environments page.
  2. Click Build Call.
  3. Select the GET /api/v2/assets/{assetTypeUid} endpoint.
  4. Click OK to return to the analysis page.

    The Method and Path fields are automatically populated with the endpoint details and the assetTypeUid parameter is added to the Call Parameters grid.

  5. Select the assetTypeUid parameter, then click Edit to specify a UID value for the asset type that you want the call to retrieve.
  6. The GET /api/v2/assets/{assetTypeUid} endpoint has a number of optional query parameters. Click Add to choose a query parameter to filter the call. In this case, select the _ownedBy parameter and type a value of Business Steward to filter the call to only return assets that are owned by a Business Steward.

Properties

Request tab

Select the Request tab to define your request to the Data360 Govern REST service.

Govern Instance URL

By default, the Data360 Govern URL that is defined in the Govern Connection Configuration settings on the Admin > Environments page is used.

Select Override Environment Govern URL if you want to edit the URL. To substitute a variable or a property value, use the ${} syntax, see Value substitution. You can configure proxy settings if Override Environment Govern URL is selected.

Build Call

  1. Click Build Call to select the Data360 Govern API to call.

    You will see a list of the Data360 Govern REST API endpoints.

  2. Click Select to add an endpoint to the Selected Method on the right.
  3. Click OK.

    The Method and Path fields are automatically populated with the endpoint details.

    Any default parameters are added to the Call Parameters grid, except for _pageSize, _pageNum, and _includeTotals. The parameter type can be one of path, body or query.

    To specify a parameter value, select the parameter in the Call Parameters grid and click Edit.

    If an endpoint has optional query parameters, click Add if you want to filter the response by adding additional query parameters to the call. The Name field lists all available parameters that are supported by the selected API call, and will include parameters that did you did not previously configure, except for any parameters named _pageSize, _pageNum, or _includeTotals.

    Type a value for the parameter in the Value field. You can type an explicit value, or you can enter a substitutable variable or property by using the ${} syntax, see Value substitution.

Authorization

  1. Click the Edit button to open the Govern Authorization Values dialog.
  2. If you want to show the API Secret value in this dialog, select Show API Secret before entering the credentials. If you do not select Show API Secret, the value will be obfuscated.
  3. Enter your Data360 Govern credentials in the API Key and API Secret fields.

    To substitute a variable or a property value, use the ${} syntax, see Value substitution.

  4. Click Save.

Response tab

Select the Response tab to define the fields that will accept the contents of the response to the API call.

Status Field Name

Optionally, specify the name of the output field to contain the HTTP status code (an integer), for example Status. If left empty, the status code is not output. The name of the field must follow all field name restrictions and must not clash with any input field names or a field name generated by the transformation builder.

Body Field Name

Optionally, specify the name of the output field to contain the HTTP response body (a string), for example Body. If left empty, the body is not output. The name of the field must follow all field name restrictions and must not clash with any input field names or a field name generated by the transformation builder.

CAUTION:
You should only specify a value in the Body Field Name property if you want to use the response body in downstream nodes. If you are transforming the output in this node, then it is recommended that you do not specify a Body Field Name. Passing the body to downstream nodes can cause memory issues if the response is large.

Content Type Field Name

Optionally, specify the name of the output field to contain the HTTP response content type (a string), for example Type. If left empty, the content type is not output. The name of the field must follow all field name restrictions and must not clash with any input field names or a field name generated by the transformation builder.

Transform Response before Output

Select Transform Response before Output if you want to use the JSON transformation builder to transform the results of the REST call and produce the output fields. The Edit Transformations button is enabled when the Transform Response before Output option is selected.

The Govern API Call node performs similar processing to that done by the JSON Parser node. For more information, see Using the Transformation Builder.

Output tab

Select the Output tab to choose input fields to pass through to the output. In addition to any fields specified in this tab, the output will include any fields specified in the Response tab.

Proxy tab

When Override Environment Govern URL is selected on the Request tab, you can enable a proxy configuration.

URL

The URL to the proxy server.

Authentication

The authentication type.

Choose from the available options:None, Basic or Digest.

If you select Basic or Digest, you can also specify a Username and Password.

Value substitution

You can use the ${}syntax to substitute values in the URL and request body.

For example, if you have a field in your incoming data set called uid, you can specify the following URL:

https://example.data3sixty.com/api/v2/assets/${uid}

For each incoming record, the value found in the uid field is used for the REST API call for the record.

You can use this syntax to substitute environment properties, execution parameters, and field values. If there is a conflict caused by more than one parameter or value sharing the same name, the following order of precedence determines which value is substituted:

  1. Execution parameters
  2. Environment properties
  3. Fields

For example, if an execution parameter and an environment property have the same name, the value of the execution parameter is used. This means that if you have defined an environment property or field name that is the same as a Data360 DQ+ system execution parameter, the system execution parameter is used. Data360 DQ+ uses the following system execution parameters:

  • workId, processId
  • refStartTime, refStartTimeYear, refStartTimeMonth, refStartTimeDate
  • refEndTime, refEndTimeYear, refEndTimeMonth, refEndTimeDate
  • now, year, month, date
  • trigger
  • resultCode, resultDetail, resultType