Class GetJotFormAction

Action to retrieve complete details of a JotForm including questions, properties, and settings

Security: API credentials are retrieved securely from Company Integrations instead of being passed as parameters.

Example

await runAction({
  ActionName: 'Get JotForm Details',
  Params: [{
    Name: 'CompanyID',
    Value: 'your-company-id'
  }, {
    Name: 'FormID',
    Value: '123456789'
  }, {
    Name: 'Region',
    Value: 'us'
  }]
});

Hierarchy (View Summary)

JotFormBaseAction
- GetJotFormAction

Constructors

constructor

new GetJotFormAction(): GetJotFormAction
Returns GetJotFormAction
Inherited from JotFormBaseAction.constructor

Properties

`Static` `Readonly`AuthorizesCaller

AuthorizesCaller: boolean

True when the action authorizes its caller itself, so a public entry point such as the RunAction mutation may run it for an authenticated user without an MJ: Action Authorizations link. Set it only on an action that either checks an authorization the caller must hold, or reads and writes only with the caller's own permissions. Leave it false for an action that acts with more authority than its caller, or that reaches data or sends messages the caller chooses but could not otherwise reach.

The engine reads the marker only from the class that runs, never from its parent classes. A subclass that overrides a marked action must declare the marker again.

Accessors

`Protected`apiBaseUrl

get apiBaseUrl(): string
Returns string
Inherited from JotFormBaseAction.apiBaseUrl
- Defined in BizApps/FormBuilders/src/providers/jotform/jotform-base.action.ts:50

Description

get Description(): string
Returns string
- Defined in BizApps/FormBuilders/src/providers/jotform/actions/get-form.action.ts:32

`Protected`formPlatform

get formPlatform(): string
The form platform this action is designed for (e.g., 'Typeform', 'Google Forms', etc.)

Returns string
Inherited from JotFormBaseAction.formPlatform
- Defined in BizApps/FormBuilders/src/providers/jotform/jotform-base.action.ts:42

`Protected`integrationName

get integrationName(): string
The integration name to look up in the Integration entity

Returns string
Inherited from JotFormBaseAction.integrationName
- Defined in BizApps/FormBuilders/src/providers/jotform/jotform-base.action.ts:46

Params

get Params(): ActionParam[]
Returns ActionParam[]
- Defined in BizApps/FormBuilders/src/providers/jotform/actions/get-form.action.ts:170

Methods

`Protected`buildFormErrorMessage

buildFormErrorMessage(
    operation: string,
    details: string,
    systemError?: any,
): string
Helper to build consistent error messages for form operations
Parameters
- operation: string
- details: string
- OptionalsystemError: any
Returns string
Inherited from JotFormBaseAction.buildFormErrorMessage
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:289

`Protected`calculateAverageCompletionTime

calculateAverageCompletionTime(responses: FormResponse[]): number
Calculate average completion time from responses
Parameters
- responses: FormResponse[]
Returns number
Inherited from JotFormBaseAction.calculateAverageCompletionTime
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:333

`Protected`calculateCompletionRate

calculateCompletionRate(completed: number, total: number): number
Calculate completion rate percentage
Parameters
- completed: number
- total: number
Returns number
Inherited from JotFormBaseAction.calculateCompletionRate
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:263

`Protected`convertToCSV

convertToCSV(
    responses: FormResponse[],
    includeMetadata?: boolean,
    delimiter?: string,
): { csv: string; headers: string[] }
Convert responses to CSV format
Parameters
- responses: FormResponse[]
- includeMetadata: boolean = false
- delimiter: string = ','
Returns { csv: string; headers: string[] }
Inherited from JotFormBaseAction.convertToCSV
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:382

`Protected`createJotFormSubmission

createJotFormSubmission(
    formId: string,
    apiKey: string,
    submissionData: Record<string, any>,
    region?: "us" | "eu" | "hipaa",
): Promise<any>
Create a new submission
Parameters
- formId: string
- apiKey: string
- submissionData: Record<string, any>
- Optionalregion: "us" | "eu" | "hipaa"
Returns Promise<any>
Inherited from JotFormBaseAction.createJotFormSubmission
- Defined in BizApps/FormBuilders/src/providers/jotform/jotform-base.action.ts:270

`Protected`createOAuth2Manager

createOAuth2Manager(
companyId: string,
contextUser: UserInfo,
): Promise<OAuth2Manager>
Creates an OAuth2Manager instance for the specified company. Override this method in provider-specific base classes to configure OAuth2 endpoints.
Parameters
- companyId: string
  The MemberJunction company ID
- contextUser: UserInfo
  The user context
Returns Promise<OAuth2Manager>
OAuth2Manager instance or null if OAuth2 is not configured
Inherited from JotFormBaseAction.createOAuth2Manager
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:221

`Protected`extractEmailFromResponses

extractEmailFromResponses(responses: FormResponse[]): string[]
Extract email addresses from response answers
Parameters
- responses: FormResponse[]
Returns string[]
Inherited from JotFormBaseAction.extractEmailFromResponses
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:300

`Protected`findTopAnswers

findTopAnswers(
    responses: FormResponse[],
    fieldId: string,
    limit?: number,
): { answer: string; count: number }[]
Find most common answers for choice fields
Parameters
- responses: FormResponse[]
- fieldId: string
- limit: number = 10
Returns { answer: string; count: number }[]
Inherited from JotFormBaseAction.findTopAnswers
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:356

`Protected`formatDuration

formatDuration(seconds: number): string
Format duration in seconds to human readable format
Parameters
- seconds: number
Returns string
Inherited from JotFormBaseAction.formatDuration
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:271

`Protected`formatFormDate

formatFormDate(date: Date): string
Standard date format for form platforms (ISO 8601)
Parameters
- date: Date
Returns string
Inherited from JotFormBaseAction.formatFormDate
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:246

`Protected`getAllJotFormSubmissions

getAllJotFormSubmissions(
    formId: string,
    apiKey: string,
    options?: {
        filter?: Record<string, string>;
        maxSubmissions?: number;
        orderby?: string;
        region?: "us" | "eu" | "hipaa";
    },
): Promise<JotFormSubmission[]>
Get all submissions with automatic pagination
Parameters
- formId: string
- apiKey: string
- Optionaloptions: {
      filter?: Record<string, string>;
      maxSubmissions?: number;
      orderby?: string;
      region?: "us" | "eu" | "hipaa";
  }
Returns Promise<JotFormSubmission[]>
Inherited from JotFormBaseAction.getAllJotFormSubmissions
- Defined in BizApps/FormBuilders/src/providers/jotform/jotform-base.action.ts:152

`Protected`getAPICredentials

getAPICredentials(
integration: MJCompanyIntegrationEntity,
): Promise<{ accessToken?: string; apiKey?: string; apiToken?: string }>
Gets API credentials - first tries environment variables, then falls back to database
Parameters
- integration: MJCompanyIntegrationEntity
Returns Promise<{ accessToken?: string; apiKey?: string; apiToken?: string }>
Inherited from JotFormBaseAction.getAPICredentials
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:148

`Protected`getAxiosInstance

getAxiosInstance(apiKey: string, region?: "us" | "eu" | "hipaa"): AxiosInstance
Get axios instance with JotForm authentication
Parameters
- apiKey: string
- Optionalregion: "us" | "eu" | "hipaa"
Returns AxiosInstance
Inherited from JotFormBaseAction.getAxiosInstance
- Defined in BizApps/FormBuilders/src/providers/jotform/jotform-base.action.ts:60

`Protected`getCommonFormParams

getCommonFormParams(): ActionParam[]
Common form builder parameters that many actions will need. CompanyID is required for secure credential lookup. FormID is the platform-specific form identifier.

Returns ActionParam[]
Inherited from JotFormBaseAction.getCommonFormParams
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:78

`Protected`getCompanyIntegration

getCompanyIntegration(
companyId: string,
contextUser: UserInfo,
): Promise<MJCompanyIntegrationEntity>
Gets the company integration record for the specified company and form platform
Parameters
- companyId: string
- contextUser: UserInfo
Returns Promise<MJCompanyIntegrationEntity>
Inherited from JotFormBaseAction.getCompanyIntegration
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:96

`Protected`getCredentialFromEnv

getCredentialFromEnv(companyId: string, credentialType: string): string
Gets credentials from environment variables Format: BIZAPPS_{PROVIDER}{COMPANY_ID}{CREDENTIAL_TYPE} Example: BIZAPPS_TYPEFORM_12345_API_TOKEN

Falls back to: BIZAPPS_{PROVIDER}_{CREDENTIAL_TYPE} if no company-specific credential found Example fallback: BIZAPPS_TYPEFORM_API_TOKEN
Parameters
- companyId: string
- credentialType: string
Returns string
Inherited from JotFormBaseAction.getCredentialFromEnv
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:128

`Protected`getJotFormDetails

getJotFormDetails(
    formId: string,
    apiKey: string,
    region?: "us" | "eu" | "hipaa",
): Promise<any>
Get form details
Parameters
- formId: string
- apiKey: string
- Optionalregion: "us" | "eu" | "hipaa"
Returns Promise<any>
Inherited from JotFormBaseAction.getJotFormDetails
- Defined in BizApps/FormBuilders/src/providers/jotform/jotform-base.action.ts:228

`Protected`getJotFormQuestions

getJotFormQuestions(
    formId: string,
    apiKey: string,
    region?: "us" | "eu" | "hipaa",
): Promise<any>
Get form questions/fields
Parameters
- formId: string
- apiKey: string
- Optionalregion: "us" | "eu" | "hipaa"
Returns Promise<any>
Inherited from JotFormBaseAction.getJotFormQuestions
- Defined in BizApps/FormBuilders/src/providers/jotform/jotform-base.action.ts:249

`Protected`getJotFormSubmissions

getJotFormSubmissions(
    formId: string,
    apiKey: string,
    options?: {
        filter?: Record<string, string>;
        limit?: number;
        offset?: number;
        orderby?: string;
        region?: "us" | "eu" | "hipaa";
    },
): Promise<JotFormSubmissionsResult>
Get submissions from a JotForm
Parameters
- formId: string
- apiKey: string
- Optionaloptions: {
      filter?: Record<string, string>;
      limit?: number;
      offset?: number;
      orderby?: string;
      region?: "us" | "eu" | "hipaa";
  }
Returns Promise<JotFormSubmissionsResult>
Inherited from JotFormBaseAction.getJotFormSubmissions
- Defined in BizApps/FormBuilders/src/providers/jotform/jotform-base.action.ts:111

`Protected`getParamValue

getParamValue(params: ActionParam[], paramName: string): any
Helper to get parameter value with type safety
Parameters
- params: ActionParam[]
- paramName: string
Returns any
Inherited from JotFormBaseAction.getParamValue
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:238

`Protected`getRegionalBaseUrl

getRegionalBaseUrl(region?: "us" | "eu" | "hipaa"): string
Get regional base URL
Parameters
- Optionalregion: "us" | "eu" | "hipaa"
Returns string
Inherited from JotFormBaseAction.getRegionalBaseUrl
- Defined in BizApps/FormBuilders/src/providers/jotform/jotform-base.action.ts:97

`Protected`getSecureAPIToken

getSecureAPIToken(companyId: string, contextUser: UserInfo): Promise<string>
Helper to securely retrieve API token for a company. This method should be used by all form builder actions instead of accepting tokens as parameters.
Parameters
- companyId: string
  The MemberJunction company ID (required)
- contextUser: UserInfo
  The user context for database queries
Returns Promise<string>
The API token for the specified company

Throws
Error if no credentials are found or company integration is not configured
Inherited from JotFormBaseAction.getSecureAPIToken
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:183

`Protected`getSingleJotFormSubmission

getSingleJotFormSubmission(
    submissionId: string,
    apiKey: string,
    region?: "us" | "eu" | "hipaa",
): Promise<JotFormSubmission>
Get a single submission by ID
Parameters
- submissionId: string
- apiKey: string
- Optionalregion: "us" | "eu" | "hipaa"
Returns Promise<JotFormSubmission>
Inherited from JotFormBaseAction.getSingleJotFormSubmission
- Defined in BizApps/FormBuilders/src/providers/jotform/jotform-base.action.ts:207

`Protected`groupResponsesByDate

groupResponsesByDate(responses: FormResponse[]): Record<string, number>
Group responses by date
Parameters
- responses: FormResponse[]
Returns Record<string, number>
Inherited from JotFormBaseAction.groupResponsesByDate
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:319

`Protected`handleJotFormError

handleJotFormError(error: any): Error
Handle JotForm-specific errors
Parameters
- error: any
Returns Error
Inherited from JotFormBaseAction.handleJotFormError
- Defined in BizApps/FormBuilders/src/providers/jotform/jotform-base.action.ts:338

`Protected`InternalRunAction

InternalRunAction(params: RunActionParams): Promise<ActionResultSimple>
Internal method that must be implemented by derived action classes. This is where the actual action logic should be implemented.
Parameters
- params: RunActionParams
  The action execution parameters including typed context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Overrides JotFormBaseAction.InternalRunAction
- Defined in BizApps/FormBuilders/src/providers/jotform/actions/get-form.action.ts:36

`Protected`normalizeJotFormSubmission

normalizeJotFormSubmission(jfSubmission: JotFormSubmission): FormResponse
Normalize JotForm submission to common format
Parameters
- jfSubmission: JotFormSubmission
Returns FormResponse
Inherited from JotFormBaseAction.normalizeJotFormSubmission
- Defined in BizApps/FormBuilders/src/providers/jotform/jotform-base.action.ts:300

`Protected`parseFormDate

parseFormDate(dateString: string | number): Date
Parse date from form platform format
Parameters
- dateString: string | number
Returns Date
Inherited from JotFormBaseAction.parseFormDate
- Defined in BizApps/FormBuilders/src/base/base-form-builder.action.ts:253

Run

Run(params: RunActionParams): Promise<ActionResultSimple>
Executes the action with the provided parameters.
Parameters
- params: RunActionParams
  The action execution parameters including context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Inherited from JotFormBaseAction.Run
- Defined in Engine/dist/generic/BaseAction.d.ts:49

`Protected`sleep

sleep(ms: number): Promise<void>
Sleep helper for rate limiting
Parameters
- ms: number
Returns Promise<void>
Inherited from JotFormBaseAction.sleep
- Defined in BizApps/FormBuilders/src/providers/jotform/jotform-base.action.ts:363

Class GetJotFormAction

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns GetJotFormAction

Properties

Static ReadonlyAuthorizesCaller

Accessors

ProtectedapiBaseUrl

Returns string

Description

Returns string

ProtectedformPlatform

Returns string

ProtectedintegrationName

Returns string

Params

Returns ActionParam[]

Methods

ProtectedbuildFormErrorMessage

Parameters

Returns string

ProtectedcalculateAverageCompletionTime

Parameters

Returns number

ProtectedcalculateCompletionRate

Parameters

Returns number

ProtectedconvertToCSV

Parameters

Returns { csv: string; headers: string[] }

ProtectedcreateJotFormSubmission

Parameters

Returns Promise<any>

ProtectedcreateOAuth2Manager

Parameters

Returns Promise<OAuth2Manager>

ProtectedextractEmailFromResponses

Parameters

Returns string[]

ProtectedfindTopAnswers

Parameters

Returns { answer: string; count: number }[]

ProtectedformatDuration

Parameters

Returns string

ProtectedformatFormDate

Parameters

Returns string

ProtectedgetAllJotFormSubmissions

Parameters

Returns Promise<JotFormSubmission[]>

ProtectedgetAPICredentials

Parameters

Returns Promise<{ accessToken?: string; apiKey?: string; apiToken?: string }>

ProtectedgetAxiosInstance

Parameters

Returns AxiosInstance

ProtectedgetCommonFormParams

Returns ActionParam[]

ProtectedgetCompanyIntegration

Parameters

Returns Promise<MJCompanyIntegrationEntity>

ProtectedgetCredentialFromEnv

Parameters

Returns string

ProtectedgetJotFormDetails

Parameters

Returns Promise<any>

ProtectedgetJotFormQuestions

Parameters

Returns Promise<any>

ProtectedgetJotFormSubmissions

Parameters

`Static` `Readonly`AuthorizesCaller

`Protected`apiBaseUrl

`Protected`formPlatform

`Protected`integrationName

`Protected`buildFormErrorMessage

`Protected`calculateAverageCompletionTime

`Protected`calculateCompletionRate

`Protected`convertToCSV

`Protected`createJotFormSubmission

`Protected`createOAuth2Manager

`Protected`extractEmailFromResponses

`Protected`findTopAnswers

`Protected`formatDuration

`Protected`formatFormDate

`Protected`getAllJotFormSubmissions

`Protected`getAPICredentials

`Protected`getAxiosInstance

`Protected`getCommonFormParams

`Protected`getCompanyIntegration

`Protected`getCredentialFromEnv

`Protected`getJotFormDetails

`Protected`getJotFormQuestions

`Protected`getJotFormSubmissions

`Protected`getParamValue

`Protected`getRegionalBaseUrl

`Protected`getSecureAPIToken

`Protected`getSingleJotFormSubmission

`Protected`groupResponsesByDate

`Protected`handleJotFormError

`Protected`InternalRunAction

`Protected`normalizeJotFormSubmission

`Protected`parseFormDate

`Protected`sleep