{ "info": { "name": "Stonal API", "description": "Stonal Public API — Assets, Documents, Users, and Legacy endpoints.\nGenerated from the published OpenAPI specifications at https://docs.stonal.io.\n\n## Variables\n\n- `host` — API origin. Defaults to `https://api.stonal.io` (production).\n Alternatives: `https://api.stonal-secnum.io` (sovereign cloud),\n `https://api.stonal-staging.io` (staging), `https://api-.stonal.io` (dedicated stack).\n- `pat` — Personal Access Token used as the bearer credential. See\n https://docs.stonal.io/md/auth/pat for how to generate one.\n- `assetsBaseUrl`, `documentsBaseUrl`, `usersBaseUrl`, `legacyBaseUrl` — per-API base URLs.\n Each one is set to `{{host}}/` so changing `host` switches every endpoint\n to the chosen environment.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "host", "value": "https://api.stonal.io", "type": "string" }, { "key": "pat", "value": "", "type": "string" }, { "key": "assetsBaseUrl", "value": "{{host}}/datalake", "type": "string" }, { "key": "documentsBaseUrl", "value": "{{host}}/document-storage", "type": "string" }, { "key": "usersBaseUrl", "value": "{{host}}/users", "type": "string" }, { "key": "legacyBaseUrl", "value": "{{host}}/v3", "type": "string" } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{pat}}", "type": "string" } ] }, "item": [ { "name": "Assets", "item": [ { "id": "01fc2699-ac52-4895-b609-cecc8f8bbed0", "name": "Assets", "description": { "content": "Public API to manage and query assets", "type": "text/plain" }, "item": [ { "id": "f40dec0d-5cc1-41b2-8563-d49422286cc8", "name": "Ingest assets", "request": { "name": "Ingest assets", "description": { "content": "Create and update assets by organization. Requires `stonal.asset.write` permission", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "assets" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1320f588-a258-49a1-a5a6-17fe131b1f95", "name": "Successfully ingest assets", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "assets" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c1b84ebc-39ee-4fce-b4a5-b3f96206c535", "name": "Forbidden - Not authorized to access this organization", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "assets" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3a70f0db-1064-4efd-9199-e957aefbe9f1", "name": "Search assets", "request": { "name": "Search assets", "description": { "content": "Search assets by organization. Requires `stonal.asset.read` permission", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "assets", "search" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3b94dea5-ef03-4de5-b708-e6da1e4501a8", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "assets", "search" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "437bdbff-99c7-416d-9c87-38c11acaf74b", "name": "Selection Sessions", "description": { "content": "Selection Session Management API", "type": "text/plain" }, "item": [ { "id": "cf3e4d74-94af-4e03-9bbf-d11d320392f3", "name": "Create a selection session", "request": { "name": "Create a selection session", "description": { "content": "Creates a new selection session with selection data and context for the specified organization. Requires `stonal.asset.read` permission", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code identifier" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "41f2eca1-0e89-41bf-a69b-e8971766bc78", "name": "Selection session successfully created", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"uid\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"url\": \"https://app.stonal.io/plans/ORGCODE/selection/?sessionId=a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13c84af8-792d-443e-9ac2-30defb1275f6", "name": "Bad Request - Invalid request body", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"uid\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"url\": \"https://app.stonal.io/plans/ORGCODE/selection/?sessionId=a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3976c7ab-24e1-4d49-8d14-ba0febe4f281", "name": "Unauthorized - Missing or invalid JWT/PAT", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"uid\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"url\": \"https://app.stonal.io/plans/ORGCODE/selection/?sessionId=a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c70ba69b-44f4-4704-8980-51c8ae878c19", "name": "Forbidden - User doesn't have permission for this organization", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"uid\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"url\": \"https://app.stonal.io/plans/ORGCODE/selection/?sessionId=a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7af050d8-dd86-482d-88ae-327f63f3a58e", "name": "Not Found - Organization code not found", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"uid\": \"a1b2c3d4-e5f6-7890-abcd-ef1234567890\",\n \"url\": \"https://app.stonal.io/plans/ORGCODE/selection/?sessionId=a1b2c3d4-e5f6-7890-abcd-ef1234567890\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a9aca144-a8af-469c-b9e2-e2c303ec3ed5", "name": "Get a selection session", "request": { "name": "Get a selection session", "description": { "content": "Get a unique selection session with its selection data and context.", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions", ":selectionSessionUid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "selectionSessionUid", "description": "(Required) Selection Session UID" } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET" }, "response": [ { "id": "c235ab7b-09fc-45d8-be48-9cbee55cc07e", "name": "Selection session retrieved successfully", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions", ":selectionSessionUid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "selectionSessionUid", "description": "(Required) Selection Session UID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a375b306-b269-42dd-8092-b52f95541175", "name": "Unauthorized - Missing or invalid JWT/PAT", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions", ":selectionSessionUid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "selectionSessionUid", "description": "(Required) Selection Session UID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53fa768e-4d8c-4173-bb2b-d0fd1906c721", "name": "Not Found - Selection session or organization not found", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions", ":selectionSessionUid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "selectionSessionUid", "description": "(Required) Selection Session UID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a0db84f7-8a6e-4146-9ed0-af7aa1e577ff", "name": "Delete a selection session", "request": { "name": "Delete a selection session", "description": { "content": "Delete a selection session and all its data. Requires `stonal.asset.read` permission", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions", ":selectionSessionUid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "selectionSessionUid", "description": "(Required) Selection Session UID" } ] }, "method": "DELETE" }, "response": [ { "id": "2433a954-8369-4805-affc-2a7c92541946", "name": "Selection session deleted successfully", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions", ":selectionSessionUid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "selectionSessionUid", "description": "(Required) Selection Session UID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6ae3c8d2-aca0-4369-a100-33bf521ea56b", "name": "Unauthorized - Missing or invalid JWT/PAT", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions", ":selectionSessionUid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "selectionSessionUid", "description": "(Required) Selection Session UID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "34a48506-4ac0-423a-bf97-61db4771bb0b", "name": "Not Found - Selection session or organization not found", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions", ":selectionSessionUid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "selectionSessionUid", "description": "(Required) Selection Session UID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "46408bbd-f8ac-4a04-8289-c58f30ac5252", "name": "Get a structure in function of the selection session", "request": { "name": "Get a structure in function of the selection session", "description": { "content": "Get a structure of the unique selection session.", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions", ":selectionSessionUid", "structure" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "selectionSessionUid", "description": "(Required) Selection Session UID" } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET" }, "response": [ { "id": "6ee3724f-782a-4e29-b821-8d8b36b541ac", "name": "Structure retrieved successfully", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions", ":selectionSessionUid", "structure" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "selectionSessionUid", "description": "(Required) Selection Session UID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "[\n {\n \"holderTypeName\": [\n {\n \"plural\": \"string\",\n \"singular\": \"string\"\n }\n ],\n \"level\": \"string\",\n \"name\": \"string\",\n \"numberOfChildren\": 4181,\n \"parentStonalId\": \"string\",\n \"stonalId\": \"string\",\n \"plan3DLink\": \"string\",\n \"guid\": \"string\"\n },\n {\n \"holderTypeName\": [\n {\n \"plural\": \"string\",\n \"singular\": \"string\"\n }\n ],\n \"level\": \"string\",\n \"name\": \"string\",\n \"numberOfChildren\": 5426,\n \"parentStonalId\": \"string\",\n \"stonalId\": \"string\",\n \"plan3DLink\": \"string\",\n \"guid\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc60ba77-96a4-4a16-8497-0961effed4ea", "name": "Not Found - Structure from selection session or selection session or organization not found", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions", ":selectionSessionUid", "structure" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "selectionSessionUid", "description": "(Required) Selection Session UID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "[\n {\n \"holderTypeName\": [\n {\n \"plural\": \"string\",\n \"singular\": \"string\"\n }\n ],\n \"level\": \"string\",\n \"name\": \"string\",\n \"numberOfChildren\": 4181,\n \"parentStonalId\": \"string\",\n \"stonalId\": \"string\",\n \"plan3DLink\": \"string\",\n \"guid\": \"string\"\n },\n {\n \"holderTypeName\": [\n {\n \"plural\": \"string\",\n \"singular\": \"string\"\n }\n ],\n \"level\": \"string\",\n \"name\": \"string\",\n \"numberOfChildren\": 5426,\n \"parentStonalId\": \"string\",\n \"stonalId\": \"string\",\n \"plan3DLink\": \"string\",\n \"guid\": \"string\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b99650ff-1e38-4122-b79c-1e10640e1393", "name": "Get selected asset details for a selection session", "request": { "name": "Get selected asset details for a selection session", "description": { "content": "Returns the name and level of each selected asset in the session.", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions", ":selectionSessionUid", "assets" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "selectionSessionUid", "description": "(Required) Selection Session UID" } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET" }, "response": [ { "id": "4d8c0899-13c2-4018-b356-8bc2c8ab6f55", "name": "Selected asset details retrieved successfully", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions", ":selectionSessionUid", "assets" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "selectionSessionUid", "description": "(Required) Selection Session UID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d11c7690-eb5b-4bed-9cf0-a8925bab8008", "name": "Not Found - Selection session or organization not found", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions", ":selectionSessionUid", "assets" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "selectionSessionUid", "description": "(Required) Selection Session UID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a72adc85-b90a-46c1-a3a7-83a024300cd0", "name": "Get the plan of the assets base view in selection session", "request": { "name": "Get the plan of the assets base view in selection session", "description": { "content": "Get the plan of the assets base view in selection session.", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions", ":selectionSessionUid", "assets", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "selectionSessionUid", "description": "(Required) Selection Session UID" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Selection asset UID" } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET" }, "response": [ { "id": "a02f5987-c8c4-4bf8-885f-7e686f141eba", "name": "Structure retrieved successfully", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions", ":selectionSessionUid", "assets", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "selectionSessionUid", "description": "(Required) Selection Session UID" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Selection asset UID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6b9a122a-9023-40e4-8c6b-586466da5f1b", "name": "Not Found - Structure from selection session or selection session or organization not found", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "selection-sessions", ":selectionSessionUid", "assets", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "selectionSessionUid", "description": "(Required) Selection Session UID" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Selection asset UID" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "f2e17ab3-0a8f-4a16-8781-d9957aeac61f", "name": "Stakeholders", "description": { "content": "Public API to manage and query stakeholders", "type": "text/plain" }, "item": [ { "id": "ff4a8eb4-db58-474f-a1ab-fc2da3df075c", "name": "Get stakeholder by ID", "request": { "name": "Get stakeholder by ID", "description": { "content": "Retrieves a single stakeholder by its unique identifier. Requires `stonal.contacts.read` permission", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Unique identifier of the stakeholder" } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET" }, "response": [ { "id": "ea33372b-a933-4649-8b3c-59fd141fc62f", "name": "Successfully retrieved stakeholder", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Unique identifier of the stakeholder" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3bb8a6af-939b-4efa-92ac-729701b7ab52", "name": "Forbidden - Not authorized to access this organization", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Unique identifier of the stakeholder" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "49c6e802-b94a-4e62-bdd7-588ccb549e2a", "name": "Stakeholder not found", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Unique identifier of the stakeholder" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87fc0071-b22d-4e3e-a403-44d619491fa8", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Unique identifier of the stakeholder" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8f6562e7-5729-4821-9e84-8f51070e21db", "name": "Save stakeholder", "request": { "name": "Save stakeholder", "description": { "content": "Creates or updates a stakeholder with a specific UID. Requires `stonal.contact.write` permission", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Unique identifier of the stakeholder" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "bf1da180-4cdd-4f78-ae7f-b4a88906f484", "name": "Stakeholder successfully saved", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Unique identifier of the stakeholder" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bd0ba61b-307e-4032-9c5e-8520f4d2bd01", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Unique identifier of the stakeholder" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5a777841-04c9-4e6e-8b1d-685b176db4d7", "name": "Forbidden - Not authorized to access this organization", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Unique identifier of the stakeholder" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b028f8b2-f85e-4f15-86ae-28dc81407bb3", "name": "Internal server error during save operation", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Unique identifier of the stakeholder" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "PUT", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5f9cd285-37e0-46ed-843f-fa23808b69db", "name": "Delete stakeholder", "request": { "name": "Delete stakeholder", "description": { "content": "Deletes a stakeholder by its unique identifier. Requires `stonal.contact.delete` permission", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Unique identifier of the stakeholder" } ] }, "method": "DELETE" }, "response": [ { "id": "372199aa-476e-4d87-ba30-0a34c650d059", "name": "Stakeholder successfully deleted", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Unique identifier of the stakeholder" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "171aa156-3d69-4683-8223-18748c3d2dd8", "name": "Forbidden - Not authorized to access this organization", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Unique identifier of the stakeholder" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d95195f2-4cac-4ff8-8154-f77ae4f8bb65", "name": "Stakeholder not found", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Unique identifier of the stakeholder" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "677b90a2-8495-4f1f-b304-173ef21c8b3b", "name": "Internal server error during deletion", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Unique identifier of the stakeholder" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "7cf0c728-f32a-4a71-a994-33ec76acbda3", "name": "Update stakeholder", "request": { "name": "Update stakeholder", "description": { "content": "Partially updates an existing stakeholder. Requires `stonal.contact.write` permission", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Unique identifier of the stakeholder" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "53daef94-c25b-4b6f-8ef7-c3fcc43f27bb", "name": "Stakeholder successfully updated", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Unique identifier of the stakeholder" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "4b47cc9d-dc6a-4032-843d-511d651c04b4", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Unique identifier of the stakeholder" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "28458854-2f1b-4179-bf8d-545a8f3c1750", "name": "Forbidden - Not authorized to access this organization", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Unique identifier of the stakeholder" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "95bb84d3-33e3-4e1c-9eae-ef715e7855bb", "name": "Stakeholder not found", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Unique identifier of the stakeholder" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "55d0a8dd-409a-4dba-b93d-6e3cd1e37147", "name": "Internal server error during update", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders", ":uid" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) Unique identifier of the stakeholder" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ffe51607-69dc-4c7e-a227-1db5bc42216d", "name": "Search stakeholders", "request": { "name": "Search stakeholders", "description": { "content": "Search for stakeholders with various filtering options and pagination. Requires `stonal.contacts.read` permission", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders" ], "host": [ "{{assetsBaseUrl}}" ], "query": [ { "disabled": false, "key": "q", "value": "", "description": "Search query term" }, { "disabled": false, "key": "type", "value": "", "description": "Filter by stakeholder type (person or company)" }, { "disabled": false, "key": "name", "value": "", "description": "Filter by stakeholder name" }, { "disabled": false, "key": "siren", "value": "", "description": "Filter by the siren" }, { "disabled": false, "key": "email", "value": "", "description": "Filter by stakeholder email" }, { "disabled": false, "key": "include", "value": "", "description": "Add objects linked in the response" }, { "disabled": false, "key": "page", "value": "", "description": "Page number (zero-based)" }, { "disabled": false, "key": "size", "value": "", "description": "Page size" }, { "disabled": false, "key": "sort", "value": "", "description": "Sort field" }, { "disabled": false, "key": "direction", "value": "", "description": "Sort direction (asc or desc)" }, { "disabled": false, "key": "assetIds", "value": "", "description": "Filter by asset IDs" }, { "disabled": false, "key": "updatedAtAfter", "value": "", "description": "Filter stakeholders updated after this date. Use ISO 8601 format" }, { "disabled": false, "key": "mustHave", "value": "", "description": "Filter existing siren" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET" }, "response": [ { "id": "a4b4104f-54e6-453c-9cc3-950004674f21", "name": "Successfully retrieved stakeholders", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders" ], "host": [ "{{assetsBaseUrl}}" ], "query": [ { "key": "q", "value": "" }, { "key": "type", "value": "" }, { "key": "name", "value": "" }, { "key": "siren", "value": "" }, { "key": "email", "value": "" }, { "key": "include", "value": "" }, { "key": "page", "value": "" }, { "key": "size", "value": "" }, { "key": "sort", "value": "" }, { "key": "direction", "value": "" }, { "key": "assetIds", "value": "" }, { "key": "updatedAtAfter", "value": "2025-11-10T14:30:00Z" }, { "key": "mustHave", "value": "SIREN" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7170643c-a00c-4d2b-9c01-7bc953455dbc", "name": "Invalid request parameters", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders" ], "host": [ "{{assetsBaseUrl}}" ], "query": [ { "key": "q", "value": "" }, { "key": "type", "value": "" }, { "key": "name", "value": "" }, { "key": "siren", "value": "" }, { "key": "email", "value": "" }, { "key": "include", "value": "" }, { "key": "page", "value": "" }, { "key": "size", "value": "" }, { "key": "sort", "value": "" }, { "key": "direction", "value": "" }, { "key": "assetIds", "value": "" }, { "key": "updatedAtAfter", "value": "2025-11-10T14:30:00Z" }, { "key": "mustHave", "value": "SIREN" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e9c2baa1-8a39-4a4f-9bc5-351e1acfdf10", "name": "Forbidden - Not authorized to access this organization", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders" ], "host": [ "{{assetsBaseUrl}}" ], "query": [ { "key": "q", "value": "" }, { "key": "type", "value": "" }, { "key": "name", "value": "" }, { "key": "siren", "value": "" }, { "key": "email", "value": "" }, { "key": "include", "value": "" }, { "key": "page", "value": "" }, { "key": "size", "value": "" }, { "key": "sort", "value": "" }, { "key": "direction", "value": "" }, { "key": "assetIds", "value": "" }, { "key": "updatedAtAfter", "value": "2025-11-10T14:30:00Z" }, { "key": "mustHave", "value": "SIREN" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7e49dc10-cc59-431a-a987-7937fd4d2aed", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders" ], "host": [ "{{assetsBaseUrl}}" ], "query": [ { "key": "q", "value": "" }, { "key": "type", "value": "" }, { "key": "name", "value": "" }, { "key": "siren", "value": "" }, { "key": "email", "value": "" }, { "key": "include", "value": "" }, { "key": "page", "value": "" }, { "key": "size", "value": "" }, { "key": "sort", "value": "" }, { "key": "direction", "value": "" }, { "key": "assetIds", "value": "" }, { "key": "updatedAtAfter", "value": "2025-11-10T14:30:00Z" }, { "key": "mustHave", "value": "SIREN" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e895ec05-7493-417d-8cc3-ad6d8c87fafc", "name": "Create stakeholder", "request": { "name": "Create stakeholder", "description": { "content": "Creates a new stakeholder (person or company) for an organization. Requires `stonal.contact.write` permission", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "ebaf5f03-4fdc-40fc-88ef-bb26e212396a", "name": "Stakeholder successfully created", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb2dc23c-d37d-407d-86f8-d6b1a70983c3", "name": "Invalid request body", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ba1b2df9-2833-4a19-9de9-de2c464b9acc", "name": "Forbidden - Not authorized to access this organization", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dd52ab64-f328-4a57-8ca8-c6c7aa78f5ba", "name": "Internal server error during creation", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "stakeholders" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "POST", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "a5cb537b-64b6-4c72-bca6-48dc35d09a2a", "name": "Contracts", "description": { "content": "V1 API to manage and query contracts", "type": "text/plain" }, "item": [ { "id": "b50b4fba-acf4-4a68-a2d0-0bdeb06db357", "name": "Get contracts", "request": { "name": "Get contracts", "description": { "content": "Filter contracts by asset and/or stakeholder. Requires `stonal.asset.read` permission", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "contracts" ], "host": [ "{{assetsBaseUrl}}" ], "query": [ { "disabled": false, "key": "contractCode", "value": "", "description": "Contract code" }, { "disabled": false, "key": "assetUids", "value": "", "description": "Asset UIDs (ex: 11111111-1111-1111-1111-111111111111,22222222-2222-2222-2222-222222222222)" }, { "disabled": false, "key": "stakeholderUids", "value": "", "description": "Stakeholder UIDs (ex: 33333333-3333-3333-3333-333333333333,44444444-4444-4444-4444-444444444444)" }, { "disabled": false, "key": "equipmentTypeCodes", "value": "", "description": "Equipment type codes (ex: ELEVATOR,HVAC)" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET" }, "response": [ { "id": "6bb4fabb-fd98-48f5-8780-28935c633260", "name": "Successfully get contracts", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "contracts" ], "host": [ "{{assetsBaseUrl}}" ], "query": [ { "key": "contractCode", "value": "" }, { "key": "assetUids", "value": "" }, { "key": "stakeholderUids", "value": "" }, { "key": "equipmentTypeCodes", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n null\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a0c0196a-84d1-40c0-b997-ab58de49d3a2", "name": "Forbidden - Not authorized to access this organization", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "contracts" ], "host": [ "{{assetsBaseUrl}}" ], "query": [ { "key": "contractCode", "value": "" }, { "key": "assetUids", "value": "" }, { "key": "stakeholderUids", "value": "" }, { "key": "equipmentTypeCodes", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n null\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b4ada120-3fef-425a-9881-3ac1d63f6fd6", "name": "Internal server error during creation", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "contracts" ], "host": [ "{{assetsBaseUrl}}" ], "query": [ { "key": "contractCode", "value": "" }, { "key": "assetUids", "value": "" }, { "key": "stakeholderUids", "value": "" }, { "key": "equipmentTypeCodes", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"data\": [\n null\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "872694fe-e4be-481c-b477-691df1e39a92", "name": "Create contracts", "request": { "name": "Create contracts", "description": { "content": "Create new contracts for an organization with his stakeholders and assets linked. Requires `stonal.asset.write` permission", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "contracts" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "86bcf2f3-5dad-479d-9d9a-23f5b5ac1b98", "name": "Successfully created contracts", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "contracts" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "983d9a4a-660f-42d3-befc-33a763304f8c", "name": "Forbidden - Not authorized to access this organization", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "contracts" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cc37806b-e455-430f-8296-c8761cb523fd", "name": "Conflict - Contract already exists or has no changes", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "contracts" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "265211ad-440c-4a31-9753-1aa8e4a1fd17", "name": "Internal server error during creation", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "contracts" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4c8254f6-b6ef-493d-b25a-9e3a2c995a01", "name": "Update a contract", "request": { "name": "Update a contract", "description": { "content": "Update a contracts for an organization with his stakeholders and assets linked. Requires `stonal.asset.write` permission", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "contracts" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PATCH", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "a042fbf9-de04-4864-a311-47cc9ccbecaf", "name": "Successfully updated the contract", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "contracts" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "011736de-204f-4b0b-84be-464ed0473a83", "name": "Forbidden - Not authorized to access this organization", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "contracts" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "628a82e1-2d14-485e-8eb0-18bbcd3c8c1a", "name": "Conflict - Contract already exists or has no changes", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "contracts" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "179f9d54-7d32-4225-ae01-8c9082dc795b", "name": "Internal server error during creation", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "contracts" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PATCH", "body": { "mode": "raw", "raw": "null", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5642818c-9f97-4dc7-8b34-aec40e9bef56", "name": "Delete a contract", "request": { "name": "Delete a contract", "description": { "content": "Delete a contract for an organization. Requires `stonal.asset.delete` permission. If the contract code contains URL-unsafe characters (e.g. `/` in `2021/Z5059`), it MUST be **double percent-encoded** in the path — `2021/Z5059` is sent as `2021%252FZ5059`.", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "contracts", ":contractCode" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "contractCode", "description": "(Required) Contract code. Double percent-encode any character that is unsafe in a URL path segment (notably `/` → `%252F`); the server decodes the value twice." } ] }, "method": "DELETE" }, "response": [ { "id": "4e0e2267-21e5-4503-bb80-d4e1b1da2e8f", "name": "Successfully deleted the contract", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "contracts", ":contractCode" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "contractCode", "description": "(Required) Contract code. Double percent-encode any character that is unsafe in a URL path segment (notably `/` → `%252F`); the server decodes the value twice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "dbb52578-c5f6-4ae0-8481-0cd8db66e4d2", "name": "Forbidden - Not authorized to access this organization", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "contracts", ":contractCode" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "contractCode", "description": "(Required) Contract code. Double percent-encode any character that is unsafe in a URL path segment (notably `/` → `%252F`); the server decodes the value twice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "59f1d7a2-b1fb-4342-a522-42374ae29a13", "name": "Contract not found", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "contracts", ":contractCode" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "contractCode", "description": "(Required) Contract code. Double percent-encode any character that is unsafe in a URL path segment (notably `/` → `%252F`); the server decodes the value twice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "65c22a21-8943-4b9f-bafa-413fd5b7c691", "name": "Internal server error during deletion", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "contracts", ":contractCode" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "contractCode", "description": "(Required) Contract code. Double percent-encode any character that is unsafe in a URL path segment (notably `/` → `%252F`); the server decodes the value twice." } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "d949eae2-76ca-444e-adc2-852aab9d872e", "name": "Public asset types", "description": { "content": "Public API to manage and query asset type", "type": "text/plain" }, "item": [ { "id": "59a08cd8-1945-43db-83f7-77e056a499a1", "name": "Get all asset types", "request": { "name": "Get all asset types", "description": { "content": "Get all asset types by organization", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "asset-types", "all" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET" }, "response": [ { "id": "c373b56e-1a1b-4e84-b542-7789803190a4", "name": "Successfully get all asset types", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "asset-types", "all" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c025403-dac9-4517-9062-8a068eae2fa7", "name": "Forbidden - Not authorized to access this organization", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "asset-types", "all" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3f268573-e9da-4cc9-b313-96077a6d9224", "name": "Public properties", "description": { "content": "Public API to manage and query properties", "type": "text/plain" }, "item": [ { "id": "79804db8-f923-413a-8333-00bfcd6cf50a", "name": "Get all asset properties", "request": { "name": "Get all asset properties", "description": { "content": "Get all asset properties by organization", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "asset-properties", "all" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET" }, "response": [ { "id": "56991e3c-fba3-4706-819e-30f41a017709", "name": "Successfully get all asset types", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "asset-properties", "all" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4c19fe2b-f5ef-41c5-9efe-46e75562b2c5", "name": "Forbidden - Not authorized to access this organization", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "asset-properties", "all" ], "host": [ "{{assetsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "null", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ] }, { "name": "Documents", "item": [ { "id": "3a943080-c2f7-4b07-838f-ce98d7aa029a", "name": "Files", "description": { "content": "API for public file operations including upload functionality", "type": "text/plain" }, "item": [ { "id": "76fb952a-2f3e-4a9a-955a-1dbc97f34560", "name": "Upload a file", "request": { "name": "Upload a file", "description": { "content": "Uploads a file with a JSON manifest. The manifest provides context for the upload, such as asset, documentation, linked assets, tags, properties, and destination folder.", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "files", "upload" ], "host": [ "{{documentsBaseUrl}}" ], "query": [ { "description": { "content": "Structure of the manifest JSON file. All fields are optional. Add them based on your needs.", "type": "text/plain" }, "key": "Manifest JSON Example", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "key": "file", "value": "", "type": "text", "contentType": "application/octet-stream", "description": "(Required) The main file to upload (PDF, image, etc.)" }, { "key": "manifest", "value": "", "type": "text", "contentType": "application/json", "description": "(Required) Manifest as a JSON file" } ] } }, "response": [ { "id": "23b3a9df-78c6-4bc7-9ac3-5476d9d19cfa", "name": "File successfully uploaded", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "files", "upload" ], "host": [ "{{documentsBaseUrl}}" ], "query": [ { "key": "Manifest JSON Example", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The main file to upload (PDF, image, etc.)", "type": "text/plain" }, "key": "file", "value": "", "type": "text", "contentType": "application/octet-stream" }, { "description": { "content": "(Required) Manifest as a JSON file", "type": "text/plain" }, "key": "manifest", "value": "", "type": "text", "contentType": "application/json" } ] } }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Optional warning codes related to non-blocking upload issues.", "key": "X-DOCUMENT-STORAGE-WARNING", "value": "" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"documentId\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"duplicateDocumentIds\": [\n \"123e4567-e89b-12d3-a456-426614174001\",\n \"123e4567-e89b-12d3-a456-426614174002\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "455cd73c-7fb0-4d31-9eb3-613907956688", "name": "Bad request - Missing/invalid manifest fields", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "files", "upload" ], "host": [ "{{documentsBaseUrl}}" ], "query": [ { "key": "Manifest JSON Example", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The main file to upload (PDF, image, etc.)", "type": "text/plain" }, "key": "file", "value": "", "type": "text", "contentType": "application/octet-stream" }, { "description": { "content": "(Required) Manifest as a JSON file", "type": "text/plain" }, "key": "manifest", "value": "", "type": "text", "contentType": "application/json" } ] } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "36a3c2b7-f923-49ec-afdb-b40180de7423", "name": "Not Found - UID (asset, doc, or folder) not found", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "files", "upload" ], "host": [ "{{documentsBaseUrl}}" ], "query": [ { "key": "Manifest JSON Example", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The main file to upload (PDF, image, etc.)", "type": "text/plain" }, "key": "file", "value": "", "type": "text", "contentType": "application/octet-stream" }, { "description": { "content": "(Required) Manifest as a JSON file", "type": "text/plain" }, "key": "manifest", "value": "", "type": "text", "contentType": "application/json" } ] } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6a091c58-59a8-4f12-8280-961c75bde1b9", "name": "Conflict - Specified asset & documentation aren't linked", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "files", "upload" ], "host": [ "{{documentsBaseUrl}}" ], "query": [ { "key": "Manifest JSON Example", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The main file to upload (PDF, image, etc.)", "type": "text/plain" }, "key": "file", "value": "", "type": "text", "contentType": "application/octet-stream" }, { "description": { "content": "(Required) Manifest as a JSON file", "type": "text/plain" }, "key": "manifest", "value": "", "type": "text", "contentType": "application/json" } ] } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "c44a5bee-bdaf-459b-9ddf-7f8f8fb627c0", "name": "Unprocessable Entity - Template not found for asset", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "files", "upload" ], "host": [ "{{documentsBaseUrl}}" ], "query": [ { "key": "Manifest JSON Example", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "(Required) The main file to upload (PDF, image, etc.)", "type": "text/plain" }, "key": "file", "value": "", "type": "text", "contentType": "application/octet-stream" }, { "description": { "content": "(Required) Manifest as a JSON file", "type": "text/plain" }, "key": "manifest", "value": "", "type": "text", "contentType": "application/json" } ] } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "ce314ab1-98df-4b32-9ad7-6f34af8784b4", "name": "Download a file", "request": { "name": "Download a file", "description": { "content": "Downloads a file by document identifier for a specific organization. The file will be returned as a binary stream.", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "files", ":documentIdentifier" ], "host": [ "{{documentsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "documentIdentifier", "description": "(Required) Document identifier" } ] }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET" }, "response": [ { "id": "06d200a9-25c2-423f-8e13-5280984bcf51", "name": "File successfully downloaded", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "files", ":documentIdentifier" ], "host": [ "{{documentsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "documentIdentifier", "description": "(Required) Document identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "6e7df8e0-174c-47ca-991f-e9fd30bc5ff6", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "files", ":documentIdentifier" ], "host": [ "{{documentsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "documentIdentifier", "description": "(Required) Document identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "87d2d72a-23eb-4981-aac2-be4598e3a1db", "name": "File not found", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "files", ":documentIdentifier" ], "host": [ "{{documentsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "documentIdentifier", "description": "(Required) Document identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "93c4f85a-8521-4f38-bf65-c24dd5caf4ae", "name": "Documents", "description": { "content": "API for public document operations", "type": "text/plain" }, "item": [ { "id": "e056abf2-74da-472c-9676-84f57a9c7efc", "name": "Rename a document", "request": { "name": "Rename a document", "description": { "content": "Changes the name of a document. This endpoint is available for public use.", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "assets", ":assetIdentifier", "documents", ":documentIdentifier", "rename" ], "host": [ "{{documentsBaseUrl}}" ], "query": [ { "disabled": false, "key": "name", "value": "", "description": "(Required) New document name" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "assetIdentifier", "description": "(Required) Asset identifier (asset UID or ERP code)" }, { "disabled": false, "type": "any", "value": "", "key": "documentIdentifier", "description": "(Required) Document identifier" } ] }, "method": "PUT" }, "response": [ { "id": "6579fe3e-3e48-4a80-9c4c-5b4288c833fa", "name": "Document renamed successfully", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "assets", ":assetIdentifier", "documents", ":documentIdentifier", "rename" ], "host": [ "{{documentsBaseUrl}}" ], "query": [ { "key": "name", "value": "Invoice-2023.pdf" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "assetIdentifier", "description": "(Required) Asset identifier (asset UID or ERP code)" }, { "disabled": false, "type": "any", "value": "", "key": "documentIdentifier", "description": "(Required) Document identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "584f5ee0-494a-4a5b-82fa-4e35f36a1281", "name": "Invalid name format", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "assets", ":assetIdentifier", "documents", ":documentIdentifier", "rename" ], "host": [ "{{documentsBaseUrl}}" ], "query": [ { "key": "name", "value": "Invoice-2023.pdf" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "assetIdentifier", "description": "(Required) Asset identifier (asset UID or ERP code)" }, { "disabled": false, "type": "any", "value": "", "key": "documentIdentifier", "description": "(Required) Document identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "f68165c2-b075-47e2-98ef-3f0480fe76e8", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "assets", ":assetIdentifier", "documents", ":documentIdentifier", "rename" ], "host": [ "{{documentsBaseUrl}}" ], "query": [ { "key": "name", "value": "Invoice-2023.pdf" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "assetIdentifier", "description": "(Required) Asset identifier (asset UID or ERP code)" }, { "disabled": false, "type": "any", "value": "", "key": "documentIdentifier", "description": "(Required) Document identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "cbef326b-cd81-4742-a5e9-171a3bd50b3a", "name": "Document not found", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "assets", ":assetIdentifier", "documents", ":documentIdentifier", "rename" ], "host": [ "{{documentsBaseUrl}}" ], "query": [ { "key": "name", "value": "Invoice-2023.pdf" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "assetIdentifier", "description": "(Required) Asset identifier (asset UID or ERP code)" }, { "disabled": false, "type": "any", "value": "", "key": "documentIdentifier", "description": "(Required) Document identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "PUT", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1b43af3e-0768-4414-af21-18d95905ffa7", "name": "Search for documents", "request": { "name": "Search for documents", "description": { "content": "Searches for documents based on provided filters with pagination and sorting options. This endpoint is available for public use.", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "documents", "search" ], "host": [ "{{documentsBaseUrl}}" ], "query": [ { "disabled": false, "key": "pageNumber", "value": "1", "description": "Page number for pagination (starts at 1; 0 is accepted for backward compatibility)" }, { "disabled": false, "key": "pageSize", "value": "20", "description": "Page size for pagination" }, { "disabled": false, "key": "sortOrder", "value": "", "description": "Sort order (asc or desc)" }, { "disabled": false, "key": "columnToSort", "value": "", "description": "Column to sort by" }, { "disabled": false, "key": "updatedAfter", "value": "", "description": "Filter documents updated during and after this date" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"identifiers\": [\n \"\",\n \"\"\n ],\n \"assetIdentifiers\": [\n \"\",\n \"\"\n ],\n \"documentationIdentifiers\": [\n \"\",\n \"\"\n ],\n \"folderIdentifiers\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"properties\": {\n \"key_0\": \"\"\n },\n \"propertyPath\": {\n \"key_0\": {\n \"key_0\": \"\"\n },\n \"key_1\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n \"propertyKey\": \"\",\n \"name\": \"\",\n \"uploadedBy\": \"\",\n \"documentStatus\": \"\",\n \"parentFolderName\": \"\",\n \"predictedFolderName\": \"\",\n \"folder\": {\n \"locale\": \"\",\n \"name\": \"\"\n },\n \"documentClass\": {\n \"code\": \"\",\n \"name\": \"\",\n \"locale\": \"\"\n },\n \"tenantIdentifiers\": [\n \"\",\n \"\"\n ],\n \"linkedAssetIdentifiers\": [\n \"\",\n \"\"\n ],\n \"linkedAsset\": \"\",\n \"hashSha256\": \"\",\n \"hasMetadata\": \"\",\n \"hasLinkedAssets\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "3d64bbbd-040e-4b70-ade3-98310ecf0c72", "name": "Search completed successfully", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "documents", "search" ], "host": [ "{{documentsBaseUrl}}" ], "query": [ { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "20" }, { "key": "sortOrder", "value": "desc" }, { "key": "columnToSort", "value": "creationDate" }, { "key": "updatedAfter", "value": "2023-12-01T10:30:00Z" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"identifiers\": [\n \"\"\n ],\n \"assetIdentifiers\": [\n \"\"\n ],\n \"documentationIdentifiers\": [\n \"\"\n ],\n \"folderIdentifiers\": [\n \"\"\n ],\n \"tags\": [\n \"\"\n ],\n \"properties\": {\n \"key_0\": \"\"\n },\n \"propertyPath\": {\n \"key_0\": {\n \"key_0\": \"\"\n },\n \"key_1\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n \"propertyKey\": \"\",\n \"name\": \"\",\n \"uploadedBy\": \"\",\n \"documentStatus\": \"\",\n \"parentFolderName\": \"\",\n \"predictedFolderName\": \"\",\n \"folder\": {\n \"locale\": \"string\",\n \"name\": \"string\"\n },\n \"documentClass\": {\n \"code\": \"DIAGNOSTIC_ELECTRICITE\",\n \"name\": \"Diagnostic electricite\",\n \"locale\": \"fr-FR\"\n },\n \"tenantIdentifiers\": [\n \"\"\n ],\n \"linkedAssetIdentifiers\": [\n \"\"\n ],\n \"linkedAsset\": \"\",\n \"hashSha256\": \"\",\n \"hasMetadata\": \"\",\n \"hasLinkedAssets\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"pageable\": {\n \"sort\": {\n \"fieldOrder\": {\n \"key_0\": \"DESC\"\n }\n },\n \"pageNumber\": 1,\n \"pageSize\": 25\n },\n \"result\": [\n {\n \"docsUsedToClassify\": [\n {\n \"cosineSimilarity\": \"0.99997663\",\n \"documentUid\": \"3fa1968c-f86a-48e2-80b5-bf512adf3122\",\n \"fileResourceUid\": \"4ga1328c-f97b-59f3-91c6-cg623beg4233\",\n \"name\": \"dpe.pdf\"\n }\n ],\n \"documentReferences\": [\n {\n \"referencedEntityType\": \"ASSET\",\n \"entityIdentifier\": \"asset-123e4567-e89b-12d3-a456-426614174000\",\n \"documentationIdentifier\": \"doc-123e4567-e89b-12d3-a456-426614174000\",\n \"folder\": {\n \"identifier\": {\n \"value\": \"\"\n },\n \"names\": {\n \"value\": \"\"\n }\n },\n \"documentLocationView\": {\n \"path\": {\n \"value\": \"\"\n },\n \"documentationIdentifier\": {\n \"value\": \"\"\n }\n },\n \"templateFolder\": {\n \"identifier\": {\n \"value\": \"\"\n },\n \"names\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"documentationTags\": [\n {\n \"documentationIdentifier\": \"doc-789\",\n \"id\": 1,\n \"name\": \"Important\",\n \"color\": \"#FF5733\"\n }\n ],\n \"fileResource\": {\n \"identifier\": \"file-123e4567-e89b-12d3-a456-426614174000\",\n \"importDate\": \"2023-01-15T14:30:00\",\n \"name\": \"Invoice-2023.pdf\",\n \"contentType\": \"application/pdf\"\n },\n \"identifier\": \"doc-123e4567-e89b-12d3-a456-426614174000\",\n \"isFiledByAI\": false,\n \"linkedAssets\": [\n {\n \"name\": \"RU-001 - Apartment 42B\",\n \"uid\": \"asset-123e4567-e89b-12d3-a456-426614174000\"\n }\n ],\n \"name\": \"Invoice-2023.pdf\",\n \"tenants\": [\n {\n \"name\": \"John Doe\",\n \"uid\": \"tenant-123\"\n }\n ],\n \"documentClass\": {\n \"documentClassCode\": \"INVOICE\",\n \"documentClassIdentifier\": \"class-123e4567-e89b-12d3-a456-426614174000\",\n \"documentClassNames\": [\n {\n \"locale\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"predictedDocumentClass\": {\n \"predictedDocumentClassCode\": \"INVOICE\",\n \"predictedDocumentClassIdentifier\": \"class-123e4567-e89b-12d3-a456-426614174000\",\n \"predictedDocumentClassNames\": [\n {\n \"locale\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ],\n \"confidenceIndex\": 0.85\n },\n \"predictedFolder\": {\n \"identifier\": \"folder-123e4567-e89b-12d3-a456-426614174000\",\n \"names\": [\n {\n \"locale\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"classificationStatus\": \"MANUAL\",\n \"manuallyValidatedFolder\": {\n \"identifier\": \"folder-123e4567-e89b-12d3-a456-426614174000\",\n \"names\": [\n {\n \"locale\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"properties\": {\n \"key_0\": {}\n },\n \"suggestedMetadata\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"urlAccess\": \"https://example.com/api/documents/doc-123/content\",\n \"creationDate\": \"2023-01-15T14:30:00\",\n \"updateDate\": \"2023-02-20T09:45:00\",\n \"hash\": \"a1b2c3d4e5f6...\",\n \"uploadedBy\": \"string\",\n \"isDuplicated\": false,\n \"isFiled\": false\n },\n {\n \"docsUsedToClassify\": [\n {\n \"cosineSimilarity\": \"0.99997663\",\n \"documentUid\": \"3fa1968c-f86a-48e2-80b5-bf512adf3122\",\n \"fileResourceUid\": \"4ga1328c-f97b-59f3-91c6-cg623beg4233\",\n \"name\": \"dpe.pdf\"\n }\n ],\n \"documentReferences\": [\n {\n \"referencedEntityType\": \"ASSET\",\n \"entityIdentifier\": \"asset-123e4567-e89b-12d3-a456-426614174000\",\n \"documentationIdentifier\": \"doc-123e4567-e89b-12d3-a456-426614174000\",\n \"folder\": {\n \"identifier\": {\n \"value\": \"\"\n },\n \"names\": {\n \"value\": \"\"\n }\n },\n \"documentLocationView\": {\n \"path\": {\n \"value\": \"\"\n },\n \"documentationIdentifier\": {\n \"value\": \"\"\n }\n },\n \"templateFolder\": {\n \"identifier\": {\n \"value\": \"\"\n },\n \"names\": {\n \"value\": \"\"\n }\n }\n }\n ],\n \"documentationTags\": [\n {\n \"documentationIdentifier\": \"doc-789\",\n \"id\": 1,\n \"name\": \"Important\",\n \"color\": \"#FF5733\"\n }\n ],\n \"fileResource\": {\n \"identifier\": \"file-123e4567-e89b-12d3-a456-426614174000\",\n \"importDate\": \"2023-01-15T14:30:00\",\n \"name\": \"Invoice-2023.pdf\",\n \"contentType\": \"application/pdf\"\n },\n \"identifier\": \"doc-123e4567-e89b-12d3-a456-426614174000\",\n \"isFiledByAI\": false,\n \"linkedAssets\": [\n {\n \"name\": \"RU-001 - Apartment 42B\",\n \"uid\": \"asset-123e4567-e89b-12d3-a456-426614174000\"\n }\n ],\n \"name\": \"Invoice-2023.pdf\",\n \"tenants\": [\n {\n \"name\": \"John Doe\",\n \"uid\": \"tenant-123\"\n }\n ],\n \"documentClass\": {\n \"documentClassCode\": \"INVOICE\",\n \"documentClassIdentifier\": \"class-123e4567-e89b-12d3-a456-426614174000\",\n \"documentClassNames\": [\n {\n \"locale\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"predictedDocumentClass\": {\n \"predictedDocumentClassCode\": \"INVOICE\",\n \"predictedDocumentClassIdentifier\": \"class-123e4567-e89b-12d3-a456-426614174000\",\n \"predictedDocumentClassNames\": [\n {\n \"locale\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ],\n \"confidenceIndex\": 0.85\n },\n \"predictedFolder\": {\n \"identifier\": \"folder-123e4567-e89b-12d3-a456-426614174000\",\n \"names\": [\n {\n \"locale\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"classificationStatus\": \"MANUAL\",\n \"manuallyValidatedFolder\": {\n \"identifier\": \"folder-123e4567-e89b-12d3-a456-426614174000\",\n \"names\": [\n {\n \"locale\": {\n \"value\": \"\"\n },\n \"name\": {\n \"value\": \"\"\n }\n }\n ]\n },\n \"properties\": {\n \"key_0\": {}\n },\n \"suggestedMetadata\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"metadata\": {\n \"key_0\": \"string\"\n },\n \"urlAccess\": \"https://example.com/api/documents/doc-123/content\",\n \"creationDate\": \"2023-01-15T14:30:00\",\n \"updateDate\": \"2023-02-20T09:45:00\",\n \"hash\": \"a1b2c3d4e5f6...\",\n \"uploadedBy\": \"string\",\n \"isDuplicated\": false,\n \"isFiled\": false\n }\n ],\n \"total\": 123\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "590887d5-48d7-459d-8654-998ca84699fe", "name": "Invalid search parameters", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "documents", "search" ], "host": [ "{{documentsBaseUrl}}" ], "query": [ { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "20" }, { "key": "sortOrder", "value": "desc" }, { "key": "columnToSort", "value": "creationDate" }, { "key": "updatedAfter", "value": "2023-12-01T10:30:00Z" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"identifiers\": [\n \"\"\n ],\n \"assetIdentifiers\": [\n \"\"\n ],\n \"documentationIdentifiers\": [\n \"\"\n ],\n \"folderIdentifiers\": [\n \"\"\n ],\n \"tags\": [\n \"\"\n ],\n \"properties\": {\n \"key_0\": \"\"\n },\n \"propertyPath\": {\n \"key_0\": {\n \"key_0\": \"\"\n },\n \"key_1\": {\n \"key_0\": \"\",\n \"key_1\": \"\",\n \"key_2\": \"\"\n }\n },\n \"propertyKey\": \"\",\n \"name\": \"\",\n \"uploadedBy\": \"\",\n \"documentStatus\": \"\",\n \"parentFolderName\": \"\",\n \"predictedFolderName\": \"\",\n \"folder\": {\n \"locale\": \"string\",\n \"name\": \"string\"\n },\n \"documentClass\": {\n \"code\": \"DIAGNOSTIC_ELECTRICITE\",\n \"name\": \"Diagnostic electricite\",\n \"locale\": \"fr-FR\"\n },\n \"tenantIdentifiers\": [\n \"\"\n ],\n \"linkedAssetIdentifiers\": [\n \"\"\n ],\n \"linkedAsset\": \"\",\n \"hashSha256\": \"\",\n \"hasMetadata\": \"\",\n \"hasLinkedAssets\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2b483803-d569-4296-8734-fdcc29a4abf9", "name": "Add or remove documentation tags on documents", "request": { "name": "Add or remove documentation tags on documents", "description": { "content": "Updates documentation tags on documents. Each item carries its asset scope in the request body, missing tags are created before assignment and the whole request is processed in one transaction.", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "documents", "documentation-tags" ], "host": [ "{{documentsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"addTags\": [\n \"\",\n \"\"\n ],\n \"assetIdentifier\": \"\",\n \"documentIdentifier\": \"\",\n \"documentationIdentifier\": \"\",\n \"removeTags\": [\n \"\",\n \"\"\n ]\n },\n {\n \"addTags\": [\n \"\",\n \"\"\n ],\n \"assetIdentifier\": \"\",\n \"documentIdentifier\": \"\",\n \"documentationIdentifier\": \"\",\n \"removeTags\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "967f2b54-95f2-4f54-82cb-b4d47ed16bce", "name": "Documentation tags updated successfully", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "documents", "documentation-tags" ], "host": [ "{{documentsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"assetIdentifier\": \"asset-789\",\n \"documentIdentifier\": \"doc-123\",\n \"documentationIdentifier\": \"documentation-456\",\n \"addTags\": [\n \"LEASE\",\n \"EDP 2024\"\n ],\n \"removeTags\": [\n \"ARCHIVE\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "018d8486-c685-4338-b650-70612b510126", "name": "Invalid payload", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "documents", "documentation-tags" ], "host": [ "{{documentsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"assetIdentifier\": \"asset-789\",\n \"documentIdentifier\": \"doc-123\",\n \"documentationIdentifier\": \"documentation-456\",\n \"addTags\": [\n \"LEASE\",\n \"EDP 2024\"\n ],\n \"removeTags\": [\n \"ARCHIVE\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b33d1f8b-31eb-48c8-8185-bc9f835268db", "name": "Forbidden - insufficient permissions", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "documents", "documentation-tags" ], "host": [ "{{documentsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"assetIdentifier\": \"asset-789\",\n \"documentIdentifier\": \"doc-123\",\n \"documentationIdentifier\": \"documentation-456\",\n \"addTags\": [\n \"LEASE\",\n \"EDP 2024\"\n ],\n \"removeTags\": [\n \"ARCHIVE\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "b7e6bda0-5966-4d1c-9928-d767dc601a0f", "name": "One or more resources were not found", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "documents", "documentation-tags" ], "host": [ "{{documentsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"items\": [\n {\n \"assetIdentifier\": \"asset-789\",\n \"documentIdentifier\": \"doc-123\",\n \"documentationIdentifier\": \"documentation-456\",\n \"addTags\": [\n \"LEASE\",\n \"EDP 2024\"\n ],\n \"removeTags\": [\n \"ARCHIVE\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "75913455-a82a-4b48-9881-a39119fe618f", "name": "Show file content", "request": { "name": "Show file content", "description": { "content": "Show a file by its identifier. The file is identified by the document identifier.", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "documents", ":documentIdentifier", "content" ], "host": [ "{{documentsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "documentIdentifier", "description": "(Required) Document identifier" }, { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET" }, "response": [ { "id": "b48ff4d0-d2d8-463b-aa17-445dc8da9dc9", "name": "File successfully downloaded", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "documents", ":documentIdentifier", "content" ], "host": [ "{{documentsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "documentIdentifier", "description": "(Required) Document identifier" }, { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "312880e1-7ca4-4c2e-828d-d4f5270e4b97", "name": "Document not found", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "documents", ":documentIdentifier", "content" ], "host": [ "{{documentsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "documentIdentifier", "description": "(Required) Document identifier" }, { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "02f1617a-3bc0-4407-b8e7-0a881560b306", "name": "show File Content Default", "request": { "name": "show File Content Default", "description": {}, "url": { "path": [ "v1", "documents", ":documentIdentifier", "content" ], "host": [ "{{documentsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "documentIdentifier", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET" }, "response": [ { "id": "f9654657-2d44-43fa-8440-63913c33baef", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "documents", ":documentIdentifier", "content" ], "host": [ "{{documentsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "documentIdentifier", "description": "(Required) " } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "5c8a1b43-ae24-4ec5-8d42-e431a71b6b65", "name": "Documentation Templates", "description": { "content": "Public API for documentation templates", "type": "text/plain" }, "item": [ { "id": "c494ada8-a697-4505-8c8c-d95343a20130", "name": "List documentation templates", "request": { "name": "List documentation templates", "description": { "content": "Returns the documentation templates available for an organization. A language parameter lets clients select the preferred locale for the name field.", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "templates" ], "host": [ "{{documentsBaseUrl}}" ], "query": [ { "disabled": false, "key": "language", "value": "", "description": "Preferred language" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "3df0749c-eb9c-4734-86b3-c877398c9775", "name": "Templates retrieved", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "templates" ], "host": [ "{{documentsBaseUrl}}" ], "query": [ { "key": "language", "value": "fr-FR" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"templates\": [\n {\n \"attachmentType\": \"BUILDING_GROUP\",\n \"id\": \"f90ee77d-b6cc-41fa-8d1f-bea649e6d93d\",\n \"name\": \"string\",\n \"organizationCode\": \"13_HABITAT\"\n },\n {\n \"attachmentType\": \"BUILDING_GROUP\",\n \"id\": \"f90ee77d-b6cc-41fa-8d1f-bea649e6d93d\",\n \"name\": \"string\",\n \"organizationCode\": \"13_HABITAT\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "253fc328-8117-4fbc-a1d8-05d7acac6e3a", "name": "Forbidden", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "templates" ], "host": [ "{{documentsBaseUrl}}" ], "query": [ { "key": "language", "value": "fr-FR" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "014ffafa-c3dd-4c41-acce-2fc945ee41e4", "name": "Get documentation template tree", "request": { "name": "Get documentation template tree", "description": { "content": "Returns the complete folder tree for a documentation template.", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "templates", ":templateId" ], "host": [ "{{documentsBaseUrl}}" ], "query": [ { "disabled": false, "key": "language", "value": "", "description": "Preferred language" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "templateId", "description": "(Required) Template identifier" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "cb24de76-e1fb-4d14-8a60-2e9d045d8294", "name": "Template found", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "templates", ":templateId" ], "host": [ "{{documentsBaseUrl}}" ], "query": [ { "key": "language", "value": "fr-FR" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "templateId", "description": "(Required) Template identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"template\": {\n \"attachmentType\": \"string\",\n \"folders\": [\n {\n \"id\": \"string\",\n \"name\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"parentId\": \"string\",\n \"documentClass\": {\n \"code\": \"DPE\",\n \"identifier\": \"documentClassIdentifier\"\n }\n },\n {\n \"id\": \"string\",\n \"name\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"parentId\": \"string\",\n \"documentClass\": {\n \"code\": \"DPE\",\n \"identifier\": \"documentClassIdentifier\"\n }\n }\n ],\n \"id\": \"string\",\n \"name\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\"\n },\n \"organizationCode\": \"string\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55fe2418-060a-414b-b52d-e011a3563d83", "name": "Template not found", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "templates", ":templateId" ], "host": [ "{{documentsBaseUrl}}" ], "query": [ { "key": "language", "value": "fr-FR" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "templateId", "description": "(Required) Template identifier" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b71c826d-eeaf-4de2-b290-520df7494610", "name": "Documentations", "description": { "content": "API for retrieving documentation information for assets", "type": "text/plain" }, "item": [ { "id": "2eb88556-844c-44e0-96b3-135a18be5edb", "name": "Get documentations for an asset", "request": { "name": "Get documentations for an asset", "description": { "content": "Retrieves all documentation entries associated with a specific asset identified by either assetUid or externalId", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "assets", ":assetId", "documentations" ], "host": [ "{{documentsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "assetId", "description": "(Required) Asset identifier - either a UUID (123e4567-e89b-12d3-a456-426614174000) or an external ID (ERP:58654)" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "cb02e2c0-6966-41cf-b9a6-aa7c43010ab0", "name": "Successfully retrieved documentation entries", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "assets", ":assetId", "documentations" ], "host": [ "{{documentsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "assetId", "description": "(Required) Asset identifier - either a UUID (123e4567-e89b-12d3-a456-426614174000) or an external ID (ERP:58654)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"result\": [\n {\n \"assetIdentifier\": \"3e6e000-919b-8762-108d-deb9f1595dr\",\n \"identifier\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"names\": [\n {\n \"name\": \"Documentation 1\",\n \"locale\": \"en-US\"\n }\n ],\n \"organizationCode\": \"ORG123\",\n \"rootFolder\": {\n \"identifier\": \"123e4567-e89b-12d3-a456-426614174001\",\n \"names\": [\n {\n \"locale\": \"en-US\",\n \"name\": \"Root folder\"\n }\n ],\n \"documentationTemplateFolderReference\": \"2d6e099-910b-4668-902c-deb9f15984ec\"\n },\n \"rootTemplate\": {\n \"folders\": [\n {\n \"value\": \"\"\n },\n {\n \"value\": \"\"\n }\n ],\n \"identifier\": \"string\",\n \"names\": [\n {\n \"locale\": \"en-US\",\n \"name\": \"Root folder\"\n }\n ]\n },\n \"documentationTemplateReference\": \"2d6e099-910b-4668-902c-deb9f15984ec\",\n \"documentationTemplateAttachmentType\": \"ASSET\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d9c7fa16-4f9a-4497-b655-092e0f7ca8ee", "name": "Bad request - invalid asset ID format", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "assets", ":assetId", "documentations" ], "host": [ "{{documentsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "assetId", "description": "(Required) Asset identifier - either a UUID (123e4567-e89b-12d3-a456-426614174000) or an external ID (ERP:58654)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ddb42099-9e73-4bbd-bc7d-86133a5df0c9", "name": "No documentation entries found for the specified asset", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "assets", ":assetId", "documentations" ], "host": [ "{{documentsBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Organization code" }, { "disabled": false, "type": "any", "value": "", "key": "assetId", "description": "(Required) Asset identifier - either a UUID (123e4567-e89b-12d3-a456-426614174000) or an external ID (ERP:58654)" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " }, { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ] }, { "name": "Users", "item": [ { "id": "77f770b3-9f5e-4de1-add3-e34862b7736a", "name": "Users", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "89fe2322-10c3-4295-b8af-d6d166f6cf93", "name": "Get paginated users", "request": { "name": "Get paginated users", "description": { "content": "> [!important]\n> Required permission scope: `stonal.user.read`\n\nReturns a paginated list of users for the specified organization\n", "type": "text/plain" }, "url": { "path": [ "v2", "organizations", ":organizationCode", "users" ], "host": [ "{{usersBaseUrl}}" ], "query": [ { "disabled": false, "key": "q", "value": "", "description": "Search query to filter users" }, { "disabled": false, "key": "permissions", "value": "", "description": "List of permissions to filter users" }, { "disabled": false, "key": "userGroups", "value": "", "description": "Comma-separated list of user group labels to filter users. Use \\, to escape literal commas in labels." }, { "disabled": false, "key": "pageNumber", "value": "", "description": "(Required) Page number for pagination" }, { "disabled": false, "key": "pageSize", "value": "", "description": "(Required) Number of items per page" }, { "disabled": false, "key": "sortField", "value": "", "description": "Field to sort by" }, { "disabled": false, "key": "sortDirection", "value": "", "description": "Sort direction" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "2c6b5116-1a1a-4047-86e9-1f9604c727f3", "name": "Successful response", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users" ], "host": [ "{{usersBaseUrl}}" ], "query": [ { "key": "q", "value": "john" }, { "key": "permissions", "value": "PROFILE:Administrator,SCOPE_GROUP:All" }, { "key": "userGroups", "value": "Administrators,Readers" }, { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "20" }, { "key": "sortField", "value": "email" }, { "key": "sortDirection", "value": "asc" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total\": 42,\n \"result\": [\n {\n \"uid\": \"019619df-4768-7af9-8167-18ad0b73a399\",\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"role\": \"MEMBER\",\n \"allAssets\": false,\n \"createdAt\": \"2025-06-15T10:30:00Z\",\n \"userGroups\": [\n {\n \"uid\": \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"label\": \"Marketing\"\n },\n {\n \"uid\": \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"label\": \"Marketing\"\n }\n ],\n \"permissions\": {\n \"ASSET\": {\n \"PORTFOLIO\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a63cf3431c1\",\n \"code\": \"b362b8cd-e105-41db-b131-0911fa559aee\",\n \"label\": \"Alpha\"\n },\n \"COMPANY\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a63cf3431c2\",\n \"code\": \"stonal\",\n \"label\": \"Stonal\"\n },\n \"BUILDING\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a63cf3431c3\",\n \"code\": \"b362b8cd-e105-41db-b131-0911fa559aef\",\n \"label\": \"B01 - Marseille\"\n },\n \"BUILDING_GROUP\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a63cf3431c4\",\n \"code\": \"b362b8cd-e105-41db-b131-0911fa559aea\",\n \"label\": \"S01 - Marseille\"\n },\n \"FACILITY\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a63cf3431c5\",\n \"code\": \"b362b8cd-e105-41db-b131-0911fa559aeb\",\n \"label\": \"F01 - Marseille\"\n }\n },\n \"PROFILE\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a3cf3431c6\",\n \"code\": \"acquereur\",\n \"label\": \"Acquéreur\"\n },\n \"SCOPE\": {\n \"RIGHT\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a3cf3431c7\",\n \"code\": \"stonal.asset.all\",\n \"label\": \"Access to all assets\"\n }\n },\n \"SCOPE_GROUP\": {\n \"APPLICATION\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a3cf3431c8\",\n \"code\": \"b362b8cd-e105-41db-b131-0911fa559aec\",\n \"label\": \"All\"\n },\n \"RIGHT\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a3cf3431c9\",\n \"code\": \"stonal.read-write\",\n \"label\": \"Read write\"\n }\n },\n \"REPORT\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a3cf3431ca\",\n \"code\": \"019837df-ab1d-7d13-956f-a4233f0b95a1\",\n \"label\": \"FICHE BATIMENT & SITE\"\n },\n \"REPORT_GROUP\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a3cf3431cb\",\n \"code\": \"75cb735c-7335-42c7-a27f-c26be904c5ed\",\n \"label\": \"Admin\"\n }\n }\n },\n {\n \"uid\": \"019619df-4768-7af9-8167-18ad0b73a399\",\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"role\": \"MEMBER\",\n \"allAssets\": false,\n \"createdAt\": \"2025-06-15T10:30:00Z\",\n \"userGroups\": [\n {\n \"uid\": \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"label\": \"Marketing\"\n },\n {\n \"uid\": \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"label\": \"Marketing\"\n }\n ],\n \"permissions\": {\n \"ASSET\": {\n \"PORTFOLIO\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a63cf3431c1\",\n \"code\": \"b362b8cd-e105-41db-b131-0911fa559aee\",\n \"label\": \"Alpha\"\n },\n \"COMPANY\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a63cf3431c2\",\n \"code\": \"stonal\",\n \"label\": \"Stonal\"\n },\n \"BUILDING\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a63cf3431c3\",\n \"code\": \"b362b8cd-e105-41db-b131-0911fa559aef\",\n \"label\": \"B01 - Marseille\"\n },\n \"BUILDING_GROUP\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a63cf3431c4\",\n \"code\": \"b362b8cd-e105-41db-b131-0911fa559aea\",\n \"label\": \"S01 - Marseille\"\n },\n \"FACILITY\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a63cf3431c5\",\n \"code\": \"b362b8cd-e105-41db-b131-0911fa559aeb\",\n \"label\": \"F01 - Marseille\"\n }\n },\n \"PROFILE\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a3cf3431c6\",\n \"code\": \"acquereur\",\n \"label\": \"Acquéreur\"\n },\n \"SCOPE\": {\n \"RIGHT\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a3cf3431c7\",\n \"code\": \"stonal.asset.all\",\n \"label\": \"Access to all assets\"\n }\n },\n \"SCOPE_GROUP\": {\n \"APPLICATION\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a3cf3431c8\",\n \"code\": \"b362b8cd-e105-41db-b131-0911fa559aec\",\n \"label\": \"All\"\n },\n \"RIGHT\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a3cf3431c9\",\n \"code\": \"stonal.read-write\",\n \"label\": \"Read write\"\n }\n },\n \"REPORT\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a3cf3431ca\",\n \"code\": \"019837df-ab1d-7d13-956f-a4233f0b95a1\",\n \"label\": \"FICHE BATIMENT & SITE\"\n },\n \"REPORT_GROUP\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a3cf3431cb\",\n \"code\": \"75cb735c-7335-42c7-a27f-c26be904c5ed\",\n \"label\": \"Admin\"\n }\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d3ba0f7-4f61-4935-8f5c-687e044f6ada", "name": "Bad request", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users" ], "host": [ "{{usersBaseUrl}}" ], "query": [ { "key": "q", "value": "john" }, { "key": "permissions", "value": "PROFILE:Administrator,SCOPE_GROUP:All" }, { "key": "userGroups", "value": "Administrators,Readers" }, { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "20" }, { "key": "sortField", "value": "email" }, { "key": "sortDirection", "value": "asc" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InvalidBody\",\n \"title\": \"Invalid request\",\n \"detail\": \"Request body is invalid\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4143cc6a-d3cf-4ec8-aff3-fc72add0cbe1", "name": "Unauthorized - Missing authentication", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users" ], "host": [ "{{usersBaseUrl}}" ], "query": [ { "key": "q", "value": "john" }, { "key": "permissions", "value": "PROFILE:Administrator,SCOPE_GROUP:All" }, { "key": "userGroups", "value": "Administrators,Readers" }, { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "20" }, { "key": "sortField", "value": "email" }, { "key": "sortDirection", "value": "asc" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:Unauthenticated\",\n \"title\": \"Missing authentication\",\n \"detail\": \"Please authenticate yourself\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3777d671-10f5-42f5-931a-00cc1f7fc554", "name": "Forbidden - Access denied", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users" ], "host": [ "{{usersBaseUrl}}" ], "query": [ { "key": "q", "value": "john" }, { "key": "permissions", "value": "PROFILE:Administrator,SCOPE_GROUP:All" }, { "key": "userGroups", "value": "Administrators,Readers" }, { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "20" }, { "key": "sortField", "value": "email" }, { "key": "sortDirection", "value": "asc" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ForbiddenAccess\",\n \"title\": \"Access denied\",\n \"detail\": \"You do not have permission to access this resource\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ba117ed-569f-43a4-8592-60acde5a7606", "name": "Unprocessable Entity - Validation errors", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users" ], "host": [ "{{usersBaseUrl}}" ], "query": [ { "key": "q", "value": "john" }, { "key": "permissions", "value": "PROFILE:Administrator,SCOPE_GROUP:All" }, { "key": "userGroups", "value": "Administrators,Readers" }, { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "20" }, { "key": "sortField", "value": "email" }, { "key": "sortDirection", "value": "asc" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ValidationError\",\n \"title\": \"Invalid request\",\n \"errors\": [\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n },\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7523cb38-03eb-46f5-a404-18e37e13bd28", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users" ], "host": [ "{{usersBaseUrl}}" ], "query": [ { "key": "q", "value": "john" }, { "key": "permissions", "value": "PROFILE:Administrator,SCOPE_GROUP:All" }, { "key": "userGroups", "value": "Administrators,Readers" }, { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "20" }, { "key": "sortField", "value": "email" }, { "key": "sortDirection", "value": "asc" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InternalError\",\n \"title\": \"Internal server error\",\n \"detail\": \"An unexpected error occurred\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "57c6a3a8-af6a-4b38-b18e-f074fd240f67", "name": "Create user", "request": { "name": "Create user", "description": { "content": "> [!important]\n> Required permission scope: `stonal.user.write`\n\nCreates a new user\n", "type": "text/plain" }, "url": { "path": [ "v2", "organizations", ":organizationCode", "users" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"uid\": \"\",\n \"password\": \"\",\n \"fromExternalIdp\": \"\",\n \"allAssets\": \"\",\n \"userGroupUids\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n {\n \"uid\": \"\"\n },\n {\n \"uid\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "246d2904-a7d7-4929-a359-9aa82caa9047", "name": "User successfully created or updated", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"uid\": \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"password\": \"SecureP@ssw0rd!\",\n \"fromExternalIdp\": false,\n \"allAssets\": false,\n \"userGroupUids\": [\n \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"019619df-4768-7b28-ae66-afbee5b857ab\"\n ],\n \"permissions\": [\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n },\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3f7a00e7-19e1-42fd-957d-8777485471e0", "name": "Bad request", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"uid\": \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"password\": \"SecureP@ssw0rd!\",\n \"fromExternalIdp\": false,\n \"allAssets\": false,\n \"userGroupUids\": [\n \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"019619df-4768-7b28-ae66-afbee5b857ab\"\n ],\n \"permissions\": [\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n },\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InvalidBody\",\n \"title\": \"Invalid request\",\n \"detail\": \"Request body is invalid\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b2816c5b-0a3f-466e-8f8d-d31fd772690b", "name": "Unauthorized - Missing authentication", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"uid\": \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"password\": \"SecureP@ssw0rd!\",\n \"fromExternalIdp\": false,\n \"allAssets\": false,\n \"userGroupUids\": [\n \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"019619df-4768-7b28-ae66-afbee5b857ab\"\n ],\n \"permissions\": [\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n },\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:Unauthenticated\",\n \"title\": \"Missing authentication\",\n \"detail\": \"Please authenticate yourself\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7c247211-3edc-4a02-887c-1f9d2a8e3d1b", "name": "Forbidden - Access denied", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"uid\": \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"password\": \"SecureP@ssw0rd!\",\n \"fromExternalIdp\": false,\n \"allAssets\": false,\n \"userGroupUids\": [\n \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"019619df-4768-7b28-ae66-afbee5b857ab\"\n ],\n \"permissions\": [\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n },\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ForbiddenAccess\",\n \"title\": \"Access denied\",\n \"detail\": \"You do not have permission to access this resource\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2f238239-9874-4acf-8053-b24e4c890bb5", "name": "Unprocessable Entity - Validation errors", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"uid\": \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"password\": \"SecureP@ssw0rd!\",\n \"fromExternalIdp\": false,\n \"allAssets\": false,\n \"userGroupUids\": [\n \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"019619df-4768-7b28-ae66-afbee5b857ab\"\n ],\n \"permissions\": [\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n },\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ValidationError\",\n \"title\": \"Invalid request\",\n \"errors\": [\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n },\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "83b7f0e2-5693-472b-8a5b-eacc5b976803", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"uid\": \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"password\": \"SecureP@ssw0rd!\",\n \"fromExternalIdp\": false,\n \"allAssets\": false,\n \"userGroupUids\": [\n \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"019619df-4768-7b28-ae66-afbee5b857ab\"\n ],\n \"permissions\": [\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n },\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InternalError\",\n \"title\": \"Internal server error\",\n \"detail\": \"An unexpected error occurred\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "134f3df4-5932-4307-9fb1-8a1f9a086a1b", "name": "Get user by UID", "request": { "name": "Get user by UID", "description": { "content": "> [!important]\n> Required permission scope: `stonal.user.read`\n\nReturns details for a specific user\n", "type": "text/plain" }, "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "e2fe1909-0ede-480e-95a3-36470130150c", "name": "Successful response", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"uid\": \"019619df-4768-7af9-8167-18ad0b73a399\",\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"role\": \"MEMBER\",\n \"allAssets\": false,\n \"createdAt\": \"2025-06-15T10:30:00Z\",\n \"userGroups\": [\n {\n \"uid\": \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"label\": \"Marketing\"\n },\n {\n \"uid\": \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"label\": \"Marketing\"\n }\n ],\n \"permissions\": {\n \"ASSET\": {\n \"PORTFOLIO\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a63cf3431c1\",\n \"code\": \"b362b8cd-e105-41db-b131-0911fa559aee\",\n \"label\": \"Alpha\"\n },\n \"COMPANY\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a63cf3431c2\",\n \"code\": \"stonal\",\n \"label\": \"Stonal\"\n },\n \"BUILDING\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a63cf3431c3\",\n \"code\": \"b362b8cd-e105-41db-b131-0911fa559aef\",\n \"label\": \"B01 - Marseille\"\n },\n \"BUILDING_GROUP\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a63cf3431c4\",\n \"code\": \"b362b8cd-e105-41db-b131-0911fa559aea\",\n \"label\": \"S01 - Marseille\"\n },\n \"FACILITY\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a63cf3431c5\",\n \"code\": \"b362b8cd-e105-41db-b131-0911fa559aeb\",\n \"label\": \"F01 - Marseille\"\n }\n },\n \"PROFILE\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a3cf3431c6\",\n \"code\": \"acquereur\",\n \"label\": \"Acquéreur\"\n },\n \"SCOPE\": {\n \"RIGHT\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a3cf3431c7\",\n \"code\": \"stonal.asset.all\",\n \"label\": \"Access to all assets\"\n }\n },\n \"SCOPE_GROUP\": {\n \"APPLICATION\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a3cf3431c8\",\n \"code\": \"b362b8cd-e105-41db-b131-0911fa559aec\",\n \"label\": \"All\"\n },\n \"RIGHT\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a3cf3431c9\",\n \"code\": \"stonal.read-write\",\n \"label\": \"Read write\"\n }\n },\n \"REPORT\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a3cf3431ca\",\n \"code\": \"019837df-ab1d-7d13-956f-a4233f0b95a1\",\n \"label\": \"FICHE BATIMENT & SITE\"\n },\n \"REPORT_GROUP\": {\n \"uid\": \"0bb04f5b-bf5e-4950-acb1-0a3cf3431cb\",\n \"code\": \"75cb735c-7335-42c7-a27f-c26be904c5ed\",\n \"label\": \"Admin\"\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "512cea5c-9fc9-4b08-bbc8-6b8a6bad7c8a", "name": "Bad request", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InvalidBody\",\n \"title\": \"Invalid request\",\n \"detail\": \"Request body is invalid\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aa9727b4-342e-4daf-89d5-3b44d1cfba86", "name": "Unauthorized - Missing authentication", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:Unauthenticated\",\n \"title\": \"Missing authentication\",\n \"detail\": \"Please authenticate yourself\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6f57d78d-5fe1-4c28-b10c-4846d4d86f93", "name": "Forbidden - Access denied", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ForbiddenAccess\",\n \"title\": \"Access denied\",\n \"detail\": \"You do not have permission to access this resource\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53f746e6-e537-4506-b774-67cb72449940", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ResourceNotFound\",\n \"title\": \"User not found\",\n \"detail\": \"The requested user does not exist\",\n \"resource\": \"users/user-123\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "53b8633a-6d4d-47a6-a03f-358ce41fb867", "name": "Unprocessable Entity - Validation errors", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ValidationError\",\n \"title\": \"Invalid request\",\n \"errors\": [\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n },\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "55567b68-e4a9-4d35-9d1e-8593e86d7dba", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InternalError\",\n \"title\": \"Internal server error\",\n \"detail\": \"An unexpected error occurred\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fc35565b-eb30-48e5-88eb-14d97d5a2045", "name": "Update user", "request": { "name": "Update user", "description": { "content": "> [!important]\n> Required permission scope: `stonal.user.write`\n\nUpdates an existing user in the organization\n", "type": "text/plain" }, "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"uid\": \"\",\n \"password\": \"\",\n \"fromExternalIdp\": \"\",\n \"allAssets\": \"\",\n \"userGroupUids\": [\n \"\",\n \"\"\n ],\n \"permissions\": [\n {\n \"uid\": \"\"\n },\n {\n \"uid\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "318135e6-a118-4fe0-a1d8-57eca58944f7", "name": "User successfully updated", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"uid\": \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"password\": \"SecureP@ssw0rd!\",\n \"fromExternalIdp\": false,\n \"allAssets\": false,\n \"userGroupUids\": [\n \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"019619df-4768-7b28-ae66-afbee5b857ab\"\n ],\n \"permissions\": [\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n },\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "a5bedc4e-430b-4c0b-bd25-f57a423c058d", "name": "Bad request", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"uid\": \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"password\": \"SecureP@ssw0rd!\",\n \"fromExternalIdp\": false,\n \"allAssets\": false,\n \"userGroupUids\": [\n \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"019619df-4768-7b28-ae66-afbee5b857ab\"\n ],\n \"permissions\": [\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n },\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InvalidBody\",\n \"title\": \"Invalid request\",\n \"detail\": \"Request body is invalid\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2432a64a-ef93-498e-ab3b-3834cb61a403", "name": "Unauthorized - Missing authentication", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"uid\": \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"password\": \"SecureP@ssw0rd!\",\n \"fromExternalIdp\": false,\n \"allAssets\": false,\n \"userGroupUids\": [\n \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"019619df-4768-7b28-ae66-afbee5b857ab\"\n ],\n \"permissions\": [\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n },\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:Unauthenticated\",\n \"title\": \"Missing authentication\",\n \"detail\": \"Please authenticate yourself\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4ffdfd98-68ab-4556-93da-2f8803ec4054", "name": "Forbidden - Access denied", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"uid\": \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"password\": \"SecureP@ssw0rd!\",\n \"fromExternalIdp\": false,\n \"allAssets\": false,\n \"userGroupUids\": [\n \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"019619df-4768-7b28-ae66-afbee5b857ab\"\n ],\n \"permissions\": [\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n },\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ForbiddenAccess\",\n \"title\": \"Access denied\",\n \"detail\": \"You do not have permission to access this resource\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ce2c3ae7-5f87-4daa-982b-75137fb6b8bb", "name": "Unprocessable Entity - Validation errors", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"uid\": \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"password\": \"SecureP@ssw0rd!\",\n \"fromExternalIdp\": false,\n \"allAssets\": false,\n \"userGroupUids\": [\n \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"019619df-4768-7b28-ae66-afbee5b857ab\"\n ],\n \"permissions\": [\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n },\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ValidationError\",\n \"title\": \"Invalid request\",\n \"errors\": [\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n },\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00eeef66-23a7-4331-9d4d-0ca5074b6d8b", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"email\": \"john.doe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"uid\": \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"password\": \"SecureP@ssw0rd!\",\n \"fromExternalIdp\": false,\n \"allAssets\": false,\n \"userGroupUids\": [\n \"019619df-4768-76b7-81e3-2c56d374df46\",\n \"019619df-4768-7b28-ae66-afbee5b857ab\"\n ],\n \"permissions\": [\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n },\n {\n \"uid\": \"019619df-4767-730f-8d31-143712a08141\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InternalError\",\n \"title\": \"Internal server error\",\n \"detail\": \"An unexpected error occurred\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fbd12323-0fd6-41c2-974f-7acb8e038caa", "name": "Delete user", "request": { "name": "Delete user", "description": { "content": "> [!important]\n> Required permission scope: `stonal.user.write`\n\nDeletes an existing user in the organization\n", "type": "text/plain" }, "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "c625aad8-c6e2-469e-b3c0-c6c2c98788e9", "name": "User successfully deleted", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "37d80ab5-51dc-42df-8188-21a2397fad09", "name": "Bad request", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InvalidBody\",\n \"title\": \"Invalid request\",\n \"detail\": \"Request body is invalid\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b380b709-28cb-48d3-9402-e95e9467d187", "name": "Unauthorized - Missing authentication", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:Unauthenticated\",\n \"title\": \"Missing authentication\",\n \"detail\": \"Please authenticate yourself\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c92f62a6-8fed-4dc3-9eb2-9a069d46823a", "name": "Forbidden - Access denied", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ForbiddenAccess\",\n \"title\": \"Access denied\",\n \"detail\": \"You do not have permission to access this resource\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5cf4e3ed-b48f-44be-83c7-e8bc4409a65e", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ResourceNotFound\",\n \"title\": \"User not found\",\n \"detail\": \"The requested user does not exist\",\n \"resource\": \"users/user-123\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e25a543d-20ac-4917-ae32-16df5bbd0996", "name": "Conflict - Resource conflict", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:DeletionConflict\",\n \"title\": \"User cannot self delete\",\n \"detail\": \"You cannot delete yourself\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d9fdccb-98e7-407b-bbe4-b09c3008982c", "name": "Unprocessable Entity - Validation errors", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ValidationError\",\n \"title\": \"Invalid request\",\n \"errors\": [\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n },\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ae9da7c0-b762-406b-ba89-d2e6f51a7f79", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v2", "organizations", ":organizationCode", "users", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InternalError\",\n \"title\": \"Internal server error\",\n \"detail\": \"An unexpected error occurred\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "8fd35f0c-60a6-40b2-aa8f-42d930a9c4da", "name": "Groups", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "da4fdb55-c2b5-48d9-92c1-cbe2ba4c0ac2", "name": "Get groups", "request": { "name": "Get groups", "description": { "content": "> [!important]\n> Required permission scope: `stonal.user.read`\n\nReturns paginated groups for a given organization\n", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "groups" ], "host": [ "{{usersBaseUrl}}" ], "query": [ { "disabled": false, "key": "q", "value": "", "description": "Search query to filter groups by label" }, { "disabled": false, "key": "pageNumber", "value": "", "description": "(Required) Page number for pagination" }, { "disabled": false, "key": "pageSize", "value": "", "description": "(Required) Number of items per page" }, { "disabled": false, "key": "sortField", "value": "", "description": "Field to sort by" }, { "disabled": false, "key": "sortDirection", "value": "", "description": "Sort direction" }, { "disabled": false, "key": "uids", "value": "", "description": "Filter by group UUIDs" }, { "disabled": false, "key": "uids", "value": "", "description": "Filter by group UUIDs" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "30465ceb-5334-4690-9772-bec8db1185ae", "name": "Successful response", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups" ], "host": [ "{{usersBaseUrl}}" ], "query": [ { "key": "q", "value": "admin" }, { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "20" }, { "key": "sortField", "value": "label" }, { "key": "sortDirection", "value": "asc" }, { "key": "uids", "value": "019619df-4768-76b3-8ab3-4414dcf29ff1" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total\": 15,\n \"result\": [\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\",\n \"label\": \"Project Managers\",\n \"permissions\": {\n \"key_0\": {\n \"key_0\": {\n \"label\": \"string\",\n \"uid\": \"string\"\n }\n },\n \"key_1\": {\n \"key_0\": {\n \"label\": \"string\",\n \"uid\": \"string\"\n }\n },\n \"key_2\": {\n \"key_0\": {\n \"label\": \"string\",\n \"uid\": \"string\"\n },\n \"key_1\": {\n \"label\": \"string\",\n \"uid\": \"string\"\n }\n }\n },\n \"users\": {\n \"count\": 12\n }\n },\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\",\n \"label\": \"Project Managers\",\n \"permissions\": {\n \"key_0\": {\n \"key_0\": {\n \"label\": \"string\",\n \"uid\": \"string\"\n }\n }\n },\n \"users\": {\n \"count\": 12\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "06bb694e-0cb0-4f19-a800-8f5469d36867", "name": "Bad request", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups" ], "host": [ "{{usersBaseUrl}}" ], "query": [ { "key": "q", "value": "admin" }, { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "20" }, { "key": "sortField", "value": "label" }, { "key": "sortDirection", "value": "asc" }, { "key": "uids", "value": "019619df-4768-76b3-8ab3-4414dcf29ff1" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InvalidBody\",\n \"title\": \"Invalid request\",\n \"detail\": \"Request body is invalid\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0dffff28-949a-4940-b5d9-49b332aab7a9", "name": "Unauthorized - Missing authentication", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups" ], "host": [ "{{usersBaseUrl}}" ], "query": [ { "key": "q", "value": "admin" }, { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "20" }, { "key": "sortField", "value": "label" }, { "key": "sortDirection", "value": "asc" }, { "key": "uids", "value": "019619df-4768-76b3-8ab3-4414dcf29ff1" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:Unauthenticated\",\n \"title\": \"Missing authentication\",\n \"detail\": \"Please authenticate yourself\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "470d7488-eaa7-44c7-bf24-642a4be91deb", "name": "Forbidden - Access denied", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups" ], "host": [ "{{usersBaseUrl}}" ], "query": [ { "key": "q", "value": "admin" }, { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "20" }, { "key": "sortField", "value": "label" }, { "key": "sortDirection", "value": "asc" }, { "key": "uids", "value": "019619df-4768-76b3-8ab3-4414dcf29ff1" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ForbiddenAccess\",\n \"title\": \"Access denied\",\n \"detail\": \"You do not have permission to access this resource\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4d0500fd-6bf9-4550-8ea6-6be0cea55eb2", "name": "Unprocessable Entity - Validation errors", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups" ], "host": [ "{{usersBaseUrl}}" ], "query": [ { "key": "q", "value": "admin" }, { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "20" }, { "key": "sortField", "value": "label" }, { "key": "sortDirection", "value": "asc" }, { "key": "uids", "value": "019619df-4768-76b3-8ab3-4414dcf29ff1" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ValidationError\",\n \"title\": \"Invalid request\",\n \"errors\": [\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n },\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26ddc90c-93d7-497e-b8cb-1d78e1fae937", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups" ], "host": [ "{{usersBaseUrl}}" ], "query": [ { "key": "q", "value": "admin" }, { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "20" }, { "key": "sortField", "value": "label" }, { "key": "sortDirection", "value": "asc" }, { "key": "uids", "value": "019619df-4768-76b3-8ab3-4414dcf29ff1" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InternalError\",\n \"title\": \"Internal server error\",\n \"detail\": \"An unexpected error occurred\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "1e3fff82-efb2-4965-97ff-a884a8ee9a90", "name": "Create a group", "request": { "name": "Create a group", "description": { "content": "> [!important]\n> Required permission scope: `stonal.user.write`\n\nCreates a new group in the organization\n", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "groups" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"permissions\": [\n {\n \"uid\": \"\"\n },\n {\n \"uid\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "89ef102b-a863-4829-89a3-f0818e243450", "name": "Group successfully created", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"Project Managers\",\n \"permissions\": [\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n },\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "bd8e4361-2be9-4815-b80c-bbccab92174a", "name": "Group already exists", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"Project Managers\",\n \"permissions\": [\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n },\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "3a6ab632-57dd-44ca-b7fa-bc0f5945bb58", "name": "Bad request", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"Project Managers\",\n \"permissions\": [\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n },\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InvalidBody\",\n \"title\": \"Invalid request\",\n \"detail\": \"Request body is invalid\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "26cabbce-f680-4413-a740-9a52b097e885", "name": "Unauthorized - Missing authentication", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"Project Managers\",\n \"permissions\": [\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n },\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:Unauthenticated\",\n \"title\": \"Missing authentication\",\n \"detail\": \"Please authenticate yourself\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fce4351a-b065-4220-8c9e-4ff807015401", "name": "Forbidden - Access denied", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"Project Managers\",\n \"permissions\": [\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n },\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ForbiddenAccess\",\n \"title\": \"Access denied\",\n \"detail\": \"You do not have permission to access this resource\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7fd3c89-1a0c-4ba7-a871-a122efb89af6", "name": "Unprocessable Entity - Validation errors", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"Project Managers\",\n \"permissions\": [\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n },\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ValidationError\",\n \"title\": \"Invalid request\",\n \"errors\": [\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n },\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66fed325-80a2-4c64-b47d-066bd3e9e0b9", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"label\": \"Project Managers\",\n \"permissions\": [\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n },\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InternalError\",\n \"title\": \"Internal server error\",\n \"detail\": \"An unexpected error occurred\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e44cba9e-ff8c-4755-84ec-58abae67e479", "name": "Update a group", "request": { "name": "Update a group", "description": { "content": "> [!important]\n> Required permission scope: `stonal.user.write`\n\nUpdates an existing group in the organization\n", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "groups", ":uuid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of the group to update" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"label\": \"\",\n \"permissions\": [\n {\n \"uid\": \"\"\n },\n {\n \"uid\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "1f587ff0-687f-4f5a-a192-dc4740275668", "name": "Group successfully updated", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups", ":uuid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of the group to update" } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"label\": \"Project Managers\",\n \"permissions\": [\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n },\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "1afac05d-0a25-468b-a9d8-cf6445082334", "name": "Bad request", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups", ":uuid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of the group to update" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"label\": \"Project Managers\",\n \"permissions\": [\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n },\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InvalidBody\",\n \"title\": \"Invalid request\",\n \"detail\": \"Request body is invalid\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da19e583-a4e0-416c-9e7d-b5cd5dba27e9", "name": "Unauthorized - Missing authentication", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups", ":uuid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of the group to update" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"label\": \"Project Managers\",\n \"permissions\": [\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n },\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:Unauthenticated\",\n \"title\": \"Missing authentication\",\n \"detail\": \"Please authenticate yourself\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf264497-935c-460e-87c0-3bdbff1cef4f", "name": "Forbidden - Access denied", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups", ":uuid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of the group to update" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"label\": \"Project Managers\",\n \"permissions\": [\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n },\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ForbiddenAccess\",\n \"title\": \"Access denied\",\n \"detail\": \"You do not have permission to access this resource\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "17172c92-a52c-4189-916b-536cbbbec610", "name": "Unprocessable Entity - Validation errors", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups", ":uuid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of the group to update" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"label\": \"Project Managers\",\n \"permissions\": [\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n },\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ValidationError\",\n \"title\": \"Invalid request\",\n \"errors\": [\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n },\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47030ce5-821f-4648-aba0-c93035863641", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups", ":uuid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of the group to update" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"label\": \"Project Managers\",\n \"permissions\": [\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n },\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InternalError\",\n \"title\": \"Internal server error\",\n \"detail\": \"An unexpected error occurred\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e27d45d9-73e9-4054-a7bb-2997ea4a179a", "name": "Delete a group", "request": { "name": "Delete a group", "description": { "content": "> [!important]\n> Required permission scope: `stonal.user.write`\n\nDeletes an existing group from the organization\n", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "groups", ":uuid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of the group to delete" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "4bccdd1e-14c4-40b8-a933-d05c4c63abe3", "name": "Group successfully deleted", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups", ":uuid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of the group to delete" } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e8f0aa02-35aa-48e8-955b-df1133aa367d", "name": "Bad request", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups", ":uuid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of the group to delete" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InvalidBody\",\n \"title\": \"Invalid request\",\n \"detail\": \"Request body is invalid\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7f7d9c3a-210b-4eb1-9f8c-c1d6811d16a8", "name": "Unauthorized - Missing authentication", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups", ":uuid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of the group to delete" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:Unauthenticated\",\n \"title\": \"Missing authentication\",\n \"detail\": \"Please authenticate yourself\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a674dbb4-0c27-44ca-b692-f5c424ca6eaf", "name": "Forbidden - Access denied", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups", ":uuid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of the group to delete" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ForbiddenAccess\",\n \"title\": \"Access denied\",\n \"detail\": \"You do not have permission to access this resource\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9ad16f38-9487-49b5-b549-cff1796e041a", "name": "Conflict - Resource conflict", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups", ":uuid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of the group to delete" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:DeletionConflict\",\n \"title\": \"User cannot self delete\",\n \"detail\": \"You cannot delete yourself\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1d92db97-ea5a-4f67-a925-835402878046", "name": "Unprocessable Entity - Validation errors", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups", ":uuid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of the group to delete" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ValidationError\",\n \"title\": \"Invalid request\",\n \"errors\": [\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n },\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "89ae1669-dc06-49b8-8b8b-06e7f3467967", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "groups", ":uuid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uuid", "description": "(Required) UUID of the group to delete" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InternalError\",\n \"title\": \"Internal server error\",\n \"detail\": \"An unexpected error occurred\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "742ae38e-2a53-496d-89dd-fb945ccc9952", "name": "Permissions", "description": { "content": "", "type": "text/plain" }, "item": [ { "id": "e681ff66-4e14-4d85-b8c5-3a667ad67787", "name": "Get permissions", "request": { "name": "Get permissions", "description": { "content": "> [!important]\n> Required permission scope: `stonal.user.read`\n\nReturns paginated permissions for a given organization\n", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions" ], "host": [ "{{usersBaseUrl}}" ], "query": [ { "disabled": false, "key": "pageNumber", "value": "", "description": "(Required) Page number for pagination" }, { "disabled": false, "key": "pageSize", "value": "", "description": "(Required) Number of items per page" }, { "disabled": false, "key": "sortField", "value": "", "description": "Field to sort by" }, { "disabled": false, "key": "sortDirection", "value": "", "description": "Sort direction" }, { "disabled": false, "key": "type", "value": "", "description": "Filter by permission type. Can be a single value or comma-separated list of values.\nPossible values: ASSET, PROFILE, SCOPE, SCOPE_GROUP, REPORT, REPORT_GROUP\n" }, { "disabled": false, "key": "subType", "value": "", "description": "Filter by permission subtype. Can be a single value or comma-separated list of values.\nPossible values: BUILDING, BUILDING_GROUP, FACILITY, PORTFOLIO, COMPANY, APPLICATION, RIGHT\n" }, { "disabled": false, "key": "uids", "value": "", "description": "Comma-separated list of permission UIDs to filter by" }, { "disabled": false, "key": "parentUids", "value": "", "description": "Comma-separated list of parent permission UIDs to filter by. Returns permissions that are children of the specified parent permissions (permissions whose codes match assets, reports, or scopes linked to the parents)" }, { "disabled": false, "key": "level", "value": "", "description": "Filter permissions by their hierarchical level. Level 0 represents root permissions (permissions without parents), level 1 represents direct children of root permissions, level 2 represents grandchildren, and so on. When filtering by parentUids, only returns children at the specified level relative to the parent" }, { "disabled": false, "key": "q", "value": "", "description": "Search query to filter permissions" }, { "disabled": false, "key": "withUsers", "value": "", "description": "Include users associated with permissions" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "b9dfb207-87df-4754-ad9d-0c2927e0a3f2", "name": "Successful response", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions" ], "host": [ "{{usersBaseUrl}}" ], "query": [ { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "20" }, { "key": "sortField", "value": "label" }, { "key": "sortDirection", "value": "asc" }, { "key": "type", "value": "ASSET,PROFILE" }, { "key": "subType", "value": "PORTFOLIO,BUILDING" }, { "key": "uids", "value": "uid1,uid2,uid3" }, { "key": "parentUids", "value": "parent-uid1,parent-uid2" }, { "key": "level", "value": "0" }, { "key": "q", "value": "building" }, { "key": "withUsers", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"total\": 42,\n \"result\": [\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\",\n \"type\": \"ASSET\",\n \"code\": \"portfolio-123\",\n \"label\": \"Alpha Portfolio\",\n \"metadata\": {\n \"url\": \"https://example.com\",\n \"logo\": {\n \"format\": \"SVG\",\n \"resource\": \"\"\n },\n \"thematic\": {\n \"uid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"names\": {\n \"en-GB\": \"Environmental Sustainability\",\n \"fr-FR\": \"Durabilité Environnementale\"\n },\n \"order\": 1\n },\n \"assetCode\": \"ASSET-001\"\n },\n \"children\": {\n \"count\": 5,\n \"uids\": [\n \"019619df-4767-730f-8d31-143712a08141\",\n \"019619df-4768-75e4-a334-cde454b9e9e1\"\n ]\n },\n \"subType\": \"PORTFOLIO\",\n \"description\": \"The Alpha Portfolio of buildings\",\n \"users\": {\n \"count\": 3\n }\n },\n {\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\",\n \"type\": \"ASSET\",\n \"code\": \"portfolio-123\",\n \"label\": \"Alpha Portfolio\",\n \"metadata\": {\n \"url\": \"https://example.com\",\n \"logo\": {\n \"format\": \"SVG\",\n \"resource\": \"\"\n },\n \"thematic\": {\n \"uid\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"names\": {\n \"en-GB\": \"Environmental Sustainability\",\n \"fr-FR\": \"Durabilité Environnementale\"\n },\n \"order\": 1\n },\n \"assetCode\": \"ASSET-001\"\n },\n \"children\": {\n \"count\": 5,\n \"uids\": [\n \"019619df-4767-730f-8d31-143712a08141\",\n \"019619df-4768-75e4-a334-cde454b9e9e1\"\n ]\n },\n \"subType\": \"PORTFOLIO\",\n \"description\": \"The Alpha Portfolio of buildings\",\n \"users\": {\n \"count\": 3\n }\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "40ca1b39-80d3-4ad1-8ae9-b80514b43368", "name": "Bad request", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions" ], "host": [ "{{usersBaseUrl}}" ], "query": [ { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "20" }, { "key": "sortField", "value": "label" }, { "key": "sortDirection", "value": "asc" }, { "key": "type", "value": "ASSET,PROFILE" }, { "key": "subType", "value": "PORTFOLIO,BUILDING" }, { "key": "uids", "value": "uid1,uid2,uid3" }, { "key": "parentUids", "value": "parent-uid1,parent-uid2" }, { "key": "level", "value": "0" }, { "key": "q", "value": "building" }, { "key": "withUsers", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InvalidBody\",\n \"title\": \"Invalid request\",\n \"detail\": \"Request body is invalid\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f1c0467c-32c3-4f9c-84a6-4d55b7159b17", "name": "Unauthorized - Missing authentication", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions" ], "host": [ "{{usersBaseUrl}}" ], "query": [ { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "20" }, { "key": "sortField", "value": "label" }, { "key": "sortDirection", "value": "asc" }, { "key": "type", "value": "ASSET,PROFILE" }, { "key": "subType", "value": "PORTFOLIO,BUILDING" }, { "key": "uids", "value": "uid1,uid2,uid3" }, { "key": "parentUids", "value": "parent-uid1,parent-uid2" }, { "key": "level", "value": "0" }, { "key": "q", "value": "building" }, { "key": "withUsers", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:Unauthenticated\",\n \"title\": \"Missing authentication\",\n \"detail\": \"Please authenticate yourself\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bca6e5ff-340d-4499-9370-e96220bea48c", "name": "Forbidden - Access denied", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions" ], "host": [ "{{usersBaseUrl}}" ], "query": [ { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "20" }, { "key": "sortField", "value": "label" }, { "key": "sortDirection", "value": "asc" }, { "key": "type", "value": "ASSET,PROFILE" }, { "key": "subType", "value": "PORTFOLIO,BUILDING" }, { "key": "uids", "value": "uid1,uid2,uid3" }, { "key": "parentUids", "value": "parent-uid1,parent-uid2" }, { "key": "level", "value": "0" }, { "key": "q", "value": "building" }, { "key": "withUsers", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ForbiddenAccess\",\n \"title\": \"Access denied\",\n \"detail\": \"You do not have permission to access this resource\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f4819301-4280-43fd-81d0-60654e2a0694", "name": "Unprocessable Entity - Validation errors", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions" ], "host": [ "{{usersBaseUrl}}" ], "query": [ { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "20" }, { "key": "sortField", "value": "label" }, { "key": "sortDirection", "value": "asc" }, { "key": "type", "value": "ASSET,PROFILE" }, { "key": "subType", "value": "PORTFOLIO,BUILDING" }, { "key": "uids", "value": "uid1,uid2,uid3" }, { "key": "parentUids", "value": "parent-uid1,parent-uid2" }, { "key": "level", "value": "0" }, { "key": "q", "value": "building" }, { "key": "withUsers", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ValidationError\",\n \"title\": \"Invalid request\",\n \"errors\": [\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n },\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68f130db-104c-4b8f-8b06-9d70d2897964", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions" ], "host": [ "{{usersBaseUrl}}" ], "query": [ { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "20" }, { "key": "sortField", "value": "label" }, { "key": "sortDirection", "value": "asc" }, { "key": "type", "value": "ASSET,PROFILE" }, { "key": "subType", "value": "PORTFOLIO,BUILDING" }, { "key": "uids", "value": "uid1,uid2,uid3" }, { "key": "parentUids", "value": "parent-uid1,parent-uid2" }, { "key": "level", "value": "0" }, { "key": "q", "value": "building" }, { "key": "withUsers", "value": "true" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InternalError\",\n \"title\": \"Internal server error\",\n \"detail\": \"An unexpected error occurred\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cde7a089-b6ad-4d6e-bca7-6cffd11e30df", "name": "Create or update permission", "request": { "name": "Create or update permission", "description": { "content": "> [!important]\n> Required permission scope: `stonal.user.write`\n\nCreates a new permission or updates an existing one\n", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"\",\n \"type\": \"\",\n \"label\": \"\",\n \"uid\": \"\",\n \"subType\": \"\",\n \"description\": \"\",\n \"scopes\": [\n {\n \"code\": \"\"\n },\n {\n \"code\": \"\"\n }\n ],\n \"reports\": [\n {\n \"uid\": \"\"\n },\n {\n \"uid\": \"\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "203808dd-c5ca-4b0f-aea0-acbce2eb81bc", "name": "Permission successfully created or updated", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"portfolio-123\",\n \"type\": \"ASSET\",\n \"label\": \"Alpha Portfolio\",\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\",\n \"subType\": \"PORTFOLIO\",\n \"description\": \"The Alpha Portfolio of buildings\",\n \"scopes\": [\n {\n \"code\": \"stonal.application.etl\"\n },\n {\n \"code\": \"stonal.application.etl\"\n }\n ],\n \"reports\": [\n {\n \"uid\": \"550e8400-e29b-41d4-a716-446655440000\"\n },\n {\n \"uid\": \"550e8400-e29b-41d4-a716-446655440000\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "7446dea4-16d4-4739-a690-94ba3b42aa2b", "name": "Bad request", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"portfolio-123\",\n \"type\": \"ASSET\",\n \"label\": \"Alpha Portfolio\",\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\",\n \"subType\": \"PORTFOLIO\",\n \"description\": \"The Alpha Portfolio of buildings\",\n \"scopes\": [\n {\n \"code\": \"stonal.application.etl\"\n },\n {\n \"code\": \"stonal.application.etl\"\n }\n ],\n \"reports\": [\n {\n \"uid\": \"550e8400-e29b-41d4-a716-446655440000\"\n },\n {\n \"uid\": \"550e8400-e29b-41d4-a716-446655440000\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InvalidBody\",\n \"title\": \"Invalid request\",\n \"detail\": \"Request body is invalid\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9bde4736-e347-4515-866b-aeed6c36bbdb", "name": "Unauthorized - Missing authentication", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"portfolio-123\",\n \"type\": \"ASSET\",\n \"label\": \"Alpha Portfolio\",\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\",\n \"subType\": \"PORTFOLIO\",\n \"description\": \"The Alpha Portfolio of buildings\",\n \"scopes\": [\n {\n \"code\": \"stonal.application.etl\"\n },\n {\n \"code\": \"stonal.application.etl\"\n }\n ],\n \"reports\": [\n {\n \"uid\": \"550e8400-e29b-41d4-a716-446655440000\"\n },\n {\n \"uid\": \"550e8400-e29b-41d4-a716-446655440000\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:Unauthenticated\",\n \"title\": \"Missing authentication\",\n \"detail\": \"Please authenticate yourself\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e61641a2-fce7-4708-a807-38690968be46", "name": "Forbidden - Access denied", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"portfolio-123\",\n \"type\": \"ASSET\",\n \"label\": \"Alpha Portfolio\",\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\",\n \"subType\": \"PORTFOLIO\",\n \"description\": \"The Alpha Portfolio of buildings\",\n \"scopes\": [\n {\n \"code\": \"stonal.application.etl\"\n },\n {\n \"code\": \"stonal.application.etl\"\n }\n ],\n \"reports\": [\n {\n \"uid\": \"550e8400-e29b-41d4-a716-446655440000\"\n },\n {\n \"uid\": \"550e8400-e29b-41d4-a716-446655440000\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ForbiddenAccess\",\n \"title\": \"Access denied\",\n \"detail\": \"You do not have permission to access this resource\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12036f69-9cf0-40a7-be23-c9bfb905c235", "name": "Unprocessable Entity - Validation errors", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"portfolio-123\",\n \"type\": \"ASSET\",\n \"label\": \"Alpha Portfolio\",\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\",\n \"subType\": \"PORTFOLIO\",\n \"description\": \"The Alpha Portfolio of buildings\",\n \"scopes\": [\n {\n \"code\": \"stonal.application.etl\"\n },\n {\n \"code\": \"stonal.application.etl\"\n }\n ],\n \"reports\": [\n {\n \"uid\": \"550e8400-e29b-41d4-a716-446655440000\"\n },\n {\n \"uid\": \"550e8400-e29b-41d4-a716-446655440000\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ValidationError\",\n \"title\": \"Invalid request\",\n \"errors\": [\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n },\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "de3c9c65-2666-4f2c-b2c4-5285e9fe443a", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"code\": \"portfolio-123\",\n \"type\": \"ASSET\",\n \"label\": \"Alpha Portfolio\",\n \"uid\": \"019619df-4768-76b3-8ab3-4414dcf29ff1\",\n \"subType\": \"PORTFOLIO\",\n \"description\": \"The Alpha Portfolio of buildings\",\n \"scopes\": [\n {\n \"code\": \"stonal.application.etl\"\n },\n {\n \"code\": \"stonal.application.etl\"\n }\n ],\n \"reports\": [\n {\n \"uid\": \"550e8400-e29b-41d4-a716-446655440000\"\n },\n {\n \"uid\": \"550e8400-e29b-41d4-a716-446655440000\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InternalError\",\n \"title\": \"Internal server error\",\n \"detail\": \"An unexpected error occurred\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cc118ca1-1111-4ba5-9932-6fae1bbc8baf", "name": "Delete a permission", "request": { "name": "Delete a permission", "description": { "content": "> [!important]\n> Required permission scope: `stonal.user.write`\n\nDeletes an existing permission\n\nPlease note that you can only delete permissions of type `SCOPE_GROUP` and `PROFILE`.\n", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the permission" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "e1a1d50c-4472-4f6e-af99-68dfae7d7f6d", "name": "Permission successfully deleted", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the permission" } ] }, "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e4efc58b-592e-4ff8-9889-96958c183d0c", "name": "Bad request", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the permission" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InvalidBody\",\n \"title\": \"Invalid request\",\n \"detail\": \"Request body is invalid\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d9f6d99-f23a-4af6-9765-5ac1ac64e57b", "name": "Unauthorized - Missing authentication", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the permission" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:Unauthenticated\",\n \"title\": \"Missing authentication\",\n \"detail\": \"Please authenticate yourself\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "682d7737-a079-40f3-a113-ed83772ec290", "name": "Forbidden - Access denied", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the permission" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ForbiddenAccess\",\n \"title\": \"Access denied\",\n \"detail\": \"You do not have permission to access this resource\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3cbef00a-44f4-4cbe-87a1-e1738dfd4c70", "name": "Resource not found", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the permission" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ResourceNotFound\",\n \"title\": \"User not found\",\n \"detail\": \"The requested user does not exist\",\n \"resource\": \"users/user-123\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ff203131-6552-4493-87a8-7a259503af90", "name": "Conflict - Resource conflict", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the permission" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:DeletionConflict\",\n \"title\": \"User cannot self delete\",\n \"detail\": \"You cannot delete yourself\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3edb38a5-b5ce-465e-9289-fd24eb6a64f6", "name": "Unprocessable Entity - Validation errors", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the permission" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:ValidationError\",\n \"title\": \"Invalid request\",\n \"errors\": [\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n },\n {\n \"field\": \"email\",\n \"detail\": \"Email is required\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18da01f1-6406-4ba4-a976-0a5f7168016c", "name": "Internal server error", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "permissions", ":uid" ], "host": [ "{{usersBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "uid", "description": "(Required) UID of the permission" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"type\": \"tag:InternalError\",\n \"title\": \"Internal server error\",\n \"detail\": \"An unexpected error occurred\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ] }, { "name": "Legacy", "item": [ { "id": "6ab84e17-941c-4953-8b3e-f8e37633ce1e", "name": "2. API Version 1", "description": { "content": "API to read data from Stonal", "type": "text/plain" }, "item": [ { "id": "69b1208a-481f-4741-886a-db298e5e3983", "name": "Create a new user", "request": { "name": "Create a new user", "description": { "content": " Create a new user.\n\n To create a new user, you should get informations first in order to be able to provide all necessary information:\n - profiles via GET /v1/organizations/{organizationCode}/users/profiles\n - companies via GET /v1/organizations/{organizationCode}/users/companies\n - authorizations via GET /v1/organizations/{organizationCode}/users/authorizations\n - permissions via GET /v1/organizations/{organizationCode}/users/permissions\n", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "users" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"authorization\": {\n \"asset\": {\n \"all\": \"\",\n \"codes\": [\n \"\",\n \"\"\n ]\n },\n \"modelId\": \"\",\n \"profile\": \"\"\n },\n \"company\": \"\",\n \"email\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"permissionUids\": [\n \"\",\n \"\"\n ],\n \"fromExternalIdp\": \"\",\n \"groupUids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8ed3341d-afce-487f-8172-c306da0c3141", "name": "User has been created", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "users" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"authorization\": {\n \"asset\": {\n \"all\": true,\n \"codes\": [\n \"['S01', 'B01']\",\n \"['S01', 'B01']\"\n ]\n },\n \"modelId\": \"2b2e8a4b-bfbd-4c56-b8d6-c8cb1d8c58ba\",\n \"profile\": \"Developer\"\n },\n \"company\": \"corp\",\n \"email\": \"firstName.lastName@corp.com\",\n \"firstName\": \"firstName\",\n \"lastName\": \"lastName\",\n \"permissionUids\": [\n \"0192d7b7-2994-7ad5-9952-26862f33c21a\",\n \"0192d7b7-7073-7e58-896c-07113f22363a\"\n ],\n \"fromExternalIdp\": false,\n \"groupUids\": [\n \"0192d7b7-2994-7ad5-9952-26862f33c21a\",\n \"0192d7b7-7073-7e58-896c-07113f22363a\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c9941d72-c50a-444a-9e54-5dd897da3351", "name": "User creation seems to have been done but cannot be confirmed because user could not be found", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "users" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"authorization\": {\n \"asset\": {\n \"all\": true,\n \"codes\": [\n \"['S01', 'B01']\",\n \"['S01', 'B01']\"\n ]\n },\n \"modelId\": \"2b2e8a4b-bfbd-4c56-b8d6-c8cb1d8c58ba\",\n \"profile\": \"Developer\"\n },\n \"company\": \"corp\",\n \"email\": \"firstName.lastName@corp.com\",\n \"firstName\": \"firstName\",\n \"lastName\": \"lastName\",\n \"permissionUids\": [\n \"0192d7b7-2994-7ad5-9952-26862f33c21a\",\n \"0192d7b7-7073-7e58-896c-07113f22363a\"\n ],\n \"fromExternalIdp\": false,\n \"groupUids\": [\n \"0192d7b7-2994-7ad5-9952-26862f33c21a\",\n \"0192d7b7-7073-7e58-896c-07113f22363a\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Accepted", "code": 202, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"This is a message\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "16688b2d-56df-484e-aab9-8f37411cfef9", "name": "User creation cannot be done because user already exists", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "users" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"authorization\": {\n \"asset\": {\n \"all\": true,\n \"codes\": [\n \"['S01', 'B01']\",\n \"['S01', 'B01']\"\n ]\n },\n \"modelId\": \"2b2e8a4b-bfbd-4c56-b8d6-c8cb1d8c58ba\",\n \"profile\": \"Developer\"\n },\n \"company\": \"corp\",\n \"email\": \"firstName.lastName@corp.com\",\n \"firstName\": \"firstName\",\n \"lastName\": \"lastName\",\n \"permissionUids\": [\n \"0192d7b7-2994-7ad5-9952-26862f33c21a\",\n \"0192d7b7-7073-7e58-896c-07113f22363a\"\n ],\n \"fromExternalIdp\": false,\n \"groupUids\": [\n \"0192d7b7-2994-7ad5-9952-26862f33c21a\",\n \"0192d7b7-7073-7e58-896c-07113f22363a\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"message\": \"This is a message\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a749dba4-72a6-42cf-a5e8-290ed509949b", "name": "List all authorizations available for users", "request": { "name": "List all authorizations available for users", "description": {}, "url": { "path": [ "v1", "organizations", ":organizationCode", "users", "authorizations" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "7e0f811f-ad53-4d14-974d-a690c4e55d5e", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "users", "authorizations" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"pageable\": {\n \"offset\": 0,\n \"size\": 10,\n \"sort\": {\n \"fieldOrder\": {\n \"name\": \"asc\",\n \"age\": \"desc\"\n }\n }\n },\n \"result\": [\n {\n \"applications\": [\n \"STONAL\"\n ],\n \"description\": \"Administrator can use all platform services\",\n \"id\": \"0a0e6591-2e72-4ae5-a8de-64e86efdb696\",\n \"name\": \"Administrator\"\n }\n ],\n \"total\": 10000\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "e4c96b5d-0b3a-43c0-a544-e4fba368a96a", "name": "List all companies available for users", "request": { "name": "List all companies available for users", "description": {}, "url": { "path": [ "v1", "organizations", ":organizationCode", "users", "companies" ], "host": [ "{{legacyBaseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "", "description": "page requested (if we cannot retrieve all companies at once)" }, { "disabled": false, "key": "size", "value": "", "description": "size for page requested (if we cannot retrieve all companies at once)" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "e1a88893-c59c-4d76-88f3-8bece88fb979", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "users", "companies" ], "host": [ "{{legacyBaseUrl}}" ], "query": [ { "key": "page", "value": "0" }, { "key": "size", "value": "100" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"pageable\": {\n \"offset\": 0,\n \"size\": 10,\n \"sort\": {\n \"fieldOrder\": {\n \"name\": \"asc\",\n \"age\": \"desc\"\n }\n }\n },\n \"result\": [\n \"string\"\n ],\n \"total\": 10000\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "713211ca-3432-4b25-b7f9-7a18c7d45568", "name": "List all groups available for users", "request": { "name": "List all groups available for users", "description": {}, "url": { "path": [ "v1", "organizations", ":organizationCode", "users", "groups" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET" }, "response": [ { "id": "9989df7c-ec51-4090-b59b-79e7617edeed", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "users", "groups" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "[\n {\n \"name\": \"ASSET\",\n \"uid\": \"0a0e6591-2e72-4ae5-a8de-64e86efdb696\"\n },\n {\n \"name\": \"ASSET\",\n \"uid\": \"0a0e6591-2e72-4ae5-a8de-64e86efdb696\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "595928b8-3794-4fa4-b08d-ba2b02838366", "name": "List all permissions available for users", "request": { "name": "List all permissions available for users", "description": {}, "url": { "path": [ "v1", "organizations", ":organizationCode", "users", "permissions" ], "host": [ "{{legacyBaseUrl}}" ], "query": [ { "disabled": false, "key": "type", "value": "", "description": "Permission type" }, { "disabled": false, "key": "subType", "value": "", "description": "Permission sub type" }, { "disabled": false, "key": "q", "value": "", "description": "Search query on label" }, { "disabled": false, "key": "pageNumber", "value": "", "description": "(Required) Page requested" }, { "disabled": false, "key": "pageSize", "value": "", "description": "(Required) Size for page requested" }, { "disabled": false, "key": "sortField", "value": "", "description": "Sort field to apply on the results" }, { "disabled": false, "key": "sortOrder", "value": "", "description": "Sort order to apply on the results" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "2153616e-dbed-47dd-8e70-dcc681527ef8", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "users", "permissions" ], "host": [ "{{legacyBaseUrl}}" ], "query": [ { "key": "type", "value": "ASSET" }, { "key": "subType", "value": "PORTFOLIO" }, { "key": "q", "value": "Alpha" }, { "key": "pageNumber", "value": "1" }, { "key": "pageSize", "value": "100" }, { "key": "sortField", "value": "label" }, { "key": "sortOrder", "value": "asc" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"pageable\": {\n \"pageNumber\": 0,\n \"size\": 10,\n \"sort\": {\n \"fieldOrder\": {\n \"name\": \"asc\",\n \"age\": \"desc\"\n }\n }\n },\n \"result\": [\n {\n \"code\": \"0a0e6591-2e72-4ae5-a8de-64e86efdb696\",\n \"label\": \"Portefeuille Alpha\",\n \"subType\": \"BUILDING\",\n \"type\": \"ASSET\",\n \"uid\": \"0a0e6591-2e72-4ae5-a8de-64e86efdb696\"\n },\n {\n \"code\": \"0a0e6591-2e72-4ae5-a8de-64e86efdb696\",\n \"label\": \"Portefeuille Alpha\",\n \"subType\": \"BUILDING\",\n \"type\": \"ASSET\",\n \"uid\": \"0a0e6591-2e72-4ae5-a8de-64e86efdb696\"\n }\n ],\n \"total\": 10000\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "cc674f9d-6031-449d-b406-3787150d6654", "name": "List all profiles available for users", "request": { "name": "List all profiles available for users", "description": {}, "url": { "path": [ "v1", "organizations", ":organizationCode", "users", "profiles" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET" }, "response": [ { "id": "1bfdacdd-1a69-4682-be52-ed2c028d7f7f", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "users", "profiles" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" } ] }, "header": [ { "key": "Accept", "value": "*/*" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "*/*" } ], "body": "{\n \"pageable\": {\n \"offset\": 0,\n \"size\": 10,\n \"sort\": {\n \"fieldOrder\": {\n \"name\": \"asc\",\n \"age\": \"desc\"\n }\n }\n },\n \"result\": [\n \"string\"\n ],\n \"total\": 10000\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8eb982b3-9f3a-4e26-97d4-575436ca7c6e", "name": "Search users", "request": { "name": "Search users", "description": { "content": " Search users by various filters.\n", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "users", "search" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"authorizationModelNames\": [\n \"\",\n \"\"\n ],\n \"email\": \"\",\n \"profiles\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "8ac5ed06-987a-4ab0-9e53-b3b6d3043dc7", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "users", "search" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"authorizationModelNames\": [\n \"Standard\",\n \"All\"\n ],\n \"email\": \"firstName.lastName@corp.com\",\n \"profiles\": [\n \"Expert\",\n \"Buyer\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"pageable\": {\n \"offset\": 0,\n \"size\": 10,\n \"sort\": {\n \"fieldOrder\": {\n \"name\": \"asc\",\n \"age\": \"desc\"\n }\n }\n },\n \"result\": [\n {\n \"email\": \"firstName.lastName@corp.com\",\n \"firstName\": \"firstName\",\n \"id\": \"309a666e-47c4-41ad-92b7-c483dc8dd1d1\",\n \"lastName\": \"lastName\"\n }\n ],\n \"total\": 10000\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b38eefdb-ea01-477b-9c63-a376a4e0677c", "name": "Delete an existing user", "request": { "name": "Delete an existing user", "description": { "content": " Delete an existing user.\n", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "users", ":id" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Id of user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE" }, "response": [ { "id": "d6d6e5d6-f7eb-433f-ab56-f89c635addb5", "name": "User has been deleted", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "users", ":id" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Id of user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f3951a69-9a51-4326-af15-ac7a8b3353b5", "name": "User to delete does not exists", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "users", ":id" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Id of user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "471a927c-7b30-4298-a001-90f51b465757", "name": "Get a user by its id", "request": { "name": "Get a user by its id", "description": {}, "url": { "path": [ "v1", "organizations", ":organizationCode", "users", ":id" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Id of user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET" }, "response": [ { "id": "5bedb2ca-9138-4cfc-8869-27dad21a89d7", "name": "User found", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "users", ":id" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Id of user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"authorization\": {\n \"asset\": {\n \"all\": true,\n \"codes\": [\n \"['S01', 'B01']\",\n \"['S01', 'B01']\"\n ]\n },\n \"modelId\": \"2b2e8a4b-bfbd-4c56-b8d6-c8cb1d8c58ba\",\n \"profile\": \"Developer\"\n },\n \"company\": \"corp\",\n \"email\": \"firstName.lastName@corp.com\",\n \"firstName\": \"firstName\",\n \"groupUids\": [\n \"0192d7b7-2994-7ad5-9952-26862f33c21a\",\n \"0192d7b7-7073-7e58-896c-07113f22363a\"\n ],\n \"lastName\": \"lastName\",\n \"permissionUids\": [\n \"0192d7b7-2994-7ad5-9952-26862f33c21a\",\n \"0192d7b7-7073-7e58-896c-07113f22363a\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "87f88144-0aee-4247-81c0-3d6d31bc41af", "name": "Not found", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "users", ":id" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Id of user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "5b406818-540b-4c91-ac82-5a2f96fcf2b6", "name": "Update an existing user", "request": { "name": "Update an existing user", "description": { "content": " Update an existing user.\n\n To update an existing user, you should get informations first in order to be able to provide all necessary information:\n - profiles via GET /v1/organizations/{organizationCode}/users/profiles\n - companies via GET /v1/organizations/{organizationCode}/users/companies\n - authorizations via GET /v1/organizations/{organizationCode}/users/authorizations\n - permissions via GET /v1/organizations/{organizationCode}/users/permissions\n", "type": "text/plain" }, "url": { "path": [ "v1", "organizations", ":organizationCode", "users", ":id" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Id of user" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"authorization\": {\n \"asset\": {\n \"all\": \"\",\n \"codes\": [\n \"\",\n \"\"\n ]\n },\n \"modelId\": \"\",\n \"profile\": \"\"\n },\n \"company\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"permissionUids\": [\n \"\",\n \"\"\n ],\n \"groupUids\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "96464df3-2086-421a-b6e2-51e010a94bbc", "name": "User has been updated", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "users", ":id" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Id of user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"authorization\": {\n \"asset\": {\n \"all\": true,\n \"codes\": [\n \"['S01', 'B01']\",\n \"['S01', 'B01']\"\n ]\n },\n \"modelId\": \"2b2e8a4b-bfbd-4c56-b8d6-c8cb1d8c58ba\",\n \"profile\": \"Developer\"\n },\n \"company\": \"corp\",\n \"firstName\": \"firstName\",\n \"lastName\": \"lastName\",\n \"permissionUids\": [\n \"0192d7b7-2994-7ad5-9952-26862f33c21a\",\n \"0192d7b7-7073-7e58-896c-07113f22363a\"\n ],\n \"groupUids\": [\n \"0192d7b7-2994-7ad5-9952-26862f33c21a\",\n \"0192d7b7-7073-7e58-896c-07113f22363a\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "No Content", "code": 204, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "09700de3-452c-4d5e-8c0c-2063e2d1788b", "name": "User to update does not exists", "originalRequest": { "url": { "path": [ "v1", "organizations", ":organizationCode", "users", ":id" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" }, { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) Id of user" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"authorization\": {\n \"asset\": {\n \"all\": true,\n \"codes\": [\n \"['S01', 'B01']\",\n \"['S01', 'B01']\"\n ]\n },\n \"modelId\": \"2b2e8a4b-bfbd-4c56-b8d6-c8cb1d8c58ba\",\n \"profile\": \"Developer\"\n },\n \"company\": \"corp\",\n \"firstName\": \"firstName\",\n \"lastName\": \"lastName\",\n \"permissionUids\": [\n \"0192d7b7-2994-7ad5-9952-26862f33c21a\",\n \"0192d7b7-7073-7e58-896c-07113f22363a\"\n ],\n \"groupUids\": [\n \"0192d7b7-2994-7ad5-9952-26862f33c21a\",\n \"0192d7b7-7073-7e58-896c-07113f22363a\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "\"\"", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "e608d2e8-5588-46cb-83c1-5bcffd6c24a0", "name": "1. Get token for Swagger", "description": { "content": "API to get a token for Swagger UI usage", "type": "text/plain" }, "item": [ { "id": "1802a733-6fb3-4ffb-a656-fe9e0302f7d2", "name": "Get an access token to use for Swagger UI", "request": { "name": "Get an access token to use for Swagger UI", "description": {}, "url": { "path": [ "swagger", "auth", "token" ], "host": [ "{{legacyBaseUrl}}" ], "query": [ { "disabled": false, "key": "grant_type", "value": "password", "description": "(Required) Type of OAuth flow. Use password in doubt." }, { "disabled": false, "key": "username", "value": "", "description": "(Required) Username" }, { "disabled": false, "key": "password", "value": "", "description": "(Required) Password" }, { "disabled": false, "key": "clientId", "value": "", "description": "(Required) OAuth client ID" }, { "disabled": false, "key": "clientSecret", "value": "", "description": "(Required) OAuth client secret" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST" }, "response": [ { "id": "be9d9dab-ccb3-467d-b24a-9b028c915903", "name": "Successfully retrieved", "originalRequest": { "url": { "path": [ "swagger", "auth", "token" ], "host": [ "{{legacyBaseUrl}}" ], "query": [ { "key": "grant_type", "value": "password" }, { "key": "username", "value": "username@stonal.com" }, { "key": "password", "value": "mypassword" }, { "key": "clientId", "value": "myclient" }, { "key": "clientSecret", "value": "mysecret" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"access_token\": \"string\",\n \"expires_in\": 7517,\n \"refresh_expires_in\": 752,\n \"refresh_token\": \"string\",\n \"scope\": \"string\",\n \"token_type\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "3eb9915a-ecfd-4068-beab-6ac53f6f885d", "name": "6. API Version 5", "description": { "content": "API to interact with data of Stonal", "type": "text/plain" }, "item": [ { "id": "bf294d01-142c-4c3b-8008-2105aa1f7387", "name": "Validate documents classification", "request": { "name": "Validate documents classification", "description": {}, "url": { "path": [ "v5", "organizations", ":organizationCode", "assets", ":assetIdentifier", "documents" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "assetIdentifier", "description": "(Required) asset identifier" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "[\n {\n \"documentClassIdentifier\": \"\",\n \"documentIdentifier\": \"\",\n \"documentationIdentifier\": \"\",\n \"folderIdentifier\": \"\"\n },\n {\n \"documentClassIdentifier\": \"\",\n \"documentIdentifier\": \"\",\n \"documentationIdentifier\": \"\",\n \"folderIdentifier\": \"\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "9d1c4755-56d5-4041-a393-59d41ff81d3f", "name": "Successfully done", "originalRequest": { "url": { "path": [ "v5", "organizations", ":organizationCode", "assets", ":assetIdentifier", "documents" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) code of the organization" }, { "disabled": false, "type": "any", "value": "", "key": "assetIdentifier", "description": "(Required) asset identifier" } ] }, "method": "PUT", "body": { "mode": "raw", "raw": "[\n {\n \"documentClassIdentifier\": \"aaaa-bbbb-cccc-dddd\",\n \"documentIdentifier\": \"aaaa-bbbb-cccc-dddd\",\n \"documentationIdentifier\": \"aaaa-bbbb-cccc-dddd\",\n \"folderIdentifier\": \"aaaa-bbbb-cccc-dddd\"\n },\n {\n \"documentClassIdentifier\": \"aaaa-bbbb-cccc-dddd\",\n \"documentIdentifier\": \"aaaa-bbbb-cccc-dddd\",\n \"documentationIdentifier\": \"aaaa-bbbb-cccc-dddd\",\n \"folderIdentifier\": \"aaaa-bbbb-cccc-dddd\"\n }\n]", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "26d30644-0a99-4902-ac56-139186f526d6", "name": "Search for documents", "request": { "name": "Search for documents", "description": {}, "url": { "path": [ "v5", "organizations", ":organizationCode", "documents", "search" ], "host": [ "{{legacyBaseUrl}}" ], "query": [ { "disabled": false, "key": "pageNumber", "value": "0", "description": "Page number from which the search will start" }, { "disabled": false, "key": "pageSize", "value": "10", "description": "Page size of documents to be requested" }, { "disabled": false, "key": "columnToSort", "value": "", "description": "Column to sort" }, { "disabled": false, "key": "sortOrder", "value": "", "description": "Sort order" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIdentifiers\": [\n \"\",\n \"\"\n ],\n \"documentClass\": \"fr-FR\",\n \"documentStatus\": \"\",\n \"documentationIdentifiers\": [\n \"\",\n \"\"\n ],\n \"folderIdentifiers\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"organizationCode\": \"\",\n \"propertyKey\": \"\",\n \"rentedUnit\": \"\",\n \"rentedUnitIdentifiers\": [\n \"\",\n \"\"\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"tenantIdentifiers\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "29ed04f5-3352-4772-bc05-7f50acf7db53", "name": "Successfully retrieved", "originalRequest": { "url": { "path": [ "v5", "organizations", ":organizationCode", "documents", "search" ], "host": [ "{{legacyBaseUrl}}" ], "query": [ { "key": "pageNumber", "value": "3" }, { "key": "pageSize", "value": "10" }, { "key": "columnToSort", "value": "name" }, { "key": "sortOrder", "value": "ASCENDING" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"assetIdentifiers\": [\n \"aaaa-bbbb-cccc-dddd\"\n ],\n \"documentClass\": {\n \"name\": \"DPE\",\n \"locale\": \"fr-FR\"\n },\n \"documentStatus\": \"AI\",\n \"documentationIdentifiers\": [\n \"aaaa-bbbb-cccc-dddd\"\n ],\n \"folderIdentifiers\": [\n \"aaaa-bbbb-cccc-dddd\"\n ],\n \"name\": \"Bail\",\n \"organizationCode\": \"STONAL\",\n \"propertyKey\": \"PK1\",\n \"rentedUnit\": \"RU1\",\n \"rentedUnitIdentifiers\": [\n \"aaaa-bbbb-cccc-dddd\"\n ],\n \"tags\": [\n \"\"\n ],\n \"tenantIdentifiers\": [\n \"aaaa-bbbb-cccc-dddd\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"classificationStatus\": \"COMPLETED\",\n \"documentClass\": {\n \"documentClassCode\": \"DPE\",\n \"documentClassIdentifier\": \"aaaa-bbbb-cccc-dddd\",\n \"documentClassNames\": [\n {\n \"language\": \"fr\",\n \"name\": \"Dossier de diagnostic de performance énergétique\"\n }\n ]\n },\n \"documentReferences\": [\n {\n \"documentationIdentifier\": \"aaaa-bbbb-cccc-dddd\",\n \"entityIdentifier\": \"aaaa-bbbb-cccc-dddd\",\n \"folder\": {\n \"identifier\": \"aaaa-bbbb-cccc-dddd\",\n \"names\": [\n {\n \"locale\": \"string\",\n \"name\": \"string\"\n }\n ]\n },\n \"referencedEntityType\": \"ASSET\"\n }\n ],\n \"fileResource\": {\n \"contentType\": \"application/pdf\",\n \"identifier\": \"aaaa-bbbb-cccc-dddd\",\n \"importDate\": \"YYYY-MM-DDTHH:MM:SSZ\",\n \"name\": \"My file.pdf\"\n },\n \"hash\": \"e2994d1d2a0c9ef00fc77870216e3b078a8d8befd7023e742b16cc10325b56f7\",\n \"identifier\": \"aaaa-bbbb-cccc-dddd\",\n \"isFiled\": true,\n \"isFiledByAI\": true,\n \"metadata\": {\n \"key_0\": \"string\",\n \"key_1\": \"string\",\n \"key_2\": \"string\"\n },\n \"name\": \"My document.pdf\",\n \"predictedDocumentClass\": {\n \"confidentIndex\": 0.97,\n \"predictedDocumentClassCode\": \"DPE\",\n \"predictedDocumentClassIdentifier\": \"aaaa-bbbb-cccc-dddd\"\n },\n \"predictedFolder\": {\n \"identifier\": \"aaaa-bbbb-cccc-dddd\",\n \"names\": [\n {\n \"language\": \"en\",\n \"name\": \"My folder\"\n }\n ]\n },\n \"rentedUnits\": [\n {\n \"name\": \"John Doe\",\n \"uid\": \"aaaa-bbbb-cccc-dddd\"\n }\n ],\n \"suggestedMetadata\": {\n \"key_0\": \"string\"\n },\n \"tags\": [\n {\n \"color\": \"purple\",\n \"name\": \"tag 2000\"\n }\n ],\n \"tenants\": [\n {\n \"name\": \"John Doe\",\n \"uid\": \"aaaa-bbbb-cccc-dddd\"\n }\n ],\n \"urlAccess\": \"https://platform.stonal.io/organization/STONAL/documents/aaaa-bbbb-cccc-dddd/consult\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "8a9705a5-e63c-4464-8d54-22ce160b0e3e", "name": "This is a soft delete of a document, the document will be marked as deleted but not removed from the storage.", "request": { "name": "This is a soft delete of a document, the document will be marked as deleted but not removed from the storage.", "description": {}, "url": { "path": [ "v5", "organizations", ":organizationCode", "documents", ":documentIdentifier" ], "host": [ "{{legacyBaseUrl}}" ], "query": [ { "disabled": false, "key": "documentationIdentifier", "value": "", "description": "(Required) Documentation id" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" }, { "disabled": false, "type": "any", "value": "", "key": "documentIdentifier", "description": "(Required) Document id" } ] }, "method": "DELETE" }, "response": [ { "id": "bde8f2af-8d29-4eb9-b3ce-7b10db16e7af", "name": "Successfully deleted", "originalRequest": { "url": { "path": [ "v5", "organizations", ":organizationCode", "documents", ":documentIdentifier" ], "host": [ "{{legacyBaseUrl}}" ], "query": [ { "key": "documentationIdentifier", "value": "aaaa-bbbb-cccc-dddd" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" }, { "disabled": false, "type": "any", "value": "", "key": "documentIdentifier", "description": "(Required) Document id" } ] }, "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6cd41eb8-42ac-4cfe-a942-148555ed9b65", "name": "Get a file from a document", "request": { "name": "Get a file from a document", "description": {}, "url": { "path": [ "v5", "organizations", ":organizationCode", "documents", ":documentIdentifier", "files" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" }, { "disabled": false, "type": "any", "value": "", "key": "documentIdentifier", "description": "(Required) Documentation id" } ] }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET" }, "response": [ { "id": "1839723f-6e8d-4de0-8f18-a76d716ba904", "name": "Successfully retrieved", "originalRequest": { "url": { "path": [ "v5", "organizations", ":organizationCode", "documents", ":documentIdentifier", "files" ], "host": [ "{{legacyBaseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" }, { "disabled": false, "type": "any", "value": "", "key": "documentIdentifier", "description": "(Required) Documentation id" } ] }, "header": [ { "key": "Accept", "value": "application/octet-stream" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "19d674c2-79cf-467b-ae7a-4f426179d0af", "name": "Upload documents", "request": { "name": "Upload documents", "description": {}, "url": { "path": [ "v5", "organizations", ":organizationCode", "files" ], "host": [ "{{legacyBaseUrl}}" ], "query": [ { "disabled": false, "key": "assetIdentifier", "value": "", "description": "Asset id to link files to" }, { "disabled": false, "key": "documentationIdentifier", "value": "", "description": "Documentation id to link files to" }, { "disabled": false, "key": "destinationFolder", "value": "", "description": "Folder id to put files in" }, { "disabled": false, "key": "tags", "value": "", "description": "Tags to add" }, { "disabled": false, "key": "tags", "value": "", "description": "Tags to add" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" } ] }, "header": [ { "key": "Content-Type", "value": "multipart/form-data" } ], "method": "POST", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file", "description": "File to upload" }, { "key": "files", "value": "[\"\",\"\"]", "type": "text", "contentType": "multipart/form-data", "description": "Files to upload" } ] } }, "response": [ { "id": "06f6eca6-8520-4983-806b-082e3db5ce26", "name": "Successfully retrieved", "originalRequest": { "url": { "path": [ "v5", "organizations", ":organizationCode", "files" ], "host": [ "{{legacyBaseUrl}}" ], "query": [ { "key": "assetIdentifier", "value": "aaaa-bbbb-cccc-ddd" }, { "key": "documentationIdentifier", "value": "aaaa-bbbb-cccc-ddd" }, { "key": "destinationFolder", "value": "aaaa-bbbb-cccc-ddd" }, { "key": "tags", "value": "PHOTO" }, { "key": "tags", "value": "TEST" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "organizationCode", "description": "(Required) Code of client" } ] }, "method": "POST", "body": { "mode": "formdata", "formdata": [ { "description": { "content": "File to upload", "type": "text/plain" }, "key": "file", "value": "", "type": "text" }, { "description": { "content": "Files to upload", "type": "text/plain" }, "key": "files", "value": "[\"\",\"\"]", "type": "text", "contentType": "multipart/form-data" } ] } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ] } ] }