RegoLink for Clarity PPM

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

Status: Preview

Tier: Premium

Version: 1.0

Actions:

Name	Summary
ExecuteAction_GetActions ()	Get Actions
ExecuteAction_GetParametersSchema (string actionID)	Get Action Parameters
ExecuteAction (string actionID, [Optional]ExecuteActionParameterDynamicActionSchema dynamicActionSchema)	Execute Action
LookupValidation_GetDynamicResponseSchema (string ReturnFirstRecord)	Get Dynamic Schema
LookupValidation_GetLookupFilterOperators ()	Get Lookup Filter Operations
LookupValidation_GetLookupTypes ()	Get Lookup Types
LookupValidation_GetLookups (string lookupType)	Get Lookups
LookupValidation_GetYesNo ()	Get First Record - Yes or No
ValidateLookup ([Optional]ValidateLookupParameterValidateLookupData validateLookupData)	Validate Lookup
Query_GetDynamicResponseSchema (string queryID)	Get Dynamic Query Response
Query_GetDynamicValuesSchema (string queryID)	Get Dynamic Query Configuration
Query_GetQueries ()	Get Queries
RunQuery (string queryID, [Optional]RunQueryParameterGetDynamicValuesSchema GetDynamicValuesSchema)	Run Query

Objects:

Name	Summary
DynamicResponseLookupValidationGetDynamicResponseOK	DynamicResponseLookupValidationGetDynamicResponseOK
DynamicResponseQueryGetDynamicResponseOK	DynamicResponseQueryGetDynamicResponseOK
ExecuteActionOK
ExecuteActionParameterDynamicActionSchema	Action Dynamic Schema
ExecuteAction_GetActionsResponseItem
LookupValidation_GetDynamicResponseSchemaResponse
RunQueryParameterGetDynamicValuesSchema	Query DynamicValuesSchema
SchemaOK	SchemaOK
ValidateLookupParameterValidateLookupData

Actions:

ExecuteAction_GetActions

Summary: Get Actions

Description: Returns a list of available actions

Syntax:

RegoLinkforClarityPPM.ExecuteAction_GetActions ()

Returns:

Type:array of (ExecuteAction_GetActionsResponseItem)

Summary: IdNameOK

Description: IdNameOK

ExecuteAction_GetParametersSchema

Summary: Get Action Parameters

Description: Returns a list of available parameters based on the selected action

Syntax:

RegoLinkforClarityPPM.ExecuteAction_GetParametersSchema (string actionID)

Parameters:

Name

Type

Summary

Required

Related Action

actionID

string

(Actions)

Select Action

True

Returns:

Type:SchemaOK

Summary: SchemaOK

Description: SchemaOK

ExecuteAction

Summary: Execute Action

Description: Performs a XOG operation with the parameters and field mappings provided

Syntax:

RegoLinkforClarityPPM.ExecuteAction (string actionID, [Optional]ExecuteActionParameterDynamicActionSchema dynamicActionSchema)

Parameters:

Name

Type

Summary

Required

Related Action

actionID

string

(Actions)

Select Action

True

ExecuteAction_GetActions

dynamicActionSchema

ExecuteActionParameterDynamicActionSchema

(Action Dynamic Schema)

Action Dynamic Schema

False

Returns:

Type:ExecuteActionOK

Description: Execute Action Response (JSON)

LookupValidation_GetDynamicResponseSchema

Summary: Get Dynamic Schema

Description: Returns the response schema definition depending on the Get First Record action. To allow for single or multiple records

Syntax:

RegoLinkforClarityPPM.LookupValidation_GetDynamicResponseSchema (string ReturnFirstRecord)

Parameters:

Name

Type

Summary

Required

Related Action

ReturnFirstRecord

string

(Return first record only)

Return first record only

True

Returns:

Type:LookupValidation_GetDynamicResponseSchemaResponse

LookupValidation_GetLookupFilterOperators

Summary: Get Lookup Filter Operations

Description: Returns the values for allowed operations. Values are: Equals, and Contains

Syntax:

RegoLinkforClarityPPM.LookupValidation_GetLookupFilterOperators ()

Returns:

Type:array of (ExecuteAction_GetActionsResponseItem)

Summary: IdNameOK

Description: IdNameOK

LookupValidation_GetLookupTypes

Summary: Get Lookup Types

Description: Returns a list of allowed lookup types. Values are: Static, and Dynamic Lookups

Syntax:

RegoLinkforClarityPPM.LookupValidation_GetLookupTypes ()

Returns:

Type:array of (ExecuteAction_GetActionsResponseItem)

Summary: IdNameOK

Description: IdNameOK

Description: Returns a list of lookups based on the type selected. By default all static lookups are available, and dynamic lookups will bring all NSQL queries containing the following columns and parameters: Name, ID

Syntax:

RegoLinkforClarityPPM.LookupValidation_GetLookups (string lookupType)

Parameters:

Name

Type

Summary

Required

Related Action

lookupType

string

(Lookup Type)

Select Lookup Type

True

Returns:

Type:array of (ExecuteAction_GetActionsResponseItem)

Summary: IdNameOK

Description: IdNameOK

LookupValidation_GetYesNo

Summary: Get First Record - Yes or No

Description: Returns the values for Get First Record Only operation, used in advanced properties

Syntax:

RegoLinkforClarityPPM.LookupValidation_GetYesNo ()

Returns:

Type:array of (ExecuteAction_GetActionsResponseItem)

Summary: IdNameOK

Description: IdNameOK

ValidateLookup

Summary: Validate Lookup

Description: 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

Syntax:

RegoLinkforClarityPPM.ValidateLookup ([Optional]ValidateLookupParameterValidateLookupData validateLookupData)

Parameters:

Name

Type

Summary

Required

Related Action

validateLookupData

ValidateLookupParameterValidateLookupData

Validate Lookup Response

False

Returns:

Type:DynamicResponseLookupValidationGetDynamicResponseOK

Summary: DynamicResponseLookupValidationGetDynamicResponseOK

Description: DynamicResponseLookupValidationGetDynamicResponseOK

Query_GetDynamicResponseSchema

Summary: Get Dynamic Query Response

Description: Returns a list of all the fields available for the selected query. Parameters will be shown for input, and fields will be used as part of the response

Syntax:

RegoLinkforClarityPPM.Query_GetDynamicResponseSchema (string queryID)

Parameters:

Name

Type

Summary

Required

Related Action

queryID

string

(Queries)

Select Query

True

Returns:

Type:DynamicResponseQueryGetDynamicResponseOK

Summary: DynamicResponseQueryGetDynamicResponseOK

Description: DynamicResponseQueryGetDynamicResponseOK

Query_GetDynamicValuesSchema

Summary: Get Dynamic Query Configuration

Description: Returns a list of all the parameters available for the selected query. Parameters will be shown for input, and fields will be used as part of the response

Syntax:

RegoLinkforClarityPPM.Query_GetDynamicValuesSchema (string queryID)

Parameters:

Name

Type

Summary

Required

Related Action

queryID

string

(Queries)

Select Query

True

Returns:

Type:SchemaOK

Summary: SchemaOK

Description: SchemaOK

Query_GetQueries

Summary: Get Queries

Description: Returns a list of all NSQL queries

Syntax:

RegoLinkforClarityPPM.Query_GetQueries ()

Returns:

Type:array of (ExecuteAction_GetActionsResponseItem)

Summary: IdNameOK

Description: IdNameOK

RunQuery

Summary: Run Query

Description: 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.

Syntax:

RegoLinkforClarityPPM.RunQuery (string queryID, [Optional]RunQueryParameterGetDynamicValuesSchema GetDynamicValuesSchema)

Parameters:

Name

Type

Summary

Required

Related Action

queryID

string

(Queries)

Select Query

True

Query_GetQueries

GetDynamicValuesSchema

RunQueryParameterGetDynamicValuesSchema

(Query DynamicValuesSchema)

Query DynamicValuesSchema

False

Returns:

Type:DynamicResponseQueryGetDynamicResponseOK

Summary: DynamicResponseQueryGetDynamicResponseOK

Description: DynamicResponseQueryGetDynamicResponseOK

DynamicResponseLookupValidationGetDynamicResponseOK

Summary: DynamicResponseLookupValidationGetDynamicResponseOK

Description: DynamicResponseLookupValidationGetDynamicResponseOK

Properties:

Name

Type

Summary

DynamicResponseQueryGetDynamicResponseOK

Summary: DynamicResponseQueryGetDynamicResponseOK

Description: DynamicResponseQueryGetDynamicResponseOK

Properties:

Name

Type

Summary

ExecuteActionOK

Summary:

Description: Execute Action Response (JSON)

Properties:

Name	Type	Summary
Failed	integer(int32) Failed	Number of failure records
Inserted	integer(int32) Inserted	Number of inserted records
Messages	string Messages	Response warning messages
Request	string Request	Request XML definition
Response	string Response	Response XML
Status	integer(int32) Status	Response Status (0: Failure - 1: Success - 2: Error)
Total	integer(int32) Total	Total number of records
Updated	integer(int32) Updated	Number of updated records

ExecuteActionParameterDynamicActionSchema

Summary: Action Dynamic Schema

Description: Action Dynamic Schema

Properties:

Name

Type

Summary

ExecuteAction_GetActionsResponseItem

Summary:

Description:

Properties:

Name

Type

Summary

string

Name

string

Name

LookupValidation_GetDynamicResponseSchemaResponse

Summary:

Description:

Properties:

Name

Type

Summary

RunQueryParameterGetDynamicValuesSchema

Summary: Query DynamicValuesSchema

Description: Query DynamicValuesSchema

Properties:

Name

Type

Summary

SchemaOK

Summary: SchemaOK

Description: SchemaOK

Properties:

Name

Type

Summary

ValidateLookupParameterValidateLookupData

Summary:

Description: Validate Lookup Response

Properties:

Name	Type	Summary
LookupType	string LookupType	Select Lookup Type
LookupId	string Lookup	Select Lookup
LookupFilterOperator	string Operation	Select Operation
Name	string Label	Lookup Label
Id	string ID	Lookup ID
ReturnFirstRecord	string Return First Record Only	Return First Record Only