RegoLink for Clarity PPM (Preview)

RegoLink Clarity PPM connector that allows organizations to integrate with Clarity PPM to read and load data through a robust mechanism of actions and validations

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
Flow Premium All Flow regions except the following:
     -   US Government (GCC)
PowerApps Premium All PowerApps regions except the following:
     -   US Government (GCC)

Note

Below documentation might be incomplete due to proprietary API functionality. Please follow RegoLink Flow Connector Documentation to obtain the user guide and connector definition.

Creating a connection

To connect your account, you will need the following information:

Name Type Description
Clarity PPM Password securestring

The Clarity PPM Password for this api

Clarity PPM URL | Clarity PPM User securestring

The Clarity PPM URL | Clarity PPM User for this api

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Execute Action

Performs a XOG operation with the parameters and field mappings provided

Run Query

Returns a list of all the records provided by the NSQL Query. Allows users to filter by the NSQL parameters and use all columns as part of the response.

Validate Lookup

Returns the lookup values for the parameters provided. Allows to validate a single value by ID or Label, or retrieve the list of all available values

Execute Action

Performs a XOG operation with the parameters and field mappings provided

Parameters

Name Key Required Type Description
Actions
actionID True string

Select Action

Action Dynamic Schema
dynamicActionSchema dynamic

Dynamic Schema of items in selected action

Returns

Execute Action Response (JSON)

response
ExecuteActionOK

Run Query

Returns a list of all the records provided by the NSQL Query. Allows users to filter by the NSQL parameters and use all columns as part of the response.

Parameters

Name Key Required Type Description
Queries
queryID True string

Select Query

Query DynamicValuesSchema
GetDynamicValuesSchema dynamic

Parameters/operations/order by/pagination of the selected query

Returns

The outputs of this operation are dynamic.

Validate Lookup

Returns the lookup values for the parameters provided. Allows to validate a single value by ID or Label, or retrieve the list of all available values

Parameters

Name Key Required Type Description
LookupType
LookupType True string

Select Lookup Type

Lookup
LookupId True string

Select Lookup

Operation
LookupFilterOperator True string

Select Operation

Label
Name string

Lookup Label

ID
Id string

Lookup ID

Return First Record Only
ReturnFirstRecord string

Return First Record Only

Returns

The outputs of this operation are dynamic.

Definitions

ExecuteActionOK

Execute Action Response (JSON)

Name Path Type Description
Failed
Failed integer

Number of failure records

Inserted
Inserted integer

Number of inserted records

Messages
Messages string

Response warning messages

Request
Request string

Request XML definition

Response
Response string

Response XML

Status
Status integer

Response Status (0: Failure - 1: Success - 2: Error)

Total
Total integer

Total number of records

Updated
Updated integer

Number of updated records