Get a unit (parent or child) by id
curl --request GET \
--url http://localhost:3000/rs/units/v1/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/rs/units/v1/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/rs/units/v1/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/rs/units/v1/{id}",
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;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/rs/units/v1/{id}"
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(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/rs/units/v1/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/rs/units/v1/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"type": "parent",
"name": "<string>",
"description": "<string>",
"serialNumber": "<string>",
"openedAt": "2023-11-07T05:31:56Z",
"logo": {
"name": "<string>",
"mimeType": "<string>",
"size": 536870912,
"storageKey": "<string>"
},
"activityTypes": [
"J"
],
"classifications": [
"erp"
],
"totalSurfaceArea": 4503599627370495,
"publicCapacity": 4503599627370495,
"privateCapacity": 4503599627370495,
"pinCode": "<string>",
"pinCodeRequired": true,
"accessInstructions": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"addressCountry": "<string>",
"addressCity": "<string>",
"addressPostalCode": "<string>",
"addressStreet": "<string>",
"category": "1",
"commissionPeriodicityYears": 3,
"parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sortOrder": 0,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"actions": {
"canBeUpdated": true
},
"updatableFields": {
"name": true,
"description": true,
"serialNumber": true,
"openedAt": true,
"accessInstructions": true,
"activityTypes": true,
"classifications": true,
"totalSurfaceArea": true,
"publicCapacity": true,
"privateCapacity": true,
"pinCodeRequired": true,
"addressCountry": true,
"addressCity": true,
"addressPostalCode": true,
"addressStreet": true,
"category": true,
"commissionPeriodicityYears": true,
"tagIds": true
},
"parent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>",
"type": "parent"
},
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"color": "<string>",
"type": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "unit"
}
}
],
"logoUrl": "<string>",
"position": {
"buildings": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>",
"type": "rs",
"plans": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>",
"type": "rs",
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>",
"type": "point",
"entityType": "custom",
"xPercent": 50,
"yPercent": 50
}
]
}
]
}
]
},
"qrcode": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scanUrl": "<string>"
},
"responsibles": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>"
}
]
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}units
Get a unit (parent or child) by id
GET
/
rs
/
units
/
v1
/
{id}
Get a unit (parent or child) by id
curl --request GET \
--url http://localhost:3000/rs/units/v1/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/rs/units/v1/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3000/rs/units/v1/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/rs/units/v1/{id}",
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;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/rs/units/v1/{id}"
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(string(body))
}HttpResponse<String> response = Unirest.get("http://localhost:3000/rs/units/v1/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/rs/units/v1/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"type": "parent",
"name": "<string>",
"description": "<string>",
"serialNumber": "<string>",
"openedAt": "2023-11-07T05:31:56Z",
"logo": {
"name": "<string>",
"mimeType": "<string>",
"size": 536870912,
"storageKey": "<string>"
},
"activityTypes": [
"J"
],
"classifications": [
"erp"
],
"totalSurfaceArea": 4503599627370495,
"publicCapacity": 4503599627370495,
"privateCapacity": 4503599627370495,
"pinCode": "<string>",
"pinCodeRequired": true,
"accessInstructions": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"addressCountry": "<string>",
"addressCity": "<string>",
"addressPostalCode": "<string>",
"addressStreet": "<string>",
"category": "1",
"commissionPeriodicityYears": 3,
"parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sortOrder": 0,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"actions": {
"canBeUpdated": true
},
"updatableFields": {
"name": true,
"description": true,
"serialNumber": true,
"openedAt": true,
"accessInstructions": true,
"activityTypes": true,
"classifications": true,
"totalSurfaceArea": true,
"publicCapacity": true,
"privateCapacity": true,
"pinCodeRequired": true,
"addressCountry": true,
"addressCity": true,
"addressPostalCode": true,
"addressStreet": true,
"category": true,
"commissionPeriodicityYears": true,
"tagIds": true
},
"parent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>",
"type": "parent"
},
"tags": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"color": "<string>",
"type": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "unit"
}
}
],
"logoUrl": "<string>",
"position": {
"buildings": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>",
"type": "rs",
"plans": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>",
"type": "rs",
"items": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>",
"type": "point",
"entityType": "custom",
"xPercent": 50,
"yPercent": 50
}
]
}
]
}
]
},
"qrcode": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scanUrl": "<string>"
},
"responsibles": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>"
}
]
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Query Parameters
Extend options (JSON-encoded array, e.g. ?extend=["category"]):
- "actions-info": Projects
{ canBeUpdated }for the current viewer. - "updatable-fields": Per-field write rules for this unit in its current state.
- "parent": Parent unit summary (null on a parent unit).
- "tags": The unit's tags with their tag type.
- "logo-url": Presigned download URL for the unit logo (null when no logo).
- "position": Structural context under the unit: buildings → plans → plan items.
- "qrcode": Sticker scan URL for the QR code linked to this unit (null when none).
- "responsibles": Adds
responsibles- the users responsible for this element.
Available options:
actions-info, updatable-fields, parent, tags, logo-url, position, qrcode, responsibles Narrow the result to the requested unit ids.
Maximum array length:
250Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Example:
[
"550e8400-e29b-41d4-a716-446655440000",
"6ba7b810-9dad-11d1-80b4-00c04fd430c8"
]
Narrow the result to units linked to the requested technical installations.
Maximum array length:
250Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Example:
[
"550e8400-e29b-41d4-a716-446655440000",
"6ba7b810-9dad-11d1-80b4-00c04fd430c8"
]
Response
Default Response
Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Maximum string length:
40Pattern:
^[A-Z]+-[1-9]\d*(?:-[A-Z]+-[1-9]\d*)*$Available options:
parent, child Required string length:
1 - 150Maximum string length:
1000Required string length:
1 - 20Show child attributes
Show child attributes
Available options:
J, L, M, N, O, P, R, S, T, U, V, W, X, Y, PA, CTS, SG, OA, REF, PS, GHA, GHO, GHR, GHS, GHTC, GHU, GHW1, GHW2, GHZ, ITGH Available options:
erp, ert, igh, icpe, hab, other Required range:
0 < x <= 9007199254740991Required range:
0 <= x <= 9007199254740991Required range:
0 <= x <= 9007199254740991Pattern:
^\d{6}$Maximum string length:
1000Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Required string length:
1 - 200Required string length:
1 - 200Required string length:
1 - 20Required string length:
1 - 200Available options:
1, 2, 3, 4, 5 Available options:
3 Pattern:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Required range:
-9007199254740991 <= x <= 9007199254740991Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes