GetKey

The GetKey activity is used to get the key for the REST APIs.

General

In the General tab, you can specify the activity name and a clarity connection.

The following table describes the fields in the General tab of the GetKey activity:

Field Module Property? Description
Name No Specifies the name to be displayed as the label for the activity in the process.
Clarity Connection Yes Click to select a Clarity Shared Resource.

If no matching Clarity connections are found, click Create Shared Resource to create one. See Creating a Clarity Shared Rescource for details.

Description

In the Description tab, you can enter a short description for the GetKey activity.

Input

There is no Input tab for GetKey activity.

Output

In the Output tab, you can find the operation results.

The following table describes the fields in the Output tab of the GetKey activity:

Output Item Data Type Description
key String Return the API key for the REST APIs.

Fault

In the Fault tab, you can find the error code and error message of the GetKey activity. See Error Codes for more detailed explanation of the errors.

The following table describes the errors in the Fault tab of the GetKey activity:

Error Schema Element Data Type Description
msg String The TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Clarity error message.
msgCode String The TIBCO ActiveMatrix BusinessWorks Plug-in for TIBCO Clarity error code.