Class FormElementLookups

Example

import { FormElementLookups } from '@oneblink/sdk'
  const options = {
    accessKey: '123455678901ABCDEFGHIJKL',
    secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
  }
  const formElementLookups = new FormElementLookups(options)
Copy

Minimum Role Permission

Lookups: Manager

Example

const newLookup = {
    name: 'My New Lookup',
    environments: [
      {
        formsAppEnvironmentId: 1,
        urL: 'https://my-url.com/lookup',
      },
    ],
    type: 'DATA',
    organisationId: '',
  }
  const createdLookup = await lookups.createFormElementLookup(newLookup)
  // Use lookup here
Copy

Minimum Role Permission

Lookups: Manager

Example

const lookupId = 7
  await formElementLookups.deleteFormElementLookup(lookupId)
Copy

Minimum Role Permission

Lookups: Read Only

Example

const lookupId = 1
  const lookup = await formElementLookups.getFormElementLookup(lookupId)
  // Use lookup here
Copy

Minimum Role Permission

Lookups: Read Only

Example

const organisationId = '2i4321a7n2389a2700065425'
  const lookups = await formElementLookups.searchFormElementLookups({
    organisationId,
    limit: 50,
    offset: 0,
  })
  // Use lookups here
Copy

Minimum Role Permission

Lookups: Manager

Example

const lookup = {
    id: 1,
    createdAt: '2023-06-28T02:00:03.000Z',
    updatedAt: '2023-06-28T02:00:03.000Z',
    name: 'My New Lookup',
    environments: [
      {
        formsAppEnvironmentId: 1,
        url: 'https://my-url.com/lookup',
      },
    ],
    type: 'DATA',
    organisationId: '',
  }
  const updatedLookup =
    await formElementLookups.updateFormElementLookup(lookup)
  // Use lookup here
Copy