Get All Property Value Types.

Retrieves a list of all property value types.

Request

HTTP Request

GET /node/api/property-value-types

Request body

Request body is empty.

Response

Response contains the list of all property value types in the system.

[
  {
    "id": "property value type id",
    "name": "type human readable name",
    "mask": "input mask",
    "system": true|false // flag = true if the type is system and can't be removed or modified.
  },
  ...
]

Example

Request

  • Bash

  • JavaScript

  • NodeJS

  • Python

login=<...>
password=<...>
saymon_hostname=<...>
url=https://$saymon_hostname/node/api/property-value-types/

curl -X GET $url -u $login:$password
let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/property-value-types/";
let auth = "Basic " + btoa(login + ":" + password);

let headers = new Headers();
headers.append("Authorization", auth);

let requestOptions = {
    method: "GET",
    headers: headers
};

fetch(saymonHostname + path, requestOptions)
    .then(response => response.text())
    .then(result => console.log(result))
    .catch(error => console.log("error", error));
const http = require("http");

let login = <...>
let password = <...>
let saymonHostname = <...>
let path = "/node/api/property-value-types/";
let auth = "Basic " + Buffer.from(login + ":" + password).toString("base64");

let options = {
    "method": "GET",
    "hostname": saymonHostname,
    "headers": {
        "Authorization": auth
    },
    "path": path
};

let req = http.request(options, function (res) {
    let chunks = [];

    res.on("data", function (chunk) {
        chunks.push(chunk);
    });

    res.on("end", function (chunk) {
        let body = Buffer.concat(chunks);
        console.log(body.toString());
    });

    res.on("error", function (error) {
        console.error(error);
    });
});

req.end();
import requests

login = <...>
password = <...>
saymon_hostname = <...>
url = "https://" + saymon_hostname + "/node/api/property-value-types/"

response = requests.request("GET", url, auth=(login, password))
print(response.text)

Response

[
    {
        "id": "string",
        "name": "String",
        "system": true
    },
    {
        "id": "integer",
        "name": "Integer",
        "mask": "integer",
        "system": true
    },
    {
        "id": "float",
        "name": "Float",
        "mask": "numeric",
        "system": true
    },
    {
        "id": "boolean",
        "name": "Boolean",
        "mask": "0|1",
        "system": true
    },
    {
        "id": "date",
        "name": "Date",
        "mask": "",
        "system": true
    },
    {
        "id": "time",
        "name": "Time",
        "mask": "",
        "system": true
    },
    {
        "id": "datetime",
        "name": "DateTime",
        "mask": "",
        "system": true
    },
    {
        "id": "ip",
        "name": "IP",
        "mask": "ip",
        "system": true
    },
    {
        "id": "mac",
        "name": "MAC",
        "mask": {
            "regex": "[A-Fa-f0-9]{2}:[A-Fa-f0-9]{2}:[A-Fa-f0-9]{2}:[A-Fa-f0-9]{2}:[A-Fa-f0-9]{2}:[A-Fa-f0-9]{2}",
            "system": true
        }
    },
    {
        "id": "url",
        "name": "URL",
        "mask": {
            "regex": "\\w+\\:\\/\\/.*",
            "system": true
        }
    },
    {
        "id": "email",
        "name": "E-mail",
        "mask": "email",
        "system": true
    },
    {
        "id": "phone",
        "name": "Phone",
        "mask": {
            "regex": "\\+\\d{4} \\d\\d\\d-\\d\\d-\\d\\d"
        },
        "system": true
    },
    {
        "id": "dictionary",
        "name": "Dictionary",
        "system": true
    }
]