Class Jobs

Example

const OneBlink = require('@oneblink/sdk')
  const options = {
    accessKey: '123455678901ABCDEFGHIJKL',
    secretKey: '123455678901ABCDEFGHIJKL123455678901ABCDEFGHIJKL',
  }
  const jobs = new OneBlink.Jobs(options)
Copy

Create a single Job

Minimum Role Permission

Jobs: Manager

Upload Form Prefill Data: On (only if using preFillData)

Example

const newJob = {
    username: 'user@domain.io',
    formId: 1,
    externalId: 'your-job-identifier',
    details: {
      key: 'JOB-123',
      title: 'Job Title',
      description: 'Job description',
      type: 'Type',
      priority: 3,
    },
  }

  const preFillData = {
    text_element: 'abc',
    number_element: 123,
  }

  jobs.createJob(newJob, preFillData).then((job) => {
    // job.id can be used to delete the Job
  })
Copy

Delete a single Job

Minimum Role Permission

Jobs: Manager

Example

const jobId = 'f73985fd-2dba-4bf7-abbe-e204889f5216'
  jobs.deleteJob(jobId).then(() => {
    // Job has been deleted
  })
Copy

Search Jobs

Minimum Role Permission

Jobs: Read Only

Example

const results = await jobs.searchJobs({
    username: 'user@domain.io',
    formId: 10,
  })

  // an array of jobs
  const jobs = results.jobs
Copy