Get one routine
curl --request GET \
--url http://localhost:3000/rs/routines/v1/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/rs/routines/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/routines/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/routines/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/routines/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/routines/v1/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/rs/routines/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>",
"type": "preventive",
"autoCreateEnabled": true,
"autoAttachEnabled": true,
"rrule": "<string>",
"dateKind": "scheduled",
"archivedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"assignedUser": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"assignedContact": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"contract": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>",
"latestDocumentDueAt": "2023-11-07T05:31:56Z"
},
"compliances": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "site",
"dueAt": "2023-11-07T05:31:56Z"
}
],
"_count": {
"compliances": 4503599627370495,
"interventions": 4503599627370495
},
"actions": {
"canBeUpdated": true,
"canBeArchived": true,
"canBeUnarchived": true,
"canBeDeleted": true
},
"sites": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
}
],
"users": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"rules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"workflowType": "calendar",
"complianceType": "registry"
}
],
"rulesCount": 4503599627370495,
"technicalInstallations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"imageUrl": "<string>"
}
],
"establishments": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
}
],
"lastIntervention": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"date": "2023-11-07T05:31:56Z"
},
"nextIntervention": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"date": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}{
"error": "<string>",
"message": "<string>",
"requestId": "<string>",
"details": "<unknown>"
}routines
Get one routine
GET
/
rs
/
routines
/
v1
/
{id}
Get one routine
curl --request GET \
--url http://localhost:3000/rs/routines/v1/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "http://localhost:3000/rs/routines/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/routines/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/routines/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/routines/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/routines/v1/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/rs/routines/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>",
"type": "preventive",
"autoCreateEnabled": true,
"autoAttachEnabled": true,
"rrule": "<string>",
"dateKind": "scheduled",
"archivedAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"assignedUser": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"assignedContact": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"contract": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>",
"latestDocumentDueAt": "2023-11-07T05:31:56Z"
},
"compliances": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "site",
"dueAt": "2023-11-07T05:31:56Z"
}
],
"_count": {
"compliances": 4503599627370495,
"interventions": 4503599627370495
},
"actions": {
"canBeUpdated": true,
"canBeArchived": true,
"canBeUnarchived": true,
"canBeDeleted": true
},
"sites": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
}
],
"users": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
}
],
"rules": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"workflowType": "calendar",
"complianceType": "registry"
}
],
"rulesCount": 4503599627370495,
"technicalInstallations": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"imageUrl": "<string>"
}
],
"establishments": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"name": "<string>"
}
],
"lastIntervention": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"date": "2023-11-07T05:31:56Z"
},
"nextIntervention": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ref": "<string>",
"date": "2023-11-07T05:31:56Z"
}
}{
"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"]):
- "assigned-to": Resolves the assigned user, provider contact and contract.
- "compliances": Include the linked compliances (id, type, dueAt).
- "counts": Adds
_countof linked compliances and interventions. - "actions-info": Adds
actions{ canBeUpdated, canBeArchived, canBeUnarchived, canBeDeleted }. - "contract": Resolves the linked contract plus its latest document due date.
- "sites": Adds
sites- the deduped units linked via site-compliances. - "users": Adds
users- the deduped users linked via user-compliances. - "rule": Adds
rules(deduped, via compliances) andrulesCount. - "technical-installations": Adds the deduped technical installations covered by the routine (via compliances → rules), with presigned images.
- "establishment-cell": Adds
establishments- the deduped parent units of any linked cell. - "interventions": Adds
lastIntervention(most recent past) andnextIntervention(soonest upcoming).
Available options:
assigned-to, compliances, counts, actions-info, contract, sites, users, rule, technical-installations, establishment-cell, interventions 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:
1000Available options:
preventive, training_session, training_exercise, training_qualification Required string length:
1 - 500Available options:
scheduled, deadline 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
Required 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