Setup

A setup is the basic configuration of the operators skills building block, mainly defining maximum score for all skills. Inside setup skills array is present where each element is a single skill, defined by its name and descriptions. descriptions contain text-like description of the skill scores.

Setup Scheme

Scheme:

{
  "max_score": "Integer",
  "skills": [
    {
      "skill": "String",
      "description": "JSON"
    }
  ]
}

Example setup:

{
  "max_score": 3,
  "skills": [
    {
      "skill": "machine",
      "description": {
        "1": "level 1 description of machine skill",
        "2": "score equals to 2 fo this description",
        "3": "great"
      }
    },
    {
      "skill": "tool",
      "description": {
        "1": "level 1 description of tool skill",
        "2": "score equals to 2 fo this description",
        "3": "amazing"
      }
    },
    {
      "skill": "computer",
      "description": {
        "1": "level 1 description of computer skill",
        "2": "score equals to 2 fo this description",
        "3": "amazing"
      }
    }
  ]
}

GET methods

GET /api/setup

Return the setup of the operator skills profiling building block.

Example request:

GET /api/setup HTTP/1.1
Host: |localhost|

Example response:

HTTP/1.1 200 OK
Content-type: application/json

{
  "max_score": 3,
  "skills": [
    {
      "skill": "machine",
      "description": {
        "1": "level 1 description of machine skill",
        "2": "score equals to 2 fo this description",
        "3": "great"
      }
    },
    {
      "skill": "tool",
      "description": {
        "1": "level 1 description of tool skill",
        "2": "score equals to 2 fo this description",
        "3": "amazing"
      }
    },
    {
      "skill": "computer",
      "description": {
        "1": "level 1 description of computer skill",
        "2": "score equals to 2 fo this description",
        "3": "amazing"
      }
    }
  ]
}
Query Parameters:
 
  • access_token (string) – valid access token for OAuth2 authentication
Response JSON Object:
 
  • max_score (integer) – maximum score for the operator skills profiling building block
  • skills (jsonarr) – array of JSON objects defining skills available with its skill name and description of various scores
Status Codes:

PUT methods

PUT /api/setup

Updates an existing setup with new information. Returns an URI location of the new resource or error message.

Note: All parameters must be defined with the PUT request, ie. PUT request replaces the existing resource with the modified one if it exists, or creates a new one.

Example request:

PUT /api/setup HTTP/1.1
Host: |localhost|
Content-Type: application/json

{
  "max_score": 3,
  "skills": [
    {
      "skill": "machine",
      "description": {
        "1": "level 1 description of machine skill",
        "2": "score equals to 2 fo this description",
        "3": "great"
      }
    },
    {
      "skill": "tool",
      "description": {
        "1": "level 1 description of tool skill",
        "2": "score equals to 2 fo this description",
        "3": "amazing"
      }
    },
    {
      "skill": "computer",
      "description": {
        "1": "level 1 description of computer skill",
        "2": "score equals to 2 fo this description",
        "3": "amazing"
      }
    }
  ]
}

Example response:

HTTP/1.1 200 OK
Content-type: application/json

{
  "max_score": 3,
  "skills": [
    {
      "skill": "machine",
      "description": {
        "1": "level 1 description of machine skill",
        "2": "score equals to 2 fo this description",
        "3": "great"
      }
    },
    {
      "skill": "tool",
      "description": {
        "1": "level 1 description of tool skill",
        "2": "score equals to 2 fo this description",
        "3": "amazing"
      }
    },
    {
      "skill": "computer",
      "description": {
        "1": "level 1 description of computer skill",
        "2": "score equals to 2 fo this description",
        "3": "amazing"
      }
    }
  ]
}
Query Parameters:
 
  • access_token (string) – valid access token for OAuth2 authentication
Request JSON Object:
 
  • max_score (integer) – maximum score for the skills
  • skills (jsonarr) – array of JSON objects defining skills available with its skill name and description of various scores
Response JSON Object:
 
  • max_score (integer) – maximum score for the operator skills profiling building block
  • skills (jsonarr) – array of JSON objects defining skills available with its skill name and description of various scores
Status Codes: