{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"c27f43be-2508-4508-bdaf-e0373ff2a653","name":"OpenGST - Documentation de l'API","description":"# Documentation des requêtes disponibles dans OpenGST.\n\nCette API utilise le protocole JSON RPC.\n\nSeuls ces endpoint sont disponibles :\n\n- `web/session/authenticate`\n- `web/session/get_session_info`\n- `web/session/change_password`\n- `web/dataset/get`\n- `web/dataset/search_read`\n- `web/dataset/create`\n- `web/user/create`\n- `web/user/forgot_password`\n\nIls 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.\n\n## Avant de commencer\n\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.\n\nLe champ `fields` correspond aux champs rappatriés.  \nLe champ `domain` correspond aux critères de filtrage de la requète.\n\nDans toutes les requêtes, le `context` suivant est à insérer dans l'objet `params` de chaque requête : \n\n``` json\n{\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}\n```\n\n## Filtres OpenERP\n\nLes filtres, `domain` dans les requêtes, sont des listes de listes contenant 3 éléments qui sont :\n\n-le nom du champ\n-un opérateur (=,!=,is not,in,...)\n-une valeur\n\n_Exemple de filtre_\n\n``` json\n{\n    \"params\": {\n        \"domain\": [[\"gender\", \"=\", \"male\"], [\"age\", \">\", 28]]\n    }\n}\n```\n\nOn cherche ici des hommes qui on plus de 28 ans.\n\nAutre exemple avec un filtre OU :\n\n```json\n{\n    ...,\n    \"params\": {\n        \"domain\": [\n            [\"|\"],\n            [\"gender\", \"=\", \"female\"],\n            [\"gender\", \"=\", false]\n        ]\n    }\n}\n```\n\nOn cherche ici des ressource qui sont soit des femme soit qui n’ont pas spécifié de genre.\n\n## Gestion des erreurs\n\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`.\n\n_Exemple de réponse d’erreur_\n\n```json\n{\n    \"jsonrpc\": \"2.0\",\n    \"id\": \"r1\",\n    \"error\": {...}\n}\n```","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1179953","team":25406,"collectionId":"c27f43be-2508-4508-bdaf-e0373ff2a653","publishedId":"SW7aZ8tT","public":true,"publicUrl":"https://doc-api.opengst.fr","privateUrl":"https://go.postman.co/documentation/1179953-c27f43be-2508-4508-bdaf-e0373ff2a653","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"01364D"},"documentationLayout":"classic-double-column","customisation":{"metaTags":[{"name":"description","value":""},{"name":"title","value":""}],"appearance":{"default":"light","themes":[{"name":"dark","logo":"https://content.pstmn.io/f5187dcc-2fc2-403e-a521-1e625d29e710/TG9nb19PcGVuR1NULnBuZw==","colors":{"top-bar":"212121","right-sidebar":"303030","highlight":"01364D"}},{"name":"light","logo":"https://content.pstmn.io/98f96c44-de85-468c-b3b5-a3e06bc64f47/TG9nb19PcGVuR1NULnBuZw==","colors":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"01364D"}}]}},"version":"8.10.1","publishDate":"2024-10-30T10:24:26.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{"title":"","description":""},"logos":{"logoLight":"https://content.pstmn.io/98f96c44-de85-468c-b3b5-a3e06bc64f47/TG9nb19PcGVuR1NULnBuZw==","logoDark":"https://content.pstmn.io/f5187dcc-2fc2-403e-a521-1e625d29e710/TG9nb19PcGVuR1NULnBuZw=="}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/27e59cc3cd79c4b1dc1f9a30132564a974b489a20329c6320b0c8ea11e3bf9db","favicon":"https://opengst.fr/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://doc-api.opengst.fr/view/metadata/SW7aZ8tT"}