Get a building work
curl --request GET \
--url http://localhost:3000/rs/building-works/v1/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/rs/building-works/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/building-works/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/building-works/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/building-works/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/building-works/v1/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/rs/building-works/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>",
"authorizationNumber": "<string>",
"status": "rejected",
"description": "<string>",
"workNature": "<string>",
"contractorName": "<string>",
"supervisingTechnicianName": "<string>",
"architectName": "<string>",
"receivedAt": "2023-11-07T05:31:56Z",
"startAt": "2023-11-07T05:31:56Z",
"endAt": "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",
"units": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
}
],
"commission": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"visitType": "vc",
"status": "to_schedule",
"decision": "favorable",
"heldAt": "2023-11-07T05:31:56Z"
},
"_count": {
"documents": 4503599627370495,
"commissions": 4503599627370495,
"units": 4503599627370495
},
"createdByUser": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"documents": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>",
"type": "cerfa",
"mimeType": "<string>",
"size": 536870912,
"createdAt": "2023-11-07T05:31:56Z",
"downloadUrl": "<string>"
}
],
"actions": {
"canBeUpdated": true,
"canBeReceived": true,
"canBeArchived": true,
"canBeUnarchived": true,
"canBeDeleted": true
},
"updatableFields": {
"authorizationNumber": true,
"status": true,
"description": true,
"workNature": true,
"contractorName": true,
"supervisingTechnicianName": true,
"architectName": true,
"startAt": true,
"endAt": true,
"unitIds": true
}
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}building-works
Get a building work
GET
/
rs
/
building-works
/
v1
/
{id}
Get a building work
curl --request GET \
--url http://localhost:3000/rs/building-works/v1/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/rs/building-works/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/building-works/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/building-works/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/building-works/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/building-works/v1/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/rs/building-works/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>",
"authorizationNumber": "<string>",
"status": "rejected",
"description": "<string>",
"workNature": "<string>",
"contractorName": "<string>",
"supervisingTechnicianName": "<string>",
"architectName": "<string>",
"receivedAt": "2023-11-07T05:31:56Z",
"startAt": "2023-11-07T05:31:56Z",
"endAt": "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",
"units": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
}
],
"commission": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"visitType": "vc",
"status": "to_schedule",
"decision": "favorable",
"heldAt": "2023-11-07T05:31:56Z"
},
"_count": {
"documents": 4503599627370495,
"commissions": 4503599627370495,
"units": 4503599627370495
},
"createdByUser": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"documents": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>",
"type": "cerfa",
"mimeType": "<string>",
"size": 536870912,
"createdAt": "2023-11-07T05:31:56Z",
"downloadUrl": "<string>"
}
],
"actions": {
"canBeUpdated": true,
"canBeReceived": true,
"canBeArchived": true,
"canBeUnarchived": true,
"canBeDeleted": true
},
"updatableFields": {
"authorizationNumber": true,
"status": true,
"description": true,
"workNature": true,
"contractorName": true,
"supervisingTechnicianName": true,
"architectName": true,
"startAt": true,
"endAt": true,
"unitIds": true
}
}{
"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"]):
- "units": Adds
units(the active units this building work targets). - "commission": Adds
commission(the most recently held safety commission, or null). - "counts": Adds
_countof linked documents, commissions and units. - "created-by": Adds the building work author (
createdByUserwith display name). - "documents": Adds
documents(the files attached to this building work, with a presigned download URL each). - "actions-info": Projects
{ canBeUpdated, canBeArchived, canBeUnarchived, canBeDeleted }. - "updatable-fields": Per-field write rules for this building work in its current state.
Available options:
units, commission, counts, created-by, documents, actions-info, updatable-fields 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 - 200Available options:
rejected, pending, approved, partially_received, received Maximum string length:
2000Maximum string length:
200Maximum string length:
200Maximum string length:
200Maximum string length:
200Show 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