Cette API utilise le protocole JSON RPC.
\nSeuls ces endpoint sont disponibles :
\nweb/session/authenticateweb/session/get_session_infoweb/session/change_passwordweb/dataset/getweb/dataset/search_readweb/dataset/createweb/user/createweb/user/forgot_passwordIls doivent tous être appelés avec la méthode POST. Le corps de la requête sera utilisé pour choisir la ressource à atteindre et les champs à récupérer.
\nAuthentifiez-vous avec la requête authenticate grâce aux éléments qui vous seront fournis par votre chef de projet. Récupérer le session_id, il sera indispensable dans les autres requêtes pour vous identifier.
Le champ fields correspond aux champs rappatriés.
Le champ domain correspond aux critères de filtrage de la requète.
Dans toutes les requêtes, le context suivant est à insérer dans l'objet params de chaque requête :
{\n \"__ref\": \"compound_context\",\n \"__contexts\": [\n {\n \"lang\": \"fr_FR\",\n \"tz\": \"Europe/Paris\",\n \"uid\": null\n },\n { \"bin_size\": true }\n ],\n \"__eval_context\": null\n}\nLes filtres, domain dans les requêtes, sont des listes de listes contenant 3 éléments qui sont :
-le nom du champ\n-un opérateur (=,!=,is not,in,...)\n-une valeur
\nExemple de filtre
\n{\n \"params\": {\n \"domain\": [[\"gender\", \"=\", \"male\"], [\"age\", \">\", 28]]\n }\n}\nOn cherche ici des hommes qui on plus de 28 ans.
\nAutre exemple avec un filtre OU :
\n{\n ...,\n \"params\": {\n \"domain\": [\n [\"|\"],\n [\"gender\", \"=\", \"female\"],\n [\"gender\", \"=\", false]\n ]\n }\n}\nOn cherche ici des ressource qui sont soit des femme soit qui n’ont pas spécifié de genre.
\nEn cas d’erreur dans la construction de la requête, le serveur renverra toujours une réponse 200. \nIl convient de parser la corps de la réponse pour lire l’objet error.
Exemple de réponse d’erreur
\n{\n \"jsonrpc\": \"2.0\",\n \"id\": \"r1\",\n \"error\": {...}\n}\nRécupère tous les sites sans restriction, les champs rappatriées des sites ne sont pas exhaustifs.
\n","urlObject":{"path":["web","dataset","search_read"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"6c52d571-08a1-4727-a5e9-9800cbefbe27"},{"name":"Create sites","id":"17c1f746-f079-4e84-bec6-0792cbd60188","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"r52\",\n \"jsonrpc\": \"2.0\",\n \"method\": \"call\",\n \"params\": {\n \"data\": {\n\t\t\t\"name\": \"Mon site\",\n\t\t\t\"type_id\": {{id_site_categorie}},\n \"parent_id\": {{id_site_parent}},\n \"code\": false,\n \"service_ids\": [],\n \"site_parent_id\": false,\n \"color\": \"#2882A3\",\n \"active\": true,\n \"block_booking\": true,\n \"resa_user_manager_ids\": [],\n \"max_bookable_qty\": 0,\n \"custom_fields\": false,\n \"resa_service_manager_ids\": [],\n \"service_bookable_ids\": [],\n \"description\": false,\n \"osm_zoom\": 16,\n \"phone\": false,\n \"alarm\": false,\n \"date_start\": false,\n \"date_end\": false,\n \"amiante\": false,\n \"pmr\": false,\n \"state\": \"good\",\n \"street\": \"Rue\",\n \"street2\": \"suite\",\n \"city\": \"Nantes\",\n \"zip\": \"44000\",\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"surface\": 0,\n \"surface_plancher\": 0,\n \"igh\": false\n },\n \"model\": \"openstc.site\",\n \"session_id\": \"{{sessionId}}\"\n }\n}"},"url":"{{server}}/web/dataset/create","description":"Définissez tout les attributs que vous souhaitez:
\nGénéral
\nRéservation
\nCartographie
\nPatrimoine
\n[\n {\n \"type\": [\n \"text\",\n \"Chaine de caractères\"\n ],\n \"key\": \"Mon attribut\",\n \"value\": \"Ma valeur\"\n }\n]\n\nNote: Certains champs peuvent ne pas exister en base de donnée en fonction des modules que vous avez d'activé.
\n","urlObject":{"path":["web","dataset","create"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"17c1f746-f079-4e84-bec6-0792cbd60188"},{"name":"Patch sites","id":"0ac933e2-9da3-4efd-9a50-23bba142f5c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"r52\",\n \"jsonrpc\": \"2.0\",\n \"method\": \"call\",\n \"params\": {\n \"data\": {\n\t\t\t\"name\": \"Mon site\",\n\t\t\t\"type_id\": {{id_site_categorie}},\n \"parent_id\": {{id_site_parent}},\n \"code\": false,\n \"service_ids\": [],\n \"site_parent_id\": false,\n \"color\": \"#2882A3\",\n \"active\": true,\n \"block_booking\": true,\n \"resa_user_manager_ids\": [],\n \"max_bookable_qty\": 0,\n \"custom_fields\": false,\n \"resa_service_manager_ids\": [],\n \"service_bookable_ids\": [],\n \"description\": false,\n \"osm_zoom\": 16,\n \"phone\": false,\n \"alarm\": false,\n \"date_start\": false,\n \"date_end\": false,\n \"amiante\": false,\n \"pmr\": false,\n \"state\": \"good\",\n \"street\": \"Rue\",\n \"street2\": \"suite\",\n \"city\": \"Nantes\",\n \"zip\": \"44000\",\n \"length\": 0,\n \"width\": 0,\n \"height\": 0,\n \"surface\": 0,\n \"surface_plancher\": 0,\n \"igh\": false\n },\n \"id\": {{id_site}},\n \"model\": \"openstc.site\",\n \"session_id\": \"{{sessionId}}\"\n }\n}"},"url":"{{server}}/web/dataset/save","description":"Définissez tout les attributs que vous souhaitez:
\nGénéral
\nRéservation
\nCartographie
\nPatrimoine
\n[\n {\n \"type\": [\n \"text\",\n \"Chaine de caractères\"\n ],\n \"key\": \"Mon attribut\",\n \"value\": \"Ma valeur\"\n }\n]\n\nNote: Certains champs peuvent ne pas exister en base de donnée en fonction des modules que vous avez d'activé.
\nSans oublier l'ID du site que vous souhaitez modifier.
\n","urlObject":{"path":["web","dataset","save"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0ac933e2-9da3-4efd-9a50-23bba142f5c1"}],"id":"27a8ccbf-5f8d-4929-a3c5-026a3c84c7ea","_postman_id":"27a8ccbf-5f8d-4929-a3c5-026a3c84c7ea","description":""},{"name":"Équipements","item":[{"name":"Get equipments","id":"0a76812b-84a4-4d50-8160-00f73e016a78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \n \"id\": \"r52\",\n \"jsonrpc\": \"2.0\",\n \"method\": \"call\",\n \"params\": {\n \"domain\": [\n \t\"|\",\n \t[\"internal_booking\", \"=\", true],\n \t[\"external_booking\", \"=\", true]\n ],\n \"fields\": [\n \"actions\",\n \"attachment_count\",\n \"complete_name\",\n \"product_image\",\n \"categ_id\",\n \"name\",\n \"description\",\n \"elevation\",\n \"model_id\",\n \"fuel_id\",\n \"qty_available\",\n \"state\",\n \"km\",\n \"km_per_year\",\n \"time\",\n \"time_per_year\",\n \"site_id\",\n \"immat\",\n \"serial_number\",\n \"serial_chassis\",\n \"serial_engine\",\n \"serial_badge_fuel\",\n \"serial_keys\",\n \"horse_power\",\n \"administrative_power\",\n \"marque\",\n \"energy_type\",\n \"built_date\",\n \"supplier_id\",\n \"length_amort\",\n \"purchase_price\",\n \"purchase_date\",\n \"hour_price\",\n \"warranty_date\",\n \"date_start\",\n \"life_duration\",\n \"date_end\",\n \"parent_id\",\n \"custom_fields\",\n \"geometry\",\n \"geo_point\",\n \"osm_type\",\n \"osm_id\",\n \"osm_zoom\"\n ],\n \"model\": \"openstc.equipment\",\n \"session_id\": \"{{sessionId}}\"\n }\n}"},"url":"{{server}}/web/dataset/search_read","description":"Récupère tous les équipements réservable en interne ou en externe et permet de récupérer ces données :
\n[idCategorie, NomCategorie])Définissez tout les attributs que vous souhaitez:
\nGénéral
\nPatrimoine
\n\n {\n \"type\": [\n \"text\",\n \"Chaine de caractères\"\n ],\n \"key\": \"Mon attribut\",\n \"value\": \"Ma valeur\"\n }\n]\n\n\nDéfinissez tout les attributs que vous souhaitez:
\nGénéral
\nPatrimoine
\n\n {\n \"type\": [\n \"text\",\n \"Chaine de caractères\"\n ],\n \"key\": \"Mon attribut\",\n \"value\": \"Ma valeur\"\n }\n]\n\n\nSans oubliez son ID pour savoir quel équipement est à modifier.
\n","urlObject":{"path":["web","dataset","save"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"54b0b99a-a6c2-4d15-8f61-92e0099f67ad"}],"id":"4c14fb6d-6d9c-4aac-99d3-e2147977a4a0","_postman_id":"4c14fb6d-6d9c-4aac-99d3-e2147977a4a0","description":""},{"name":"Utilisateurs","item":[{"name":"Récupérer l'utilisateur courant","event":[{"listen":"test","script":{"id":"46232b03-8c29-4fcd-8cd6-dba5be5324ba","exec":["var jsonData = JSON.parse(responseBody);","","/*"," * TESTS "," */","","","","","/*"," * LOGIC"," */","","postman.setEnvironmentVariable(\"groupIdCitoyen\", jsonData.result.records[0].id);","","","/*"," * SCENARIO"," */ ","","postman.setEnvironmentVariable(\"lastStepScenarioCitoyen\", \"Get GroupId for CITIZEN\");","postman.setNextRequest(\"000 - Global Scenario\");"],"type":"text/javascript"}}],"id":"8b55a609-b755-4669-bbf9-042843ad5fe8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json;charset=UTF-8"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\":\"2.0\",\n \"method\":\"call\",\n \"params\":{\n \"fields\": [\"address_id\", \"city\", \"complete_name\", \"email\", \"id\", \"lastname\", \"login\", \"mobile\", \"name\", \"partner_id\", \"phone\", \"street\", \"zip\"],\n \"id\": [14]\n \"model\": \"res.users\",\n \"session_id\": \"{{sessionId}}\"\n }\n}"},"url":"{{server}}/web/dataset/get","description":"Permet de récupérer les informations de l’utilisateur courant.
\n\"id\" est une liste d'entiers.
Remplacer le 14 de la liste \"id\" par l'id de l'utilisateur récupéré grâce à la requette authenticate.
Créer un utilisateur
\n","urlObject":{"path":["web","dataset","create"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8ca5a7e6-367e-4ef7-b941-907fc7e5a020"}],"id":"974a3e35-be58-48c6-8084-79bbea21001d","_postman_id":"974a3e35-be58-48c6-8084-79bbea21001d","description":""},{"name":"Demandes d'intervention (ou Signalements)","item":[{"name":"Récupérer les demandes d'intervention","id":"e43a8cbe-e1d9-45fe-826e-7ed095702858","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"jsonrpc\":\"2.0\",\n \"method\":\"call\",\n \"params\":{\n \"sort\":\"name ASC\",\n \"model\":\"openstc.ask\",\n \"fields\": [\"id\", \"name\", \"geo_point\", \"description\", \"type_id\", \"create_uid\", \"create_date\", \"partner_address\", \"partner_id\", \"service_id\", \"state\"],\n \"session_id\": \"{{sessionId}}\",\n \"offset\": false\n }\n}"},"url":"{{server}}/web/dataset/search_read","description":"Exemple de filtre applicable :
\n{\n \"params\": {\n \"domain\":[\n [\"id\", \"!=\", false],\n [\"geo_point\", \"!=\", false],\n [\"partner_address\", \"!=\", false],\n [\"service_id\", \"!=\", false],\n [\"partner_id\", \"=\", {{partnerId}}],\n \"|\",\n [\"state\", \"not in\", [\"draft\", \"finished\", \"refused\"]],\n \"&\",\n [\"state\", \"=\", [\"draft\"]],\n [\"create_uid\", \"=\", {{uid}}]\n ]\n }\n}\nPremière requête à executer pour accéder aux autres ressources.
\nLes champs requis sont :
\nloginpassworddb (nom de la base de données)Le nom de la base de données est à demander au préalable
\nIl faut s'assurer qu'un id soit bien de type numérique dans la réponse sans quoi cela voudrait dire que le session_id est invalide. Récupérez le session_id pour le passer dans toutes les autres requêtes.
Retourne les informations sur la session actuelle.
\n","urlObject":{"path":["web","session","get_session_info"],"host":["{{server}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c1c43ffc-6107-4767-ab82-5347bdd7d6f4"}],"event":[{"listen":"prerequest","script":{"id":"420738bf-ee61-4ab1-abbf-dd5841b5c936","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"35a5bf43-1965-43f1-980e-775cc918a1bb","type":"text/javascript","exec":[""]}}]}