Get an equipment
curl --request GET \
--url http://localhost:3000/rs/equipments/v1/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/rs/equipments/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/equipments/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/equipments/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/equipments/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/equipments/v1/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/rs/equipments/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>",
"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>"
}
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}equipments
Get an equipment
GET
/
rs
/
equipments
/
v1
/
{id}
Get an equipment
curl --request GET \
--url http://localhost:3000/rs/equipments/v1/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/rs/equipments/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/equipments/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/equipments/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/equipments/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/equipments/v1/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/rs/equipments/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>",
"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>"
}
}{
"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"]):
- "technical-installation": Adds
technicalInstallation(the equipment's technical installation). - "unit": Adds
unit(the unit the 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 this equipment sits in). - "specifications": Adds
specifications(the specification values tagging this equipment). - "qrcode": Adds
qrcode(the QR code associated to this equipment, nullable). - "qrcodes": Adds
qrcodes(every QR code associated to this equipment, by serial number). - "counts": Adds
counts(anomalies by processing state, tickets, compliances by status, QR codes, responsibilities and interventions attached). - "actions-info": Projects
{ canBeUpdated, canBeArchived, canBeUnarchived, canBeDeleted }. - "updatable-fields": Per-field write rules for this equipment in its current state.
- "responsibles": Adds
responsibles- the users responsible for this element. - "created-by": Adds
createdBy(the user who created this equipment).
Available options:
technical-installation, unit, installed-by, position, contained-in, specifications, qrcode, qrcodes, counts, actions-info, updatable-fields, responsibles, created-by Narrow linked equipments 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 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*)*$Required string length:
1 - 150Maximum string length:
1000Required string length:
1 - 100Required string length:
1 - 100Available options:
new, very_good, good, average, bad Available options:
in_service, in_stock, in_repair, out_of_service Required range:
0 < x <= 999999999.99Required range:
0 < x <= 999999999.99Pattern:
^([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)$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)$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
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