Class Approvals

Hierarchy

  • default
    • Approvals

Constructors

constructor

Methods

getFormApprovalFlowInstance getFormSubmissionApproval searchFormSubmissionAdministrationApprovals

Constructors

constructor

  • new Approvals(options): Approvals

  • Example

    const OneBlink = require('@oneblink/sdk')

    const options = {
      accessKey: '123455678901ABCDEFGHIJKL',
      secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
    }

    const approvals = new OneBlink.Approvals(options)

    Parameters

    Returns Approvals

Methods

getFormApprovalFlowInstance

getFormSubmissionApproval

searchFormSubmissionAdministrationApprovals

  • searchFormSubmissionAdministrationApprovals(options): Promise<FormSubmissionsAdministrationApprovalsResponse>

  • Example

    const { approvals, meta } =
      await approvals.searchFormSubmissionAdministrationApprovals({
        formsAppId: 1,
        formId: 2,
        limit: 50,
        offset: 0,
      })

    Parameters

    • options: {
          externalId?: string;
          formApprovalFlowInstanceId?: number;
          formId?: number;
          formsAppId: number;
          lastUpdatedBy?: string[];
          limit: number;
          offset: number;
          statuses?: string[];
          submissionId?: string;
          submittedAfterDateTime?: string;
          submittedBeforeDateTime?: string;
          updatedAfterDateTime?: string;
          updatedBeforeDateTime?: string;
      }

      Search options

      • Optional externalId?: string

        An exact externalId to search by

      • Optional formApprovalFlowInstanceId?: number

        The exact formApprovalFlowInstanceId to search by

      • Optional formId?: number

        The formId of the approvals

      • formsAppId: number

        The formsAppId of the approvals app

      • Optional lastUpdatedBy?: string[]

        An array of usernames to filter by

      • limit: number

        The number of results to return. Maximum is 50

      • offset: number

        The offset of the results to return. Use this in conjunction with limit for pagination

      • Optional statuses?: string[]

        An array of statuses to filter by ('PENDING', 'CLARIFICATION_RECEIVED', 'CLARIFICATION_REQUIRED', 'APPROVED', 'CLOSED')

      • Optional submissionId?: string

        An exact submissionId to search by

      • Optional submittedAfterDateTime?: string

        The date submitted after as an ISO string

      • Optional submittedBeforeDateTime?: string

        The date submitted before as an ISO string

      • Optional updatedAfterDateTime?: string

        The date updated after as an ISO string

      • Optional updatedBeforeDateTime?: string

        The date updated before as an ISO string

    Returns Promise<FormSubmissionsAdministrationApprovalsResponse>

Settings

Member Visibility

Theme

On This Page