curl --request GET \
--url http://localhost:3000/rs/equipments/v1/ \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/rs/equipments/v1/"
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/equipments/v1/', 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/equipments/v1/",
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/equipments/v1/"
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/equipments/v1/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/rs/equipments/v1/")
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{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>",
"description": "<string>",
"manufacturer": "<string>",
"externalReference": "<string>",
"condition": "new",
"availability": "in_service",
"purchasePrice": 499999999.995,
"replacementValue": 499999999.995,
"technicalInstallationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"unitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"installedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"installedAt": "2023-11-07T05:31:56Z",
"constructedAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"technicalInstallation": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
},
"unit": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
},
"installedBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"position": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"xPercent": 50,
"yPercent": 50
},
"containedIn": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"specifications": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"specificationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"specificationName": "<string>",
"specificationColor": "<string>"
}
],
"qrcode": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"activatedAt": "2023-11-07T05:31:56Z"
},
"qrcodes": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"number": 1073741823,
"activatedAt": "2023-11-07T05:31:56Z",
"firstAssociationAt": "2023-11-07T05:31:56Z"
}
],
"counts": {
"anomalies": 0,
"anomaliesToProcess": 0,
"anomaliesInProgress": 0,
"tickets": 0,
"compliances": 0,
"compliancesOverdue": 0,
"compliancesAtRisk": 0,
"compliancesOnTime": 0,
"compliancesNotStarted": 0,
"qrcodes": 0,
"responsibilities": 0,
"interventions": 0
},
"actions": {
"canBeUpdated": true,
"canBeArchived": true,
"canBeUnarchived": true,
"canBeDeleted": true
},
"updatableFields": {
"name": true,
"description": true,
"manufacturer": true,
"externalReference": true,
"condition": true,
"availability": true,
"purchasePrice": true,
"replacementValue": true,
"technicalInstallationId": true,
"unitId": true,
"installedById": true,
"installedAt": true,
"constructedAt": true,
"containedIn": true,
"specificationIds": true
},
"responsibles": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>"
}
],
"createdBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
}
}
],
"totalCount": 4503599627370495,
"pagination": {
"page": 4503599627370495,
"pageSize": 4503599627370495,
"totalPages": 4503599627370495
}
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}List equipments (paginated/filterable)
curl --request GET \
--url http://localhost:3000/rs/equipments/v1/ \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/rs/equipments/v1/"
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/equipments/v1/', 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/equipments/v1/",
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/equipments/v1/"
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/equipments/v1/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/rs/equipments/v1/")
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{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>",
"description": "<string>",
"manufacturer": "<string>",
"externalReference": "<string>",
"condition": "new",
"availability": "in_service",
"purchasePrice": 499999999.995,
"replacementValue": 499999999.995,
"technicalInstallationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"unitId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"installedById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"installedAt": "2023-11-07T05:31:56Z",
"constructedAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"technicalInstallation": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
},
"unit": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
},
"installedBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"position": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"planId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"xPercent": 50,
"yPercent": 50
},
"containedIn": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"specifications": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"specificationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"specificationName": "<string>",
"specificationColor": "<string>"
}
],
"qrcode": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"activatedAt": "2023-11-07T05:31:56Z"
},
"qrcodes": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"number": 1073741823,
"activatedAt": "2023-11-07T05:31:56Z",
"firstAssociationAt": "2023-11-07T05:31:56Z"
}
],
"counts": {
"anomalies": 0,
"anomaliesToProcess": 0,
"anomaliesInProgress": 0,
"tickets": 0,
"compliances": 0,
"compliancesOverdue": 0,
"compliancesAtRisk": 0,
"compliancesOnTime": 0,
"compliancesNotStarted": 0,
"qrcodes": 0,
"responsibilities": 0,
"interventions": 0
},
"actions": {
"canBeUpdated": true,
"canBeArchived": true,
"canBeUnarchived": true,
"canBeDeleted": true
},
"updatableFields": {
"name": true,
"description": true,
"manufacturer": true,
"externalReference": true,
"condition": true,
"availability": true,
"purchasePrice": true,
"replacementValue": true,
"technicalInstallationId": true,
"unitId": true,
"installedById": true,
"installedAt": true,
"constructedAt": true,
"containedIn": true,
"specificationIds": true
},
"responsibles": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "<string>"
}
],
"createdBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
}
}
],
"totalCount": 4503599627370495,
"pagination": {
"page": 4503599627370495,
"pageSize": 4503599627370495,
"totalPages": 4503599627370495
}
}{
"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.
Query Parameters
0 < x <= 90071992547409910 < x <= 1000When true, answers totalCount with an empty data: the rows are never read, so no extend is selected and no transform runs. For a badge or a counter.
true
Extend options (JSON-encoded array, e.g. ?extend=["category"]):
- "technical-installation": Adds
technicalInstallation(each equipment's technical installation). - "unit": Adds
unit(the unit each equipment is attached to, nullable). - "installed-by": Adds
installedBy(the installer provider, nullable). - "position": Adds
position(the marker on a plan, nullable). - "contained-in": Adds
containedIn(the zones/rooms each equipment sits in). - "specifications": Adds
specifications(the specification values tagging each equipment). - "qrcode": Adds
qrcode(the QR code associated to each equipment, nullable). - "qrcodes": Adds
qrcodes(every QR code associated to each equipment, by serial number). - "counts": Adds
counts(anomalies by processing state, tickets, compliances by status, QR codes, responsibilities and interventions attached to each equipment). - "actions-info": Projects
{ canBeUpdated, canBeArchived, canBeUnarchived, canBeDeleted }. - "updatable-fields": Per-field write rules for each equipment in its current state.
- "responsibles": Adds
responsibles- the users responsible for this element. - "created-by": Adds
createdBy(the user who created each equipment).
technical-installation, unit, installed-by, position, contained-in, specifications, qrcode, qrcodes, counts, actions-info, updatable-fields, responsibles, created-by Show child attributes
Show child attributes
Case-insensitive search across name and ref.
200"lobby"
Case-insensitive partial match on the name.
200"lobby"
When true, only archived; when false, only non-archived.
true
Narrow linked equipments to the requested unit ids.
250^([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)$[
"550e8400-e29b-41d4-a716-446655440000",
"6ba7b810-9dad-11d1-80b4-00c04fd430c8"
]
Narrow the result to the requested technical installations.
250^([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)$[
"550e8400-e29b-41d4-a716-446655440000",
"6ba7b810-9dad-11d1-80b4-00c04fd430c8"
]
Filter by condition (matches any of the given codes).
["new", "very_good"]
Filter by availability (matches any of the given codes).
["in_service", "in_stock"]
Filter by installer provider id.
250^([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)$[
"550e8400-e29b-41d4-a716-446655440000",
"6ba7b810-9dad-11d1-80b4-00c04fd430c8"
]
When true, only equipments with a position marker; when false, without.
true
Equipments belonging to the plan's unit that have no active plan position yet - feeds the plan's placement picker.
^([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)$Filter by creation date range.
- Option 1
- Option 2
Show child attributes
Show child attributes
{
"start": "2026-01-01",
"end": "2026-01-31"
}
Filter by last-update date range.
- Option 1
- Option 2
Show child attributes
Show child attributes
{
"start": "2026-01-01",
"end": "2026-01-31"
}
When true, restricts to equipments the current user is responsible for - holding a responsibility on the equipment, on its technical installation or on its unit. Narrows the caller’s visibility scope, never widens it.
true
When true, also returns soft-deleted equipments.
true