Get one intervention
curl --request GET \
--url http://localhost:3000/rs/interventions/v1/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/rs/interventions/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/interventions/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/interventions/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/interventions/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/interventions/v1/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/rs/interventions/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": "preventive",
"status": "draft",
"title": "<string>",
"description": "<string>",
"creationStatus": "scheduled",
"isPlanned": true,
"autoCreated": true,
"scheduledStart": "2023-11-07T05:31:56Z",
"scheduledEnd": "2023-11-07T05:31:56Z",
"dueAt": "2023-11-07T05:31:56Z",
"actualStart": "2023-11-07T05:31:56Z",
"actualEnd": "2023-11-07T05:31:56Z",
"verifiedAt": "2023-11-07T05:31:56Z",
"decisionComment": "<string>",
"historizedAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"assignedUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assignedContactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"routineId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"verifiedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assignedUser": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
},
"assignedContact": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "jsmith@example.com",
"provider": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
},
"units": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
}
],
"equipments": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
}
],
"verifiedByUser": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
},
"_count": {
"signatures": 4503599627370495
},
"commentsCount": 4503599627370495,
"reportsCount": 4503599627370495,
"actions": {
"canBeUpdated": true,
"canBeArchived": true,
"canBeUnarchived": true,
"canBeDeleted": true,
"canBeVerified": true,
"canSetCompliances": true
},
"createdBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
},
"routine": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
},
"anomaliesStats": {
"total": 4503599627370495,
"extracted": 4503599627370495,
"unreviewed": 4503599627370495,
"pending": 4503599627370495,
"resolved": 4503599627370495
},
"rule": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"rules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"rulesCount": 4503599627370495,
"technicalInstallations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"imageUrl": "<string>"
}
],
"signedBy": "<string>",
"signatures": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"signerName": "<string>",
"signerRole": "<string>",
"signedAt": "2023-11-07T05:31:56Z",
"comment": "<string>",
"trace": {
"strokes": [
[
{
"x": 123,
"y": 123,
"t": 1
}
]
],
"width": 1,
"height": 1
},
"unit": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"provider": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"coverages": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"complianceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rule": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"validityDuration": "<string>"
},
"target": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "site"
}
}
],
"coveragesCount": 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>"
}interventions
Get one intervention
GET
/
rs
/
interventions
/
v1
/
{id}
Get one intervention
curl --request GET \
--url http://localhost:3000/rs/interventions/v1/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/rs/interventions/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/interventions/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/interventions/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/interventions/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/interventions/v1/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/rs/interventions/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": "preventive",
"status": "draft",
"title": "<string>",
"description": "<string>",
"creationStatus": "scheduled",
"isPlanned": true,
"autoCreated": true,
"scheduledStart": "2023-11-07T05:31:56Z",
"scheduledEnd": "2023-11-07T05:31:56Z",
"dueAt": "2023-11-07T05:31:56Z",
"actualStart": "2023-11-07T05:31:56Z",
"actualEnd": "2023-11-07T05:31:56Z",
"verifiedAt": "2023-11-07T05:31:56Z",
"decisionComment": "<string>",
"historizedAt": "2023-11-07T05:31:56Z",
"archivedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"assignedUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assignedContactId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"routineId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"verifiedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"assignedUser": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
},
"assignedContact": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"email": "jsmith@example.com",
"provider": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
},
"units": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
}
],
"equipments": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
}
],
"verifiedByUser": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
},
"_count": {
"signatures": 4503599627370495
},
"commentsCount": 4503599627370495,
"reportsCount": 4503599627370495,
"actions": {
"canBeUpdated": true,
"canBeArchived": true,
"canBeUnarchived": true,
"canBeDeleted": true,
"canBeVerified": true,
"canSetCompliances": true
},
"createdBy": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
},
"routine": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
},
"anomaliesStats": {
"total": 4503599627370495,
"extracted": 4503599627370495,
"unreviewed": 4503599627370495,
"pending": 4503599627370495,
"resolved": 4503599627370495
},
"rule": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"rules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"rulesCount": 4503599627370495,
"technicalInstallations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"imageUrl": "<string>"
}
],
"signedBy": "<string>",
"signatures": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"signerName": "<string>",
"signerRole": "<string>",
"signedAt": "2023-11-07T05:31:56Z",
"comment": "<string>",
"trace": {
"strokes": [
[
{
"x": 123,
"y": 123,
"t": 1
}
]
],
"width": 1,
"height": 1
},
"unit": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"provider": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"coverages": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"complianceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"rule": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"validityDuration": "<string>"
},
"target": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "site"
}
}
],
"coveragesCount": 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.
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"]):
- "assignee": Resolve the assigned user (id/ref/name) and the assigned provider contact (name, email, provider).
- "units": Resolves every unit the intervention concerns - through its compliances, its anomalies, or the units and equipments it directly targets.
- "equipments": Resolves every equipment the intervention concerns - through its compliances, or the equipments it directly targets.
- "verification": Resolve the verifying user (id/ref/name); verifiedAt and decisionComment are in the default shape.
- "counts": Adds
_countof linked signatures (the delete guard), pluscommentsCountandreportsCount. - "actions-info": Adds
actions{ canBeUpdated, canBeArchived, canBeUnarchived, canBeDeleted, canBeVerified }. - "createdBy": Include the creator's identity as
createdBy(id, ref, name). - "routine": Resolve the linked routine (id/ref/name).
- "anomalies-stats": Adds
anomaliesStats(counts of the linked anomalies by status). - "rules": Adds the covered rules, deduplicated (
rulewhen exactly one,ruleslist,rulesCount). - "technical-installations": Technical installations behind the covered rules (main + concerned), deduped with presigned images.
- "signed-by": Adds
signedBy(name of the latest signer, null until a signature exists). - "signatures": Adds the signatures (signer, role, date, comment, handwritten trace, unit, provider) with the compliance coverages each one signed off. A trace that does not match the capture shape comes back null.
Available options:
assignee, units, equipments, verification, counts, actions-info, createdBy, routine, anomalies-stats, rules, technical-installations, signed-by, signatures 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:
preventive, curative, troubleshooting, audit, exercise, session, qualification Available options:
draft, to_be_scheduled, scheduling_in_progress, scheduled, in_progress, awaiting_report, awaiting_proof, awaiting_validation, validated, rejected Required string length:
1 - 200Maximum string length:
2000Available options:
scheduled, done Maximum string length:
2000Pattern:
^([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)$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
Required range:
0 <= x <= 9007199254740991Required range:
0 <= 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
Required range:
0 <= x <= 9007199254740991Show child attributes
Show child attributes
Show child attributes
Show child attributes