Get a field definition for a specific template.

GET

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

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Authorization: Bearer <token>");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

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

func main() {

  url := "https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  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/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"))
    .header("Authorization", "Bearer <token>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0")
  .get()
  .addHeader("Authorization", "Bearer <token>")
  .build();

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

import axios from 'axios';

const options = {
  method: 'GET',
  url: 'https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0',
  headers: {Authorization: 'Bearer <token>'}
};

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/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

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

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0")
  .get()
  .addHeader("Authorization", "Bearer <token>")
  .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/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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('GET', 'https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();

import http.client

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

headers = { 'Authorization': "Bearer <token>" }

conn.request("GET", "/customer-api/v1/asset-tracking/asset/field-definition/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", headers=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/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())

use reqwest;

#[tokio::main]
pub async fn main() {
    let url = "https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0";

    let mut headers = reqwest::header::HeaderMap::new();
    headers.insert("Authorization", "Bearer <token>".parse().unwrap());

    let client = reqwest::Client::new();
    let response = client.get(url)
        .headers(headers)
        .send()
        .await;

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

    dbg!(results);
}

curl --request GET \
  --url https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

wget --quiet \
  --method GET \
  --header 'Authorization: Bearer <token>' \
  --output-document \
  - https://your-instance.seventhings.com/customer-api/v1/asset-tracking/asset/field-definition/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Get a 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.

fieldDefinitionUuid

required

string format: uuid

The UUID of the field definition to get.

Responses

200

Success

application/json

A field definition

object

uuid

required

string format: uuid

field_key

required

The key of the field

string

>= 1 characters <= 64 characters

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

comment

The comment of the field

string

default_value

One of:

boolean

possible_values

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

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

Example

{
  "field_type": {
    "name": "ATTACHMENT",
    "constraints": [
      {
        "type": "allowed_values"
      }
    ]
  },
  "label": "general_information",
  "comment": "Additional info about the field",
  "attributes": [
    {
      "type": "form_group",
      "value": "General"
    }
  ],
  "relations": [
    {
      "type": "actual_field"
    }
  ]
}

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.

404

The requested resource could not be found.

406

The requested resource representation has no acceptable format.

500

Internal Server Error.