Sample Configurations

Sample Configuration using Basic Authentication

The following model file uses Basic Authentication. No custom scheme is defined.

"@Skill.Clarify.Integration": {
  "id": "Integration 1",
  "uuid": "fe7dea6d-7eac-430f-....-88a21b104d1d",
  "integration": "ceg2421...5q4heik0",
  "url": "https://api.clarify.io/v1/rpc",
  "credentials": {
    "@BasicAuthentication" {
      "username": "username",
      "password": "password"
    }
  },
  "customSchemes": {
  },
  "children": [
    {
      "@Skill.Clarify.Dataset": {
        "id" :  "Dataset 1",
        "uuid" :  "c45e2ba2-710f-45ce-....-c49eb74998e5",
        "dataPoints" {
          "Test.Data.Signal 1" : "default",
          "Test.Data.Signal 2" : "compact",
        }
      }
    },
    {
      "@Skill.Clarify.Dataset": {
        "id" :  "Dataset 2",
        "uuid" :  "c45e2ba2-710f-45ce-....-c49eb74998e5",
        "dataPoints": {
          "Test.Data.Signal 3" : "default",
          "Test.Data.Signal 4" : "compact",
        }
      }
    }
  ]
}

Sample Configuration using OAuth 2.0 Authentication

The following model file uses OAuth 2.0 Authentication. No custom scheme is defined.

"@Skill.Clarify.Integration": {
  "id": "Integration 1",
  "uuid": "fe7dea6d-7eac-430f-....-88a21b104d1d",
  "integration": "ceg2421...5q4heik0",
  "url": "https://api.clarify.io/v1/rpc",
  "credentials": {
    "@OauthAuthentication" {
      "type": "client_credentials",
      "apiUrl": "https://api.clarify.io/v1/",
      "accessTokenUrl": "https://login.clarify.io/oauth/token",
      "clientId": "8QTLwwhQgdv3qQ0v.....4eLMqZuOBL",
      "clientSecret": "DAcXlJrKJJ5DfFiurkNHaKGktKuZDIxfnO1OFml1.........W2mgVOqyS_CENkP"
    }
  },
  "customSchemes": {
  },
  "children": [
    {
      "@Skill.Clarify.Dataset": {
        "id" :  "Dataset 1",
        "uuid" :  "c45e2ba2-710f-45ce-....-c49eb74998e5",
        "dataPoints": {
          "Test.Data.Signal 1" : "default",
          "Test.Data.Signal 2" : "compact",
        }
      }
    },
    {
      "@Skill.Clarify.Dataset": {
        "id" :  "Dataset 2",
        "uuid" :  "c45e2ba2-710f-45ce-....-c49eb74998e5",
        "dataPoints": {
          "Test.Data.Signal 3" : "default",
          "Test.Data.Signal 4" : "compact",
        }
      }
    }
  ]
}

Sample Configuration with custom schemes definitions

The following model file defines some custom schemes.

"@Skill.Clarify.Integration": {
  "id": "Integration 1",
  "uuid": "fe7dea6d-7eac-430f-....-88a21b104d1d",
  "integration": "ceg2421...5q4heik0",
  "url": "https://api.clarify.io/v1/rpc",
  "credentials": {
    "@BasicAuthentication" {
      "username": "username",
      "password": "password"
    }
  },
  "customSchemes": {
    "scheme1": {
      "extraSignals" : [ "error" ]",
      "qualityFilter" : "[ "good", "acceptable" ]",
      "qualitySignal" : true
    },
    "scheme2": {
      "extraSignals" : []",
      "qualitySignal" : false
    }
  },
  "children": [
    {
      "@Skill.Clarify.Dataset": {
        "id" :  "Dataset 1",
        "uuid" :  "c45e2ba2-710f-45ce-....-c49eb74998e5",
        "dataPoints": {
          "Test.Data.Signal 1" : "scheme1",
          "Test.Data.Signal 2" : "scheme2",
        }
      }
    },
    {
      "@Skill.Clarify.Dataset": {
        "id" :  "Dataset 2",
        "uuid" :  "c45e2ba2-710f-45ce-....-c49eb74998e5",
        "dataPoints": {
          "Test.Data.Signal 3" : "default",
          "Test.Data.Signal 4" : "compact",
        }
      }
    }
  ]
}