Attractive City from Citopia provides APIs to interact with data from the CMS.
\nThis documentation will continue to improve as needed.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"7416397","collectionId":"71abee82-debf-4509-837a-89352f04003e","publishedId":"UVXgKwYK","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"35C2FF"},"publishDate":"2022-01-10T16:34:29.000Z"},"item":[{"name":"Authentication","item":[{"name":"Signin","event":[{"listen":"test","script":{"id":"4d38cd51-aef1-41cf-8baf-c9b822919b58","exec":["","pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","","let jsonData = JSON.parse(responseBody);","pm.environment.set(\"token\", jsonData.accessToken);","",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"80a9c710-7982-4513-8a00-25da01bd8813","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"usernameOrEmail\":\"{{accountUser}}\",\n \"password\":\"{{accountPwd}}\"\n}"},"url":"{{serverPath}}/api/auth/signin","description":"With the identifiers that will be provided to you, you must first authenticate yourself with a signin.
\nThe result :
\n{\n \"accessToken\": \"\",\n \"tokenType\": \"TYPE OF TOKEN\"\n}\n\nWith this token and the token type, you can now request the Apis
\n","urlObject":{"path":["api","auth","signin"],"host":["{{serverPath}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"80a9c710-7982-4513-8a00-25da01bd8813"}],"id":"a3e5c9de-cef6-4e3d-bcf6-c7b731d64984","description":"To access these APIs, you must ask BeAttractive to give you an account in order to access your data.
(User & password)
You are responsible for the use that will be made of these Apis.
\nAny action performed with (Add, Modify, Delete) cannot be restored
\nWe ask you not to communicate this information to third parties.
\n","_postman_id":"a3e5c9de-cef6-4e3d-bcf6-c7b731d64984"},{"name":"Reports","item":[{"name":"List of reports","event":[{"listen":"test","script":{"id":"0062f43a-8e80-4be0-87c7-9da323580fae","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","pm.test(\"Must have content items\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.content).to.not.be.empty;","});","","let jsonData = JSON.parse(responseBody);","pm.environment.set(\"report_id\", jsonData.content[0].id);",""],"type":"text/javascript","packages":{}}}],"id":"2c8732d8-507f-4cc6-a742-ba21fb063d9a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{serverPath}}/v1/reports?sort_column=dateSubmit&sort_direction=DESC&model=SIGNALEMENT","description":"List of parameters filter
\nResult of request :
\n{\n \"content\": [\n {\n \"id\": 1142,\n \"title\": null,\n \"token\": null,\n \"state\": {\n \"id\": 1,\n \"title\": \"A faire\"\n },\n \"dateSubmit\": 1585563467000,\n \"category\": null,\n \"subCategory\": null,\n \"description\": \"qsDF\",\n \"address\": null,\n \"positionMap\": null,\n \"user\": {\n \"id\": null,\n \"login\": null,\n \"type\": 0,\n \"lastName\": \"Daniel\",\n \"firstName\": \"Pereira\",\n \"email\": null,\n \"phone\": \"06000000\"\n },\n \"images\": [],\n \"comments\": [\n {\n \"id\": 1726,\n \"date\": 1581686032000,\n \"internal\": false,\n \"comment\": \"azezd\"\n }\n ],\n \"states\": [],\n \"grcUUID\" : null,\n \"model\": \"SIGNALEMENT\"\n }\n ],\n \"page\": 0,\n \"size\": 30,\n \"totalElements\": 274,\n \"totalPages\": 10,\n \"last\": false\n}\n\nyyyy-MM-dd'T'HH:mm:ss.SSSZ
\n","type":"text/plain"},"key":"submit_start","value":""},{"disabled":true,"description":{"content":"yyyy-MM-dd'T'HH:mm:ss.SSSZ
\n","type":"text/plain"},"key":"submit_end","value":""},{"disabled":true,"description":{"content":"boolean
\n","type":"text/plain"},"key":"grc","value":"false"},{"description":{"content":"title / dateSubmit
\n","type":"text/plain"},"key":"sort_column","value":"dateSubmit"},{"description":{"content":"ASC / DESC
\n","type":"text/plain"},"key":"sort_direction","value":"DESC"},{"description":{"content":"code of model report
\n","type":"text/plain"},"key":"model","value":"SIGNALEMENT"}],"variable":[]}},"response":[{"id":"51104d88-3574-42fb-bb31-847ef9a01f92","name":"Reports","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{serverPath}}/v1/reports?page=0&size=25&sortColumn=title&sortDirection=ASC&submitStart=2015-09-26T12:30:00.000-00:00&submitEnd=2020-09-26T01:30:00.000-01:00","host":["{{serverPath}}"],"path":["v1","reports"],"query":[{"key":"page","value":"0","description":"Optional by default is 0"},{"key":"size","value":"25","description":"Optional by default is 30"},{"key":"sortColumn","value":"title","description":"Optional by default is (dateSubmit). title, dateSubmit, ..."},{"key":"sortDirection","value":"ASC","description":"Optional (ASC or DESC). By defaut "},{"key":"submitStart","value":"2015-09-26T12:30:00.000-00:00"},{"key":"submitEnd","value":"2020-09-26T01:30:00.000-01:00"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"2c8732d8-507f-4cc6-a742-ba21fb063d9a"},{"name":"Report","id":"bac377aa-8104-46de-90b1-f8db75a2592b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{serverPath}}/v1/reports/:report_id","description":"","urlObject":{"path":["v1","reports",":report_id"],"host":["{{serverPath}}"],"query":[],"variable":[{"type":"any","value":"182443","key":"report_id"}]}},"response":[{"id":"19cda197-a34f-4bb9-b2e4-b1efb3b7c133","name":"Reports","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{serverPath}}/v1/reports?page=0&size=25&sortColumn=title&sortDirection=ASC&submitStart=2015-09-26T12:30:00.000-00:00&submitEnd=2020-09-26T01:30:00.000-01:00","host":["{{serverPath}}"],"path":["v1","reports"],"query":[{"key":"page","value":"0","description":"Optional by default is 0"},{"key":"size","value":"25","description":"Optional by default is 30"},{"key":"sortColumn","value":"title","description":"Optional by default is (dateSubmit). title, dateSubmit, ..."},{"key":"sortDirection","value":"ASC","description":"Optional (ASC or DESC). By defaut "},{"key":"submitStart","value":"2015-09-26T12:30:00.000-00:00"},{"key":"submitEnd","value":"2020-09-26T01:30:00.000-01:00"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"bac377aa-8104-46de-90b1-f8db75a2592b"},{"name":"State change","id":"29b746b9-9ae2-4394-82e3-067c77ea049e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"url":"{{serverPath}}/v1/reports/{{report_id}}/state/{{report_state_id}}","description":"","urlObject":{"path":["v1","reports","{{report_id}}","state","{{report_state_id}}"],"host":["{{serverPath}}"],"query":[],"variable":[]}},"response":[{"id":"b33664f4-b8ef-416a-be76-353e3c75f94b","name":"Reports","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{serverPath}}/v1/reports?page=0&size=25&sortColumn=title&sortDirection=ASC&submitStart=2015-09-26T12:30:00.000-00:00&submitEnd=2020-09-26T01:30:00.000-01:00","host":["{{serverPath}}"],"path":["v1","reports"],"query":[{"key":"page","value":"0","description":"Optional by default is 0"},{"key":"size","value":"25","description":"Optional by default is 30"},{"key":"sortColumn","value":"title","description":"Optional by default is (dateSubmit). title, dateSubmit, ..."},{"key":"sortDirection","value":"ASC","description":"Optional (ASC or DESC). By defaut "},{"key":"submitStart","value":"2015-09-26T12:30:00.000-00:00"},{"key":"submitEnd","value":"2020-09-26T01:30:00.000-01:00"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"29b746b9-9ae2-4394-82e3-067c77ea049e"},{"name":"Set report used on GRC","id":"34ceeca0-b4c8-46e2-a4c7-1d4b360b68f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"id\": \"{{grc_uuid}}\"\n}","options":{"raw":{"language":"json"}}},"url":"{{serverPath}}/v1/reports/{{report_id}}/grc","description":"Be Attractive offers to manage reports in GRC-360 from Citopia.
This POST allows to bind strongly with GRC-360
Send notification to client about a report
\n","urlObject":{"path":["v1","reports","{{report_id}}","notification"],"host":["{{serverPath}}"],"query":[],"variable":[]}},"response":[{"id":"1a662ef9-18c5-480a-a1b6-1b2478eec903","name":"Reports","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{serverPath}}/v1/reports?page=0&size=25&sortColumn=title&sortDirection=ASC&submitStart=2015-09-26T12:30:00.000-00:00&submitEnd=2020-09-26T01:30:00.000-01:00","host":["{{serverPath}}"],"path":["v1","reports"],"query":[{"key":"page","value":"0","description":"Optional by default is 0"},{"key":"size","value":"25","description":"Optional by default is 30"},{"key":"sortColumn","value":"title","description":"Optional by default is (dateSubmit). title, dateSubmit, ..."},{"key":"sortDirection","value":"ASC","description":"Optional (ASC or DESC). By defaut "},{"key":"submitStart","value":"2015-09-26T12:30:00.000-00:00"},{"key":"submitEnd","value":"2020-09-26T01:30:00.000-01:00"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"3a6b791e-0f45-4451-994e-25cf16a3fccb"},{"name":"Check tokens","id":"0b8d23ac-12e2-4804-91f0-302cbbf78fbc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"title\": \"test\",\n\t\"message\":\"Ceci est un essai\"\n}","options":{"raw":{"language":"json"}}},"url":"{{serverPath}}/v1/reports/check-token","description":"Set token to reports without token
\n","urlObject":{"path":["v1","reports","check-token"],"host":["{{serverPath}}"],"query":[],"variable":[]}},"response":[{"id":"d007d35a-cd69-4949-bd07-d18b945dd0a4","name":"Reports","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{serverPath}}/v1/reports?page=0&size=25&sortColumn=title&sortDirection=ASC&submitStart=2015-09-26T12:30:00.000-00:00&submitEnd=2020-09-26T01:30:00.000-01:00","host":["{{serverPath}}"],"path":["v1","reports"],"query":[{"key":"page","value":"0","description":"Optional by default is 0"},{"key":"size","value":"25","description":"Optional by default is 30"},{"key":"sortColumn","value":"title","description":"Optional by default is (dateSubmit). title, dateSubmit, ..."},{"key":"sortDirection","value":"ASC","description":"Optional (ASC or DESC). By defaut "},{"key":"submitStart","value":"2015-09-26T12:30:00.000-00:00"},{"key":"submitEnd","value":"2020-09-26T01:30:00.000-01:00"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"0b8d23ac-12e2-4804-91f0-302cbbf78fbc"},{"name":"Add comment","id":"fa37ccc3-d95a-457a-89d3-23dc666bad57","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"comment\":\"Add new public comment\"\n}","options":{"raw":{"language":"json"}}},"url":"{{serverPath}}/v1/reports/:report_id/comment","description":"Add new public comment to report.
\nComment displayed in mobil app.
\n","urlObject":{"path":["v1","reports",":report_id","comment"],"host":["{{serverPath}}"],"query":[],"variable":[{"description":{"content":"id of report
\n","type":"text/plain"},"type":"any","value":"","key":"report_id"}]}},"response":[{"id":"4bb46fc3-c491-4daa-96e6-55bee7f63953","name":"Reports","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{serverPath}}/v1/reports?page=0&size=25&sortColumn=title&sortDirection=ASC&submitStart=2015-09-26T12:30:00.000-00:00&submitEnd=2020-09-26T01:30:00.000-01:00","host":["{{serverPath}}"],"path":["v1","reports"],"query":[{"key":"page","value":"0","description":"Optional by default is 0"},{"key":"size","value":"25","description":"Optional by default is 30"},{"key":"sortColumn","value":"title","description":"Optional by default is (dateSubmit). title, dateSubmit, ..."},{"key":"sortDirection","value":"ASC","description":"Optional (ASC or DESC). By defaut "},{"key":"submitStart","value":"2015-09-26T12:30:00.000-00:00"},{"key":"submitEnd","value":"2020-09-26T01:30:00.000-01:00"}]}},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"fa37ccc3-d95a-457a-89d3-23dc666bad57"}],"id":"b41ce333-441c-4b77-a539-841fd48b0063","_postman_id":"b41ce333-441c-4b77-a539-841fd48b0063","description":""},{"name":"Report States","item":[{"name":"List of states","event":[{"listen":"test","script":{"id":"da3a38b9-e193-406b-a24e-51deded9401d","exec":["pm.test(\"Status code is 200\", function () {"," pm.response.to.have.status(200);","});","","let jsonData = JSON.parse(responseBody);","pm.environment.set(\"state_id\", jsonData.content[0].id);",""],"type":"text/javascript"}}],"id":"e9356bfb-917f-44d1-95a0-a2bedf2cd703","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{serverPath}}/v1/report-states","description":"List of paginated states of reports
\nResult of Request :
\n","urlObject":{"path":["v1","report-states"],"host":["{{serverPath}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e9356bfb-917f-44d1-95a0-a2bedf2cd703"},{"name":"State","event":[{"listen":"test","script":{"id":"913516e7-dd0b-4a98-9243-335110f49a96","exec":[""],"type":"text/javascript"}}],"id":"c34165c3-6842-46b0-b9f6-bfd60c0d6611","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{serverPath}}/v1/report-states/{{state_id}}","urlObject":{"path":["v1","report-states","{{state_id}}"],"host":["{{serverPath}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"c34165c3-6842-46b0-b9f6-bfd60c0d6611"}],"id":"8d437bc8-a9dd-4f7b-9511-88951271e00f","_postman_id":"8d437bc8-a9dd-4f7b-9511-88951271e00f","description":""},{"name":"Report Categories","item":[{"name":"List of categories","event":[{"listen":"test","script":{"id":"372ca8fc-9d4a-4738-ae23-9032db028699","exec":["pm.test(\"Must have content items\", function () {"," var jsonData = pm.response.json();"," pm.expect(jsonData.content).to.not.be.empty;","});","","let jsonData = JSON.parse(responseBody);","pm.environment.set(\"report_category_id\", jsonData.content[0].id);",""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"b2c4dade-b26e-42af-b5b5-3f357d42d717","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"clientuuid","value":"{{clientuuid}}","type":"text"}],"url":"{{serverPath}}/v1/report-categories","description":"List of paginated category reports
\nResult of Request :
\n","urlObject":{"path":["v1","report-categories"],"host":["{{serverPath}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b2c4dade-b26e-42af-b5b5-3f357d42d717"},{"name":"Category","event":[{"listen":"test","script":{"id":"5d063e5f-a6b5-4bcc-b2b3-7ebb8ad6729f","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"14a81174-fc8f-4ecc-a3ca-c8619e47021c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"clientuuid","value":"{{clientuuid}}","type":"text"}],"url":"{{serverPath}}/v1/report-categories/{{report_category_id}}","urlObject":{"path":["v1","report-categories","{{report_category_id}}"],"host":["{{serverPath}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"14a81174-fc8f-4ecc-a3ca-c8619e47021c"},{"name":"List of sub categories","id":"70937381-286c-48c9-9e87-a31f158af622","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[{"key":"clientuuid","value":"{{clientuuid}}","type":"text"}],"url":"{{serverPath}}/v1/report-categories/{{report_category_id}}/sub-categories","description":"List of sub-categories for categorie
\n","urlObject":{"path":["v1","report-categories","{{report_category_id}}","sub-categories"],"host":["{{serverPath}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"70937381-286c-48c9-9e87-a31f158af622"}],"id":"d6418d44-30db-426e-a71e-4017239aecbe","event":[{"listen":"prerequest","script":{"id":"0aef2711-5d23-4744-949f-c0fb62de03d3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f4db8056-845d-4a18-ad99-681620398bf8","type":"text/javascript","exec":[""]}}],"_postman_id":"d6418d44-30db-426e-a71e-4017239aecbe","description":""},{"name":"Services","item":[{"name":"List of services","id":"45b57b4d-0b69-4f19-8ec3-2bc5bfcae6e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{serverPath}}/v1/services","description":"List of paginated services
\nResult of Request :
\n","urlObject":{"path":["v1","services"],"host":["{{serverPath}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"45b57b4d-0b69-4f19-8ec3-2bc5bfcae6e0"},{"name":"Service","id":"95adc491-1024-4727-9151-bca5c1f5fea4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{token}}"}]},"isInherited":false},"method":"GET","header":[],"url":"{{serverPath}}/v1/services/{{service_id}}","urlObject":{"path":["v1","services","{{service_id}}"],"host":["{{serverPath}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"95adc491-1024-4727-9151-bca5c1f5fea4"}],"id":"3e19a1eb-1504-4200-a4ca-5876cc117855","event":[{"listen":"prerequest","script":{"id":"45521c66-cfcc-4b45-ada8-9445078675bb","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b0d6d3ce-fcd5-482b-b696-c8cb5944a886","type":"text/javascript","exec":[""]}}],"_postman_id":"3e19a1eb-1504-4200-a4ca-5876cc117855","description":""}],"event":[{"listen":"prerequest","script":{"id":"cc68f930-eeeb-491c-a53e-5c9b037322b1","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"6b3afba9-6311-4828-8840-d38176d2dafa","type":"text/javascript","exec":[""]}}]}