Config for surveycto

Jobs that use the surveycto adaptor may require authentication. A "credential" for the surveycto adaptor will follow the schema below. When using the CLI, you can set up your own state.configuration by using the sample below.

Sample Configuration

Paste this into the configuration key of your state.json file and modify the values to run jobs locally.

{
  "servername": "openfn_test",
  "username": "someusername",
  "password": "@some(%)!Password",
  "apiVersion": "v1"
}

Full Schema

The full configuration schema describes each attribute of the credential and notes those that are required.

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
      "servername": {
          "title": "Server Name",
          "type": "string",
          "description": "Your Surveycto server name also known as instance name",
          "minLength": 1,
          "examples": [
              "openfn_test"
          ]
      },
      "username": {
          "title": "Username",
          "type": "string",
          "description": "Your Surveycto server username",
          "minLength": 1,
          "examples": [
              "someusername"
          ]
      },
      "password": {
          "title": "Password",
          "type": "string",
          "description": "Your Surveycto server password",
          "writeOnly": true,
          "minLength": 1,
          "examples": [
              "@some(%)!Password"
          ]
      },
      "apiVersion": {
          "title": "API Version",
          "type": "string",
          "description": "The API version",
          "default": "v1",
          "examples": [
              "v1",
              "v2"
          ]
      }
  },
  "type": "object",
  "additionalProperties": true,
  "required": [
      "serverName",
      "username",
      "password"
  ]
}