Create a new field definition for a specific template.

POST

/customer-api/v1/asset-tracking/{template}/field-definition

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{ \"field_type\": { \"name\": \"ATTACHMENT\", \"constraints\": [ { \"type\": \"allowed_values\", \"value\": [ \"example\" ] } ] }, \"label\": \"general_information\", \"comment\": \"Additional info about the field\", \"default_value\": true, \"possible_values\": [ true ], \"attributes\": [ { \"type\": \"form_group\", \"value\": \"General\" } ], \"relations\": [ { \"type\": \"actual_field\", \"field_uuid\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\" } ] }");

CURLcode ret = curl_easy_perform(hnd);

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"field_type\": { \"name\": \"ATTACHMENT\", \"constraints\": [ { \"type\": \"allowed_values\", \"value\": [ \"example\" ] } ] }, \"label\": \"general_information\", \"comment\": \"Additional info about the field\", \"default_value\": true, \"possible_values\": [ true ], \"attributes\": [ { \"type\": \"form_group\", \"value\": \"General\" } ], \"relations\": [ { \"type\": \"actual_field\", \"field_uuid\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\" } ] }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition"

  payload := strings.NewReader("{ \"field_type\": { \"name\": \"ATTACHMENT\", \"constraints\": [ { \"type\": \"allowed_values\", \"value\": [ \"example\" ] } ] }, \"label\": \"general_information\", \"comment\": \"Additional info about the field\", \"default_value\": true, \"possible_values\": [ true ], \"attributes\": [ { \"type\": \"form_group\", \"value\": \"General\" } ], \"relations\": [ { \"type\": \"actual_field\", \"field_uuid\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\" } ] }")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{ \"field_type\": { \"name\": \"ATTACHMENT\", \"constraints\": [ { \"type\": \"allowed_values\", \"value\": [ \"example\" ] } ] }, \"label\": \"general_information\", \"comment\": \"Additional info about the field\", \"default_value\": true, \"possible_values\": [ true ], \"attributes\": [ { \"type\": \"form_group\", \"value\": \"General\" } ], \"relations\": [ { \"type\": \"actual_field\", \"field_uuid\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\" } ] }"))
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{ \"field_type\": { \"name\": \"ATTACHMENT\", \"constraints\": [ { \"type\": \"allowed_values\", \"value\": [ \"example\" ] } ] }, \"label\": \"general_information\", \"comment\": \"Additional info about the field\", \"default_value\": true, \"possible_values\": [ true ], \"attributes\": [ { \"type\": \"form_group\", \"value\": \"General\" } ], \"relations\": [ { \"type\": \"actual_field\", \"field_uuid\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\" } ] }");
Request request = new Request.Builder()
  .url("https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition")
  .post(body)
  .addHeader("Authorization", "Bearer <token>")
  .addHeader("Content-Type", "application/json")
  .build();

Response response = client.newCall(request).execute();

import axios from 'axios';

const options = {
  method: 'POST',
  url: 'https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  data: {
    field_type: {
      name: 'ATTACHMENT',
      constraints: [{type: 'allowed_values', value: ['example']}]
    },
    label: 'general_information',
    comment: 'Additional info about the field',
    default_value: true,
    possible_values: [true],
    attributes: [{type: 'form_group', value: 'General'}],
    relations: [{type: 'actual_field', field_uuid: '2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'}]
  }
};

try {
  const { data } = await axios.request(options);
  console.log(data);
} catch (error) {
  console.error(error);
}

const url = 'https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"field_type":{"name":"ATTACHMENT","constraints":[{"type":"allowed_values","value":["example"]}]},"label":"general_information","comment":"Additional info about the field","default_value":true,"possible_values":[true],"attributes":[{"type":"form_group","value":"General"}],"relations":[{"type":"actual_field","field_uuid":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

val client = OkHttpClient()

val mediaType = MediaType.parse("application/json")
val body = RequestBody.create(mediaType, "{ \"field_type\": { \"name\": \"ATTACHMENT\", \"constraints\": [ { \"type\": \"allowed_values\", \"value\": [ \"example\" ] } ] }, \"label\": \"general_information\", \"comment\": \"Additional info about the field\", \"default_value\": true, \"possible_values\": [ true ], \"attributes\": [ { \"type\": \"form_group\", \"value\": \"General\" } ], \"relations\": [ { \"type\": \"actual_field\", \"field_uuid\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\" } ] }")
val request = Request.Builder()
  .url("https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition")
  .post(body)
  .addHeader("Authorization", "Bearer <token>")
  .addHeader("Content-Type", "application/json")
  .build()

val response = client.newCall(request).execute()

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'field_type' => [
        'name' => 'ATTACHMENT',
        'constraints' => [
                [
                                'type' => 'allowed_values',
                                'value' => [
                                                                'example'
                                ]
                ]
        ]
    ],
    'label' => 'general_information',
    'comment' => 'Additional info about the field',
    'default_value' => null,
    'possible_values' => [
        null
    ],
    'attributes' => [
        [
                'type' => 'form_group',
                'value' => 'General'
        ]
    ],
    'relations' => [
        [
                'type' => 'actual_field',
                'field_uuid' => '2489E9AD-2EE2-8E00-8EC9-32D5F69181C0'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

<?php

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition', [
  'body' => '{ "field_type": { "name": "ATTACHMENT", "constraints": [ { "type": "allowed_values", "value": [ "example" ] } ] }, "label": "general_information", "comment": "Additional info about the field", "default_value": true, "possible_values": [ true ], "attributes": [ { "type": "form_group", "value": "General" } ], "relations": [ { "type": "actual_field", "field_uuid": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } ] }',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

import http.client

conn = http.client.HTTPSConnection("your-instance.seventhings.com")

payload = "{ \"field_type\": { \"name\": \"ATTACHMENT\", \"constraints\": [ { \"type\": \"allowed_values\", \"value\": [ \"example\" ] } ] }, \"label\": \"general_information\", \"comment\": \"Additional info about the field\", \"default_value\": true, \"possible_values\": [ true ], \"attributes\": [ { \"type\": \"form_group\", \"value\": \"General\" } ], \"relations\": [ { \"type\": \"actual_field\", \"field_uuid\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\" } ] }"

headers = {
    'Authorization': "Bearer <token>",
    'Content-Type': "application/json"
}

conn.request("POST", "/customer-api/v1/asset-tracking/asset/field-definition", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

import requests

url = "https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition"

payload = {
    "field_type": {
        "name": "ATTACHMENT",
        "constraints": [
            {
                "type": "allowed_values",
                "value": ["example"]
            }
        ]
    },
    "label": "general_information",
    "comment": "Additional info about the field",
    "default_value": True,
    "possible_values": [True],
    "attributes": [
        {
            "type": "form_group",
            "value": "General"
        }
    ],
    "relations": [
        {
            "type": "actual_field",
            "field_uuid": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())

use serde_json::json;
use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition";

    let payload = json!({
        "field_type": json!({
            "name": "ATTACHMENT",
            "constraints": (
                json!({
                    "type": "allowed_values",
                    "value": ("example")
                })
            )
        }),
        "label": "general_information",
        "comment": "Additional info about the field",
        "default_value": true,
        "possible_values": (true),
        "attributes": (
            json!({
                "type": "form_group",
                "value": "General"
            })
        ),
        "relations": (
            json!({
                "type": "actual_field",
                "field_uuid": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
            })
        )
    });

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Authorization", "Bearer <token>".parse().unwrap());
    headers.insert("Content-Type", "application/json".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.post(url)
        .headers(headers)
        .json(&payload)
        .send()
        .await;

    let results = response.unwrap()
        .json::<serde_json::Value>()
        .await
        .unwrap();

    dbg!(results);
}

curl --request POST \
  --url https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "field_type": { "name": "ATTACHMENT", "constraints": [ { "type": "allowed_values", "value": [ "example" ] } ] }, "label": "general_information", "comment": "Additional info about the field", "default_value": true, "possible_values": [ true ], "attributes": [ { "type": "form_group", "value": "General" } ], "relations": [ { "type": "actual_field", "field_uuid": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } ] }'

wget --quiet \
  --method POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --body-data '{ "field_type": { "name": "ATTACHMENT", "constraints": [ { "type": "allowed_values", "value": [ "example" ] } ] }, "label": "general_information", "comment": "Additional info about the field", "default_value": true, "possible_values": [ true ], "attributes": [ { "type": "form_group", "value": "General" } ], "relations": [ { "type": "actual_field", "field_uuid": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } ] }' \
  --output-document \
  - https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition

Create a new field definition for a specific template.

Authorizations

bearerAuth

Parameters

Path Parameters

template

required

The template type of the asset tracking module

Allowed values: asset room person

Example

room

The template to get the field definitions for.

Request Body^required

application/json

Create a new field definition

object

field_type

required

One of:

An attachment field type

object

name

required

Allowed values: ATTACHMENT

constraints

required

Array of field value constraints

Array

Any of:

A field value constraint that allows only certain values

object

type

required

Allowed values: allowed_values

value

required

Array of allowed values

Array<string>

label

required

The label or translation key of the field

string

Example

general_information

comment

The comment of the field

string

Example

Additional info about the field

default_value

required

One of:

boolean

possible_values

required

The possible values of the field

Array

nullable

attributes

required

The attributes of the field

Array

Any of:

The form group of a field

object

type

required

Allowed values: form_group

value

required

string

Example

{
  "type": "form_group",
  "value": "General"
}

The editable attribute of a field

object

type

required

Allowed values: editable

value

required

Allowed values: mobile_app web_app

Example

{
  "type": "editable",
  "value": "web_app"
}

Whether the field is internal

object

type

required

Allowed values: internal

value

required

Allowed values: yes no

Example

{
  "type": "internal",
  "value": "no"
}

Whether the field is mandatory

object

type

required

Allowed values: mandatory

value

required

Allowed values: yes no

Example

{
  "type": "mandatory",
  "value": "no"
}

Whether the field is mutable

object

type

required

Allowed values: mutable

value

required

Allowed values: yes no

Example

{
  "type": "mutable",
  "value": "yes"
}

Whether the field is a system field

object

type

required

Allowed values: system

value

required

Allowed values: yes no

Example

{
  "type": "system",
  "value": "no"
}

Visibility of the field

object

type

required

Allowed values: visible

value

required

Allowed values: mobile_app web_app_details_view web_app_list_view

Example

{
  "type": "visible",
  "value": "web_app_details_view"
}

Preselect the field in the app

object

type

required

Allowed values: preselected

value

required

Allowed values: mobile_app

Example

{
  "type": "preselected",
  "value": "mobile_app"
}

Whether the field content is indexed

object

type

required

Allowed values: indexed

value

required

Allowed values: search

Example

{
  "type": "indexed",
  "value": "search"
}

The formatting of the field value

object

type

required

Allowed values: formatted

value

required

Allowed values: user_as_email user_as_firstname_lastname user_as_lastname_firstname

Example

{
  "type": "formatted",
  "value": "user_as_firstname_lastname"
}

The sort direction of a list field

object

type

required

Allowed values: sorted

value

required

Allowed values: ascending descending

Example

{
  "type": "sorted",
  "value": "ascending"
}

The ISO 4217 currency code

object

type

required

Allowed values: currency_code

value

required

string

>= 3 characters <= 3 characters

Example

{
  "type": "currency_code",
  "value": "EUR"
}

The number of fraction digits

object

type

required

Allowed values: fraction_digits

value

required

number

<= 20

Example

{
  "type": "fraction_digits",
  "value": 2
}

Whether the field is a name component

object

type

required

Allowed values: name_component

value

required

Allowed values: yes no

Example

{
  "type": "name_component",
  "value": "no"
}

Whether the field is exposed to a specified location

object

type

required

Allowed values: exposed

value

required

Allowed values: mobile_app_api

Example

{
  "type": "exposed",
  "value": "mobile_app_api"
}

Whether the field is generated to a specified location

object

type

required

Allowed values: generated

value

required

Allowed values: on_create on_update on_import

Example

{
  "type": "generated",
  "value": "on_create"
}

Whether the field is unique to a specified entity

object

type

required

Allowed values: unique

value

required

Allowed values: yes no

Example

{
  "type": "unique",
  "value": "yes"
}

When a field should be visible on dashboard

object

type

required

Allowed values: piechart_on_dashboard

value

required

Allowed values: yes no

Example

{
  "type": "piechart_on_dashboard",
  "value": "no"
}

relations

required

The relations of the field

Array

nullable

Any of:

The actual field of the relation

object

type

required

Allowed values: actual_field

field_uuid

required

The uuid of the field

string format: uuid

Responses

201

Success

Headers

Location

string

The URL of the newly created field definition.

Location-UUID

uuid

The UUID of the newly created object.

400

Request body is missing or invalid or request data is invalid.

401

Access token is missing or invalid.

403

You are not permitted to perform the requested operation.

406

The requested resource representation has no acceptable format.

500

Internal Server Error.

Create a new field definition for a specific template.

Authorizations

Parameters

Path Parameters

Example

Request Bodyrequired

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Responses

201

Headers

400

401

403

406

500

Request Body^required