openapi: 3.1.0 info: title: Finalcad One Project API version: '2.41' summary: 'Project-level operations for Finalcad One construction projects: project details, project libraries, members, locations (folders / plans / IFC), discussion groups, companies, modules (observations / forms / meetings), observations, forms and form answers, documents, phases, meetings and XLSX/PDF exports.' description: 'Project-level operations for Finalcad One construction projects: project details, project libraries, members, locations (folders / plans / IFC), discussion groups, companies, modules (observations / forms / meetings), observations, forms and form answers, documents, phases, meetings and XLSX/PDF exports. DERIVED, NOT PUBLISHED BY THE PROVIDER. Finalcad publishes no OpenAPI. This document was mechanically derived by API Evangelist from the first-party public Postman collection "Finalcad One API" served by Finalcad at https://developer.finalcad.com/ (collection JSON: https://developer.finalcad.com/api/collections/10995648/Tz5v1Es2), saved in this repo at collections/finalcad.postman_collection.json. Every path, method, header, query parameter, example request body and example response below is carried over from that collection; nothing was invented. Request/response bodies are typed as generic objects because the collection carries examples, not schemas. Four Finalcad employees'' personal e-mail addresses that appeared in the collection''s example payloads were replaced with placeholders; nothing else was changed.' contact: name: Finalcad One API — developer portal url: https://developer.finalcad.com/ x-generated-by: API Evangelist enrichment pipeline (derived from the first-party Postman collection) x-source: collections/finalcad.postman_collection.json x-source-url: https://developer.finalcad.com/ servers: - url: https://developer.finalcad.cloud/api description: Production — the baseUrl variable published in the Finalcad One API Postman collection. - url: https://developer.sandbox.finalcad.cloud/api description: Sandbox — published by Finalcad in the 'Retrieve data in Power BI' tutorial of the same collection. security: - apiKey: [] tokenAuth: [] tags: - name: Companies - name: Discussion groups - name: Documents - name: Exports - name: Forms - name: Locations - name: Medias handeling - name: Meetings - name: Modules - name: Observations - name: Phases - name: Project details - name: Project libraries - name: Project members management paths: /medias/{media_id}: get: operationId: mediasHandelingGetMediaResource summary: Get media resource description: "OBSOLETE – Please use the media endpoints at the application level. \n\n Given a media_resource_id , you\ \ can retrieve the associated media content.\n\n ⚠️ Warnings \n\n This endpoint does not support retrieval of 3D media.\n\ \n The media_resource_id refers to the ID returned by an endpoint that links a media to another resource (e.g., the\ \ endpoint used to create a plan). It is not the same as the media_id used in media upload endpoints.\n\n Endpoint\ \ mandatory infos \n Details \n\n media_resource_id \n the id of the media to be downloaded" tags: - Medias handeling parameters: - name: media_id in: path required: true schema: type: string description: Path variable `media_id` as published in the collection. responses: '200': description: Success '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /organizations/{organization_id}/projects: post: operationId: projectDetailsCreateANewProject summary: Create a new project description: "Creating a project from scratch can be as easy as 1, 2, 3.\n\n You need to specify your project name.\ \ To ensure that your project is correctly localized, language and time zone are mandatory.\n\n But you can go further:\n\ \n bodymandatory informations \n Details \n\n name \n Your best wording to describe your project. It will be displayed\ \ everywhere \n\n body optional information \n Details \n\n description \n Text field that should contain less than\ \ 255 characters \n\n workspace_id \n The workspace in which you want to create the project \n\n case_number \n Project\ \ reference aligned with your internal classification \n\n address \n Where your project is located \n\n end_date\ \ \n Your targeted project end date \n\n language \n If not set it will be French. \n\n time_zone \n See Get list\ \ of time zones \n\n module_ids \n An array of modules ids to be added \nsee Get modules suggestions at organization\ \ or workspace level depending of your usage \n\n Langage help: \nCatalan = \"ca\"\nChinese = \"zh-Hans\"\nEnglish\ \ = \"en\"\nFrench = \"fr\"\nGerman = \"de-DE\"\nItalian = \"it\"\nJapanese = \"ja\"\nNetherland = \"nl-NL\"\nPortuguese\ \ = \"pt\"\nSpanish = \"es\"\nThai = \"th\"\nVietnamese = \"vi\"" tags: - Project details parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: name: responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: time_zone: Europe/Paris language: fr project_id: 267ae234-3f8f398a-76d4-4c0b-bd30-d76a3abcaf0e organization_id: 2421734c-f191-4237-acd8-becf216eaae4 name: My project end_date: '0001-01-01T00:00:00Z' member_count: 0 is_archived: false created_at: '2022-11-30T08:49:32.697933Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2022-11-30T08:49:32.697933Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' get: operationId: projectDetailsGetProjectsListFiltered summary: Get projects list filtered description: Before creating or updating a project, you might want to have a clear view of your organization's projects and have their IDs. tags: - Project details parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: projects: - project_id: 4ab2db74-0b8a78ac-184f-4114-9175-0ef6e41d6544 organization_id: 2421734c-f191-4237-acd8-becf216eaae4 name: My project 1 workspace_id: 8eebf534-35d6-4b2e-be4d-06d5428d896e member_count: 2 is_archived: false current_user_in_project: true is_active: true status: InProgress created_at: '2025-01-30T13:33:20.209284Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-05-16T12:40:19.617275Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - project_id: 3dd5a3cf-432d6d05-7448-437b-b29f-f51b1f0f0eb1 organization_id: 2421734c-f191-4237-acd8-becf216eaae4 name: My project 2 workspace_id: 8eebf534-35d6-4b2e-be4d-06d5428d896e member_count: 1 is_archived: false current_user_in_project: true is_active: true status: InProgress created_at: '2025-04-09T08:19:03.243153Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-04-09T08:19:03.243153Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a count: 2 total_count: 2 limit: 50 offset: 0 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{projectId}: put: operationId: projectDetailsUpdateProject summary: Update project description: "Update your project details.\n\n Endpoint mandatory infos \n Details \n\n projectId \n the id of the project\ \ to be modified \n\n Body optional informations \n Details \n\n name \n Your best wording to describe your project.\ \ It will be displayed everywhere \n\n description \n Text field that should contain less than 255 characters \n\n\ \ case_number \n Project reference aligned with your internal classification \n\n address \n Where your project is\ \ located \n\n end_date \n Your targeted project end date \n\n language \n If not set it will be French. \n\n time_zone\ \ \n See Get list of time zones \n\n media_id \n id of the media to use as project photo \n\n status \n status of\ \ the project \nshould be \"Done\" or \"InProgress\"" tags: - Project details parameters: - name: projectId in: path required: true schema: type: string description: Path variable `projectId` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: name: media_id: responses: '200': description: OK content: application/json: schema: type: object examples: Sucess: value: address: addresse à Lyon time_zone: Europe/Paris language: fr project_id: 267ae234-3f8f398a-76d4-4c0b-bd30-d76a3abcaf0e organization_id: 2421734c-f191-4237-acd8-becf216eaae4 name: new project luc 4 description: description du projet end_date: '0001-01-01T00:00:00Z' member_count: 0 is_archived: false media_resource: id: 2d42ccdf-a5ad-49fb-9c34-c78d4335ddf1 file_name: lang2.png mime_type: image/png created_at: '2022-11-30T08:49:32.697933Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2022-11-30T12:50:35.684911Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a Update_status: value: time_zone: Done language: fr project_id: 79855f61-e3b0db37-a094-46d8-ad79-e22c9d55a5b6 organization_id: 2421734c-f191-4237-acd8-becf216eaae4 name: new project luc 6 end_date: '0001-01-01T00:00:00Z' member_count: 0 is_archived: false current_user_in_project: false is_active: true status: Done created_at: '2022-12-14T10:43:46.603688Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-04-18T09:08:19.255826Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{projectId}/folders/{folderId}: put: operationId: locationsUpdateFolder summary: Update folder description: "You can move (change the parent) or rename a folder.\n\n Details \n\n project_Id \n the id of the project\ \ to be modified \n\n body optional infos \n Details \n\n name \n new name of the folder \n\n parent_id \n id of the\ \ new parent of the folder" tags: - Locations parameters: - name: projectId in: path required: true schema: type: string description: Path variable `projectId` as published in the collection. - name: folderId in: path required: true schema: type: string description: Path variable `folderId` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: name: parent_id: responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: b257d7d2-f310-455e-82d9-9f82ce51fcc3 name: driver parent_id: 78c445fe-ec0d-4d2b-bbd5-7c3727f86b34 enabled: true created_at: '2022-11-29T15:12:56.340687Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2022-11-29T15:13:07.0828953Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' delete: operationId: locationsDeleteFolder summary: Delete folder description: "You can delete a folder.\n\n Endpoint mandatory infos \n Details \n\n project_Id \n the id of the project\ \ to be modified \n\n folder_id \n the id of the folder" tags: - Locations parameters: - name: projectId in: path required: true schema: type: string description: Path variable `projectId` as published in the collection. - name: folderId in: path required: true schema: type: string description: Path variable `folderId` as published in the collection. responses: '200': description: Success '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{projectId}/observations/{observationId}: put: operationId: observationsUpdateObservation summary: Update observation description: "You can now also modify observations in a project using just a few parameters.\n\n Details \n\n projectId\ \ \n The ID of the project where the the observation will be created \n\n observationId \n The ID the the observation\ \ \n\n Body mandatory infos \n \n Details \n\n description \n Your best wording to describe the observation \n\n Body\ \ optional infos \n \n Details \n\n trade_id \n The ID of the category used in the observation \n\n common_observation_id\ \ \n The ID of the model used in the new observation \n\n priority_id \n The ID of the priority of the new observation\ \ \n\n status_id \n The ID of the status of the new observation. \n\n assignee_id \n The ID of the user that will\ \ have the new observation assigned \n\n phase_id \n The ID of the phase that is set for the new observation. \n\n\ \ company_id \n The ID of the company that will be assigned to the new observation \n\n plan_id \n The ID of the plan\ \ used for the observation \n\n position_x \n X coordinate of the item regarding the affected 2D plan \n\n position_y\ \ \n Y coordinate of the item regarding the affected 2D plan \n\n due_date \n The due date of the observation, set\ \ as a date format \n\n module_id \n The ID of the module \n\n Please note that\n\n If an optional body field is not\ \ informed, the current value in the observation is preserved\n\n the trade_id sould be consistent with the module\n\ \n The combinations for description , trade_id and common_observation_id sould be consistent with the creation parameters" tags: - Observations parameters: - name: projectId in: path required: true schema: type: string description: Path variable `projectId` as published in the collection. - name: observationId in: path required: true schema: type: string description: Path variable `observationId` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: common_observation_id: '{{common_observation_id}}' trade_id: '{{trade_id}}' responses: '200': description: OK content: application/json: schema: type: object examples: Success_rename: value: id: 86ce1c54-94b8-485a-9d36-f072134cb9fc project_id: 2636691c-683681a0-1e49-499a-add7-0acb1ece9647 description: Reprise status_id: fce5dcbe-4f82-418c-82ac-78ac1c8d1576 priority_id: af91ddff-bf7e-4b14-81e1-0b5cf999cc7d client_created_at: '2023-06-29T08:10:15.009811Z' module_id: d5a2fcee-6a52-45eb-841d-fd6396bf6eef created_at: '2023-06-29T08:10:16.987837Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-06-29T08:14:03.502218Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a Success_rename_and_assign: value: id: 86ce1c54-94b8-485a-9d36-f072134cb9fc project_id: 2636691c-683681a0-1e49-499a-add7-0acb1ece9647 description: Reprise status_id: fce5dcbe-4f82-418c-82ac-78ac1c8d1576 priority_id: af91ddff-bf7e-4b14-81e1-0b5cf999cc7d assignee_id: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a client_created_at: '2023-06-29T08:10:15.009811Z' module_id: d5a2fcee-6a52-45eb-841d-fd6396bf6eef created_at: '2023-06-29T08:10:16.987837Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-06-29T08:17:28.078882Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{projectId}/observations/{observationId}/attach-media: post: operationId: observationsAddImageObservation summary: Add image observation description: "You can now update an observation by adding an image with a media resource.\n\n Details \n\n projectId\ \ \n The ID of the project \n\n observationId \n the ID of the observation \n\n Body mandatory infos \n \n Details\ \ \n\n media_id \n the ID of the media \ncan be obtained using Medias handeling endpoints." tags: - Observations parameters: - name: projectId in: path required: true schema: type: string description: Path variable `projectId` as published in the collection. - name: observationId in: path required: true schema: type: string description: Path variable `observationId` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: media_id: responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 3a308254-a767-45b2-b949-b19496f0d064 position: 8 media_resource: id: 911e55ef-242d-4df7-b79c-ee62fe57d276 file_name: lang2.png mime_type: image/png '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{projectId}/phases: get: operationId: phasesGetPhases summary: Get phases description: "Before updating your phase list, you might want to have an overview of the phases already deployed in\ \ your project. This helps you manage your project based on the current context.\n\n Details \n\n project_Id \n the\ \ id of the project to be checked \n\n Query params optionals \n\n see Commmon behaviors / differential" tags: - Phases parameters: - name: projectId in: path required: true schema: type: string description: Path variable `projectId` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: phases: - id: 3ab68dd8-f288-4ec9-9c81-d6dd59d12b88 order: 512 name: Trux names: - language: fr translation: Trux enabled: false created_at: '2024-05-23T14:07:36.651606Z' updated_at: '2024-05-23T14:08:03.42011Z' deleted_at: '2024-05-23T14:08:03.42011Z' - id: 0e8c2f2c-9d3c-4871-974b-d445f05e9090 order: 1024 name: Design names: - language: en translation: Design - language: ca translation: Disseny - language: zh translation: 设计 - language: fr translation: Conception - language: de translation: Entwurf - language: it translation: Design - language: ja translation: 設計 - language: nl translation: Design - language: pt translation: Design - language: es translation: Diseñar - language: th translation: การออกแบบ - language: vi translation: Thiết kế enabled: true created_at: '2024-05-22T09:26:30.290109Z' updated_at: '2024-05-22T09:26:30.290109Z' need_to_relaunch: true continuous_token: 0|2 count: 2 total_count: 10 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}: get: operationId: projectDetailsCheckProjectSettings summary: Check project settings description: "Users with the correct level of rights can edit project parameters.\n\n You may want to check if and which\ \ updates have been made." tags: - Project details parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: time_zone: Europe/Paris language: fr project_id: f5b14d0b-7b8e4145-bed5-429a-b863-ab6dd1e23056 organization_id: 2421734c-f191-4237-acd8-becf216eaae4 name: Test Luc LibrariesState end_date: '0001-01-01T00:00:00Z' member_count: 0 is_archived: false current_user_in_project: false is_active: true created_at: '2023-01-25T13:08:44.790214Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-01-25T13:08:44.790214Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' delete: operationId: projectDetailsDeleteAProject summary: Delete a project description: "You can delete a project.\n\n Endpoint mandatory info \n Details \n\n project_id \n The ID of the project\ \ you want to delete" tags: - Project details parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '204': description: No Content '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/categories: get: operationId: modulesFormsGetFormCategories summary: Get form categories description: "For a given project, get the list of all existing categories\nYou can filter by mmodule and parent category\n\ \n Endpoint mandatory info \n Details \n\n project_id \n The ID of the project \n\n Endpoint Query params \n Details\ \ \n\n module_id \n id of the filtered module id \n\n category_id \n id of the filtered category id \n\n with_disabled\ \ \n if true return the disabled categories" tags: - Modules parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: categories: - id: f81b8786-935c-4413-af30-faf159c13f2b module_id: 15606d9b-c9f5-4726-bc0a-8590a3dc9dc6 container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: cat 2 created_at: '2024-02-15T15:01:20.135137Z' updated_at: '2024-02-15T15:01:20.135137Z' enabled: true - id: 073623e5-9454-426a-a319-f59997f6f18b module_id: 4d9fbb6f-5060-45ae-9b27-cc806c4b1487 container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: Categorie ddd Upd created_at: '2024-03-07T14:04:05.198146Z' updated_at: '2024-03-07T14:09:14.38104Z' deleted_at: '2024-03-07T14:09:49.97779Z' enabled: false - id: 0d8ae3bc-164a-4c36-aa6f-9c8866d59670 module_id: 117f1c84-e69d-4429-baf9-74e052f5e0bc container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: cat 5 created_at: '2024-03-20T13:20:32.541312Z' updated_at: '2024-03-20T13:20:32.541312Z' deleted_at: '2024-03-20T13:22:46.318596Z' enabled: false - id: 99bb4d5a-51e3-4a65-b5c0-dec520a7a6b9 module_id: f5d33e97-6f40-478f-87bf-1fa04a0843ff container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: Aze 2.1 created_at: '2024-03-19T08:54:24.676016Z' updated_at: '2024-03-19T08:54:24.676016Z' enabled: true - id: 9b1d0730-c65d-4359-804a-e4d5c416bdba module_id: 15606d9b-c9f5-4726-bc0a-8590a3dc9dc6 container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: cat 2 created_at: '2024-02-15T14:57:50.426575Z' updated_at: '2024-02-15T14:57:50.426575Z' deleted_at: '2024-02-15T15:01:02.257525Z' enabled: false - id: e2f6bc4e-f218-4f7b-98cc-966c81543102 module_id: 15606d9b-c9f5-4726-bc0a-8590a3dc9dc6 container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: cat 2 created_at: '2024-02-15T14:57:23.657101Z' updated_at: '2024-02-15T14:57:23.657101Z' deleted_at: '2024-02-15T15:00:58.557746Z' enabled: false - id: e608affc-a83b-4078-afef-9ae6fcdb3f26 module_id: 15606d9b-c9f5-4726-bc0a-8590a3dc9dc6 container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: cat 2 created_at: '2024-02-15T14:59:26.970143Z' updated_at: '2024-02-15T14:59:26.970143Z' deleted_at: '2024-02-15T15:01:05.681467Z' enabled: false - id: efb034ba-24ca-42f2-a7c3-36f666612d99 module_id: 4d9fbb6f-5060-45ae-9b27-cc806c4b1487 container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: Categorie ccc created_at: '2024-03-07T13:57:32.799642Z' updated_at: '2024-03-07T13:57:32.799642Z' enabled: true - id: 04bf1a6d-ce26-484f-93f5-d489eb71452b module_id: 8cf9151c-0a0b-4675-befe-64d868b466ec container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: cat 3----2 created_at: '2024-04-11T14:06:09.94564Z' updated_at: '2024-04-11T14:06:09.94564Z' enabled: true - id: 1cbe1164-ebcd-468a-b05d-69a8f4874e4c module_id: 4d9fbb6f-5060-45ae-9b27-cc806c4b1487 container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: Categorie bbb created_at: '2024-03-06T13:52:16.094446Z' updated_at: '2024-03-06T13:52:16.094446Z' enabled: true - id: 37eca3a3-aeaa-4730-9c69-afeb0e49a933 module_id: 15606d9b-c9f5-4726-bc0a-8590a3dc9dc6 container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: Aze created_at: '2024-03-19T08:53:17.710324Z' updated_at: '2024-03-19T08:53:17.710324Z' enabled: true - id: 505d5a67-4acc-4a22-98ed-3f715fb0c8ef module_id: 4d9fbb6f-5060-45ae-9b27-cc806c4b1487 container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: Categorie aaa created_at: '2024-03-06T13:40:37.291318Z' updated_at: '2024-03-06T13:40:37.291318Z' enabled: true - id: 558a982d-6d3a-4290-9147-07151a2ffe0f module_id: 15606d9b-c9f5-4726-bc0a-8590a3dc9dc6 container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: cat 3 created_at: '2024-02-15T15:03:13.215222Z' updated_at: '2024-02-15T15:03:13.215222Z' deleted_at: '2024-02-15T16:07:08.654746Z' enabled: false - id: 56894d4e-b9fc-471a-8e0b-d12f9f6c6d91 module_id: 15606d9b-c9f5-4726-bc0a-8590a3dc9dc6 container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: cat 2 created_at: '2024-02-15T14:53:16.51161Z' updated_at: '2024-02-15T14:53:16.51161Z' deleted_at: '2024-02-15T15:00:51.073472Z' enabled: false - id: 593647a7-8647-49ba-9552-739125b12486 module_id: 117f1c84-e69d-4429-baf9-74e052f5e0bc container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: Categ Form 2 created_at: '2024-02-13T08:26:23.104113Z' updated_at: '2024-02-13T08:26:23.104113Z' enabled: true - id: 594f4f7c-6f7a-410b-bb5e-5aa6ef488a9c module_id: 117f1c84-e69d-4429-baf9-74e052f5e0bc container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: Categ Form 1 created_at: '2024-02-13T08:26:23.104109Z' updated_at: '2024-02-13T08:26:23.104109Z' enabled: true - id: 7d385066-8686-4357-940d-90524f03be97 module_id: 8cf9151c-0a0b-4675-befe-64d868b466ec container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: cat 3----1 created_at: '2024-04-11T14:05:13.058237Z' updated_at: '2024-04-11T14:05:13.058237Z' enabled: true - id: 7d911da8-82c1-44b1-8224-9382efd1d0a2 module_id: 15606d9b-c9f5-4726-bc0a-8590a3dc9dc6 container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: cat 2 created_at: '2024-02-15T14:54:10.90263Z' updated_at: '2024-02-15T14:54:10.90263Z' deleted_at: '2024-02-15T15:00:55.516965Z' enabled: false - id: 89bea999-7e06-42b0-900b-8d3a2fd0b362 module_id: a41a8c18-b754-4b65-be6c-22c63987c995 container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: test cad pour data created_at: '2024-03-08T08:42:03.963357Z' updated_at: '2024-03-08T08:42:03.963357Z' enabled: true - id: 906dbfc8-a212-44f4-9ac6-6988ff403b04 module_id: 15606d9b-c9f5-4726-bc0a-8590a3dc9dc6 container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: cat 1 created_at: '2024-02-15T14:46:42.755881Z' updated_at: '2024-02-15T14:46:42.755881Z' deleted_at: '2024-02-15T16:13:19.796615Z' enabled: false - id: 1c1318ff-07c2-4489-94d5-d32b4a1b4eff module_id: 117f1c84-e69d-4429-baf9-74e052f5e0bc container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: Categ Form 1.1 parent_id: 594f4f7c-6f7a-410b-bb5e-5aa6ef488a9c created_at: '2024-02-13T08:26:42.34105Z' updated_at: '2024-02-13T08:26:42.34105Z' enabled: true - id: e7b13254-7bcf-4558-a221-3e15be270c3f module_id: 117f1c84-e69d-4429-baf9-74e052f5e0bc container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: Categ form 2.1 parent_id: 593647a7-8647-49ba-9552-739125b12486 created_at: '2024-02-13T10:28:43.804613Z' updated_at: '2024-02-13T10:28:43.804613Z' enabled: true - id: 2a9558c9-de86-4d6d-8b82-93f9896870d9 module_id: 8cf9151c-0a0b-4675-befe-64d868b466ec container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: cat 3--====----3 parent_id: 04bf1a6d-ce26-484f-93f5-d489eb71452b created_at: '2024-04-11T14:06:21.979847Z' updated_at: '2024-04-11T14:07:29.863009Z' deleted_at: '2024-04-11T14:07:39.931755Z' enabled: false - id: 9c150a71-be7c-4f0b-8669-507dcfbfa674 module_id: 15606d9b-c9f5-4726-bc0a-8590a3dc9dc6 container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: Aze 2.1 parent_id: 37eca3a3-aeaa-4730-9c69-afeb0e49a933 created_at: '2024-03-19T08:53:37.741416Z' updated_at: '2024-03-19T08:53:37.741416Z' enabled: true - id: a8bc3515-7e92-4050-be84-64812e982f01 module_id: f5d33e97-6f40-478f-87bf-1fa04a0843ff container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: Aze 2.1 parent_id: 99bb4d5a-51e3-4a65-b5c0-dec520a7a6b9 created_at: '2024-03-19T08:54:34.200015Z' updated_at: '2024-03-19T08:54:34.200015Z' enabled: true - id: aeeb9af2-3a47-4c0e-9587-dc8dfd5425e6 module_id: 15606d9b-c9f5-4726-bc0a-8590a3dc9dc6 container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: cat 3-1 parent_id: 558a982d-6d3a-4290-9147-07151a2ffe0f created_at: '2024-02-15T15:03:34.764932Z' updated_at: '2024-02-15T15:32:15.510674Z' deleted_at: '2024-02-15T16:04:47.282131Z' enabled: false count: 26 Success_with_filter: value: categories: - id: 1c1318ff-07c2-4489-94d5-d32b4a1b4eff module_id: 117f1c84-e69d-4429-baf9-74e052f5e0bc container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: Categ Form 1.1 parent_id: 594f4f7c-6f7a-410b-bb5e-5aa6ef488a9c created_at: '2024-02-13T08:26:42.34105Z' updated_at: '2024-02-13T08:26:42.34105Z' enabled: true count: 1 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/change-members-role: post: operationId: projectMembersManagementChangeRole summary: Change role description: "You can change the role of project users.\n\n Endpoint mandatory infos \n Details \n\n projectId \n the\ \ id of the project to be modified \n\n body mandatory infos \n Details \n\n role_id \n id if the role to be affected\ \ \n\n user_ids \n list of user ids be be momdified" tags: - Project members management parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: role_id: 041391c6-cb0a-4157-bb5e-fc3469ea9c69 user_ids: - a2159af5-4144345e-8c2e-4eb5-89b4-5b43a955d10c responses: '204': description: No Content '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/commonobservations: get: operationId: projectLibrariesGetProjectCommonObservations summary: Get project common observations description: "For a given project, you can list the models (= common observations) available by module ID.\n\n Details\ \ \n\n project_id \n the id of the project to be modified \n\n Query params optionals \n\n see Commmon behaviors /\ \ differential" tags: - Project libraries parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: common_observations: - id: 2958187d-93ab-49e6-85d1-f1798b655a74 trade_id: b317de66-d677-47f8-8462-ab9887ce72a4 names: - language: fr translation: 2ieme couche à réaliser enabled: true created_at: '2024-05-22T09:26:38.624859Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-22T09:26:38.624859Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 8872b022-ded6-4842-a45b-508739f4a8fb trade_id: d22c0e43-fb91-4222-8468-38a071523fa8 names: - language: en translation: Acier à reprendre enabled: true created_at: '2024-05-22T09:26:38.789267Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-22T09:26:38.789267Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a need_to_relaunch: true continuous_token: 0|2 count: 2 total_count: 41 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' post: operationId: modulesObservationsCreateCommonObservation summary: Create common observation description: "Create a model for a given category within a module.\n\n Details \n\n project_Id \n the id of the project\ \ to be modified \n\n body mandatory infos \n Details \n\n trade_id \n id of the trade who contain this common observations\ \ \n\n names \n list of langages and translations" tags: - Modules parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: trade_id: '{{trade_id}}' names: - language: en translation: - language: fr translation: responses: '200': description: OK content: application/json: schema: type: object examples: Create_common_observation: value: id: a2c57b4e-ce31-466e-a52b-d946cb952de1 enabled: true names: - language: en translation: essaiobs - language: fr translation: essaiobs trade_id: 274e9196-fd0f-4d26-a54c-ec71565c556d '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/commonobservations/{commonObs_id}: get: operationId: modulesObservationsGetProjectCommonObservation summary: Get project common observation description: "Get the details of a common observation (model).\n\n Details \n\n project_id \n the id of the project\ \ to be modified \n\n commonObs_id \n id of the common observation to be verified" tags: - Modules parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: commonObs_id in: path required: true schema: type: string description: Path variable `commonObs_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: c25be206-944d-4162-a3bf-ea0768cd5ac5 trade_id: 907b66bb-cf34-4813-9ac8-3eb7d18a9714 names: - language: fr translation: 2ieme couche à réaliser enabled: true created_at: '2023-10-10T09:50:43.458085Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-10-10T09:50:43.458085Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/companies: get: operationId: companiesGetProjectCompaniesList summary: Get project companies list description: "Before updating your company list, you might want to have an overview of the ones deployed in your project.\ \ This helps you manage your project based on the current context.\n\n Details \n\n project_Id \n the id of the project\ \ to be checked \n\n Query params optionals \n\n see Commmon behaviors / differential" tags: - Companies parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: companies: - id: 3d40ff78-e900-423c-a842-10cc2a4d5f18 name: entrep 2 enabled: true created_at: '2024-05-22T09:48:31.393607Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-22T09:48:31.393607Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 592f260a-0197-459e-a724-3bbf7b7ca051 name: entrep 1 enabled: true created_at: '2024-05-22T09:48:24.403954Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-22T09:48:24.403954Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a need_to_relaunch: true continuous_token: CT:Unknown-0-2 count: 2 total_count: 5 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' put: operationId: companiesUpdateProjectCompanyName summary: Update project company name description: "Update your list of companies. Only the selected companies will change.\n\n Endpoint mandatory infos \n\ \ Details \n\n project_Id \n the id of the project to be modified \n\n body mandatory infos \n Details \n\n id \n\ \ id of the company to be modified \n\n name \n new name of the company \n\n body optionalinfos \n Details \n\n reference\ \ \n company reference in your referential system" tags: - Companies parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: companies: - id: name: responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: companies: - id: 2cf2d0f2-3084-4b43-b78d-8992bd922f79 name: Company 1 - New Name - id: 72e65911-4baf-4109-b1a8-aebae2f97c00 name: Company 2 - New Name '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' delete: operationId: companiesDeleteProjectCompanies summary: Delete project companies description: "You can provide the list of company IDs you want to remove from your project. The existing assignments\ \ will be tagged as deleted entities.\n\n Details \n\n project_Id \n the id of the project to be modified \n\n body\ \ mandatory infos \n Details \n\n company_ids \n list of companies ids to be deleted" tags: - Companies parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: company_ids: - responses: '204': description: No Content '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' post: operationId: companiesCreateProjectCompanies summary: Create project companies description: "Creating a new company for a project only means giving it a name. Additionally, you can do it as a list\ \ of companies.\n\n Details \n\n project_Id \n the id of the project to be modified \n\n body mandatory infos \n Details\ \ \n\n companies \n list of names and references of the new companies \n \nthe reference is the company reference\ \ in your referential system and is optional" tags: - Companies parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: companies: - name: - name: responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: companies: - id: 25c48f04-16fe-48eb-8870-be8d2c7b8cd5 name: Company A - id: 007ab530-0b7d-4168-bac3-1a13d1c2dabe name: Company B '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/companies/{company_id}: get: operationId: companiesGetCompanyInfo summary: Get company info description: "Given the project company ID, you can check its name.\n\n Details \n\n project_Id \n the id of the project\ \ to be modified \n\n company_id \n id of the company to be checked" tags: - Companies parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: company_id in: path required: true schema: type: string description: Path variable `company_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: af4f4f2a-2688-4caa-bc8d-d3d07b4e682e name: company1 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/companies/{company_id}/add-members: post: operationId: companiesAddMembers summary: Add members description: "Given the project company ID, you can add members (members should exist in the project).\n\n Details \n\ \n project_Id \n the id of the project to be modified \n\n company_id \n id of the company to be checked \n\n Body\ \ mandatory infos \n Details \n\n list of users ids" tags: - Companies parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: company_id in: path required: true schema: type: string description: Path variable `company_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: user_ids: - 23c0968f-4b9d3ab1-368d-47dc-bc6e-4afbe6c144cc responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 72e65911-4baf-4109-b1a8-aebae2f97c00 name: Company 2 enabled: true user_ids: - 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - 23c0968f-4b9d3ab1-368d-47dc-bc6e-4afbe6c144cc created_at: '2024-01-25T14:01:53.394256Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-01-26T13:45:27.3128544Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/companies/{company_id}/remove-members: post: operationId: companiesRemoveMembers summary: Remove members description: "Given the project company ID, you can remove members.\n\n Details \n\n project_Id \n the id of the project\ \ to be modified \n\n company_id \n id of the company to be checked \n\n Body mandatory infos \n Details \n\n list\ \ of users ids" tags: - Companies parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: company_id in: path required: true schema: type: string description: Path variable `company_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: user_ids: - 23c0968f-4b9d3ab1-368d-47dc-bc6e-4afbe6c144cc responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 72e65911-4baf-4109-b1a8-aebae2f97c00 name: Company 2 enabled: true user_ids: - 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a created_at: '2024-01-25T14:01:53.394256Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-01-26T13:45:11.4211361Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/documents: post: operationId: documentsCreateDocumentOrFolders summary: Create document or folders description: "Folders allow for document organization, as well as preview and context. Each folder comes with a name.\n\ \n You can specify where to add the folder in your hierarchy by designating its parent (another folder or the root).\n\ \n All kinds of documents can be added within this document module.\n\n Endpoint mandatory infos \n Details \n\n project_Id\ \ \n the id of the project to be modified \n\n body mandatory infos \n Details \n\n name \n name of the folder or\ \ document \n\n media_id \n id of the document media \nsould be present only for document generation \n(a folder has\ \ no media) \n\n body optional infos \n Details \n\n parent_id \n the id of the parent folder in the hierarchy" tags: - Documents parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object responses: '200': description: OK content: application/json: schema: type: object examples: Success_folder: value: id: ce962734-9fd7-4bec-ab2c-1455e48425a5 type: Folder name: docFold enabled: true created_at: '2022-11-29T15:35:29.5113161Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2022-11-29T15:35:29.5113192Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a Success_document: value: id: 8ce4b833-d6c5-448c-a754-322b35f9d468 type: Document name: mydoc parent_id: ce962734-9fd7-4bec-ab2c-1455e48425a5 media_resource: id: 372f17d7-2e27-4efc-bb9b-c7322300c7eb mime_type: image/png enabled: true created_at: '2022-11-29T15:38:02.7754111Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2022-11-29T15:38:02.7754205Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' get: operationId: documentsGetDocumentsAndFolders summary: Get documents and folders description: "Before creating folders or documents, you might want to have an overview of those already deployed in\ \ your project. This helps you manage them based on the current context.\n\n Endpoint mandatory infos \n Details \n\ \n project_Id \n the id of the project to be modified \n\n Query params optionals \n\n see Commmon behaviors / differential" tags: - Documents parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: documents: - id: 1b8f0877-fedb-4f50-867b-2256c23321f1 type: Folder name: QSD enabled: true created_at: '2024-05-28T12:59:42.238Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-28T12:59:42.238Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: f8de6f6c-87a4-47a7-8bba-efe542f04af8 type: Document name: LogoClient.png media_resource: id: ad702b87-bc2b-4073-b868-6c5d24b802c3 mime_type: image/png created_at: '2024-05-28T12:59:54.067Z' enabled: true file_type: Image created_at: '2024-05-28T12:59:54.067Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-28T12:59:54.067Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a need_to_relaunch: true continuous_token: 638524979940680000|e30= count: 2 total_count: 7 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/documents/filter: get: operationId: documentsGetDocumentsAndFoldersByParent summary: Get documents and folders by parent description: "Before creating folders or documents, you might want to have an overview of those already deployed in\ \ your project. This helps you manage them based on the current context.\n\n Endpoint mandatory infos \n Details \n\ \n project_Id \n the id of the project to be modified \n\n Query params optionals \n\n see Commmon behaviors / differential" tags: - Documents parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: documents: - id: c0fad6b3-2501-4bc5-b0ce-1c7e0587447a type: Document name: Arrow right.png parent_id: cbf271ae-357a-4af4-b955-75bea02155ac media_resource: file_name: Arrow right.png mime_type: image/png created_at: '2025-04-22T08:51:23.135Z' enabled: true file_type: Image created_at: '2025-04-22T08:51:23.135Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-04-22T08:51:23.135Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: a58960f5-a792-40a0-ad08-278ceb2eb2f8 type: Document name: Building.png parent_id: cbf271ae-357a-4af4-b955-75bea02155ac media_resource: file_name: Building.png mime_type: image/png created_at: '2025-04-22T08:51:23.69Z' enabled: true file_type: Image created_at: '2025-04-22T08:51:23.69Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-04-22T08:51:23.69Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: f633b9b9-2b46-4aed-ab53-cff6e9b9973e type: Document name: Logo-Color.png parent_id: cbf271ae-357a-4af4-b955-75bea02155ac media_resource: file_name: Logo-Color.png mime_type: image/png created_at: '2025-04-22T08:51:24.04Z' enabled: true file_type: Image created_at: '2025-04-22T08:51:24.04Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-04-22T08:51:24.04Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a count: 3 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/documents/{document_id}: get: operationId: documentsGetDocumentOrFolder summary: Get document or folder description: "Before creating folders or documents, you might want to have an overview of those already deployed in\ \ your project. This helps you manage them based on the current context.\n\n You can retrieve both folders and documents.\n\ \n Endpoint mandatory infos \n Details \n\n project_Id \n the id of the project to be modified \n\n document_id \n\ \ id the the document or folde to be checked" tags: - Documents parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: document_id in: path required: true schema: type: string description: Path variable `document_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Get_folder: value: id: c36dd915-498e-4d9d-9758-e95719083cdd type: Folder name: Handmade enabled: true Get_document: value: id: 80579b1e-8581-49df-90a8-132eaad7b9cf type: Document name: for parent_id: c36dd915-498e-4d9d-9758-e95719083cdd media_resource: id: 84600611-01f6-49dd-a521-e7a7eaab6d24 enabled: true '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' put: operationId: documentsUpdateDocumentOrFolder summary: Update document or folder description: "You can move and edit folder names. You can also move, edit document names, and update documents.\n\n\ \ Endpoint mandatory infos \n Details \n\n project_Id \n the id of the project to be modified \n\n document_id \n\ \ id of the document or folder to be modified \n\n body optional infos \n Details \n\n name \n new name of the document\ \ or folder \n\n parent_id \n the id of the new parent folder in the hierarchy \n\n media_id \n id of new media (for\ \ document change only)" tags: - Documents parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: document_id in: path required: true schema: type: string description: Path variable `document_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: name: media_id: parent_id: responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 8ce4b833-d6c5-448c-a754-322b35f9d468 type: Document name: renamed2 parent_id: ce962734-9fd7-4bec-ab2c-1455e48425a5 media_resource: id: 01d907a3-0324-4026-800b-f823e8247577 mime_type: image/png enabled: true created_at: '2022-11-29T15:38:02.775Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2022-11-30T15:45:00.7855601Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' delete: operationId: documentsDeleteDocumentOrFolder summary: Delete document or folder description: "You can delete a document or a folder of documents.\n\n Details \n\n project_Id \n the id of the project\ \ to be modified \n\n document_id \n id of the document or folder to be deleted" tags: - Documents parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: document_id in: path required: true schema: type: string description: Path variable `document_id` as published in the collection. responses: '204': description: No Content '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/folders: get: operationId: locationsGetFolderTree summary: Get folder tree description: "Before creating folders, you might want to have an overview of the ones deployed in your project. This\ \ helps you manage it based on the current context.\n\n Endpoint mandatory infos \n Details \n\n project_id \n the\ \ id of the project to be modified \n\n Query params optionals \n\n see Commmon behaviors / differential" tags: - Locations parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: folders: - id: 89cae481-e28c-452f-9253-d293658d2720 name: aaaaaaaa enabled: true created_at: '2024-05-22T11:57:03.421945Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-22T11:57:03.421945Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 42c828e2-b063-4292-9e06-7520c6be853e name: bbbbbbbb enabled: true created_at: '2024-05-22T11:57:11.689485Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-22T11:57:11.689485Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a need_to_relaunch: true continuous_token: 0|2 count: 2 total_count: 3 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' post: operationId: locationsCreateFolder summary: Create folder description: "Folders allow plans organization but also preview and context. A folder comes with a name.\n\n You can\ \ specify where to add the folder in your hierarchy by specifying its parent (another folder or the root).\n\n Details\ \ \n\n project_Id \n the id of the project to be modified \n\n body mandatory infos \n Details \n\n name \n name of\ \ the folder \n\n body optional infos \n Details \n\n parent_id \n the id of the parent folder in the hierarchy" tags: - Locations parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: name: responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 08780149-b53e-47e0-9dde-0a1f1eb7cb4f name: Plans GO enabled: true created_at: '2023-06-29T08:53:47.1898491Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-06-29T08:53:47.1898491Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a Success_with_parent: value: id: 10ead329-3eaf-4669-b2ed-4a2e7ad085b9 name: RDC parent_id: 08780149-b53e-47e0-9dde-0a1f1eb7cb4f enabled: true created_at: '2023-06-29T08:54:31.6168973Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-06-29T08:54:31.6168973Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/folders/children-folders: get: operationId: locationsGetFolderContent summary: Get folder content description: "You can get the content (plans and/or folders) for a folder\n\n Endpoint mandatory infos \n Details \n\ \n project_id \n the id of the project to be modified \n\n Endpoint optional query infos \n Details \n\n folder_id\ \ \n id of the parent folder \n\n type \n folder or plan or null" tags: - Locations parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: contents: - id: 77a6ef89-d541-4e07-8efb-694045f6f698 type: folder name: machine order: 3072 created_at: '2025-02-13T16:14:02.404779Z' updated_at: '2025-02-13T16:14:11.503789Z' enabled: true - id: 8f77778d-dce7-4659-8ba4-5a50d3dd7827 type: plan name: image (1).png order: 4096 created_at: '2025-04-22T09:56:43.546463Z' updated_at: '2025-04-22T09:56:43.546463Z' enabled: true - id: f8a9269f-3214-4cc2-8a2f-668d2ead7709 type: plan name: image (2).png order: 4096 created_at: '2025-04-22T09:56:43.546366Z' updated_at: '2025-04-22T09:56:43.546366Z' enabled: true count: 3 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/form-answers: post: operationId: formsCreateAnswer summary: Create answer description: "Based on a form ID, you can fill the different fields of the form. Here is the list of field types you\ \ can fill from the API:\n\n Short answer\n\n Paragraph\n\n Single choice\n\n Multiple choice\n\n Control\n\n Phone\n\ \n Email\n\n Disclaimer\n\n Grid\n\n Signature\n\n Linked files\n\n To do so, you have to get the field ID and type\ \ by using the \"Get form answer\" endpoint. Include the following info in the endpoint.\n\n Endpoint mandatory info\ \ \n Details \n\n project_id \n The ID of the project where the form has been created \n\n Body mandatory info \n\ \ Details \n\n form_instance_id \n The ID of the form instance \n\n field_id \n The ID of the field you want to update\ \ \n\n Depending on type_field_presentation and type_field_data for each field you have to fill in the endpoint the\ \ following information\n\n Type \n type_field_data \n type_field_presentation \n Other field data \n Value to fill\ \ in the endpoint \n\n Text \n Text \n ShortAnswer \n \n value_string \n\n Paragraph \n Text \n Paragraph \n \n value_string\ \ \n\n Phone number \n Text \n PhoneNumber \n \n value_string \n\n Email \n Text \n Email \n \n value_string \n\n\ \ Number \n Number \n ShortAnswer \n \n value_numeric \n\n Date \n Calendar \n ShortAnswer \n form_field_sa_calendar.format_calendar\ \ \n=DateOnly \n value_date1 \n\n Time \n Calendar \n ShortAnswer \n form_field_sa_calendar.format_calendar \n=TimeOnly\ \ \n value_time1 \n\n Date&Time \n Calendar \n ShortAnswer \n form_field_sa_calendar.format_calendar \n=DateAndTime\ \ \n value_date1 and value_time1 \n\n RadioButton \n Text \n SingleChoice \n \n array_field_choices \n\n Checkboxes\ \ \n Text \n MultipleChoice \n \n array_field_choices \n\n OkKo (control) \nOkKoNeutral \n Text \n Control \n \n array_field_choices\ \ \n\n OkKo+NA \n Text \n Control \n form_field_sa_control.na_values_allowed=true \n na_value/ array_field_choices\ \ \n\n Grid \n Resources \n \n FormLink \n\n Disclaimer \n Text \n Disclaimer \n \n value_boolean \n\n Linked file\ \ \n Resources \n Attachments \n \n see below \n\n Signature \n Resources \n Signature \n \n see below \n\n Theses\ \ fields can not be set \n\n formula \n Text \n Formula \n\n For attaching files to a linked files field \nfirst,\ \ create a text answer for the field\nnext,use the 'link file to answer' to attach a media\nrepeat theses 2 steps\ \ for attaching another file\n\n For attaching files to to a signature field \nfirst, create a text answer for the\ \ field\nnext,use the 'link file to answer' to attach an image media\n\n For attaching items to a control field \n\ first, create an answer for the field\nnext,use the 'link item to answer' to attach an item\nrepeat the second step\ \ for attaching another item\n\n For grid row creation ,\nthe body should include 2 others keys :\ncreate_form_template_instance\ \ with value=true\ncreate_form_template_instance_for_grid with value=true\n\n For grid field creation \nthe body should\ \ include 2 others keys\ncreate_form_template_instance with value=true\nform_template_instance_id with value returned\ \ in value_form_template_instance_id by the grid creation\n\n It is not recommended to create a grid row without filling\ \ its fields\n\n For paragraph's you can add formated text html syntax with the following tag's" tags: - Forms parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: field_id: 001a6c1b-dfa7-4429-b4ef-570ccc684598 form_instance_id: create_form_template_instance: true value_string: Exemple de texte responses: '200': description: OK content: application/json: schema: type: object examples: Success_Text: value: id: 0e0ff199-6c3f-4051-84ec-710a5507d510 field_id: 4f665120-f630-41b3-b2ea-d36db0a77736 form_template_instance_id: d1f71cb7-0658-41e0-9da8-d7a8304f3a49 order: 0 value_string: text line na_value: false is_valid_content: true client_created_at: '2023-03-09T09:33:39.3992492Z' client_updated_at: '2023-03-09T09:33:39.3992492Z' Success_Date: value: id: 6698c260-7c7d-418e-995d-3bf5b25d8b5e field_id: 314e2745-b5f2-46cb-95a2-fdcb9c880265 form_template_instance_id: d1f71cb7-0658-41e0-9da8-d7a8304f3a49 order: 0 value_date1: '2023-02-20T00:00:00Z' na_value: false is_valid_content: true client_created_at: '2023-03-09T09:36:16.8152788Z' client_updated_at: '2023-03-09T09:36:16.8152788Z' Success_Choice: value: id: 2765e3f7-c46a-465b-9657-a1e0afef4137 field_id: b6756d2f-d9b9-4061-acbd-eddba04ea9f9 form_template_instance_id: d1f71cb7-0658-41e0-9da8-d7a8304f3a49 order: 0 array_field_choices: - c9cd70be-2fe3-4a4a-8e22-fefc43ca528e na_value: false is_valid_content: true client_created_at: '2023-03-09T09:38:09.437417Z' client_updated_at: '2023-03-09T09:38:09.437417Z' Create_Grid_Row: value: id: b85fb353-c880-491c-ab7d-db94b5111aea field_id: 6c253a05-87d6-40ce-94f4-c5bb86e1b52a form_template_instance_id: 8e6e4f9c-41d9-4bc7-916d-5bb09c16896d order: 0 value_form_template_instance_id: da946843-440c-4f8a-b299-8d73d10b9a76 na_value: false is_valid_content: true client_created_at: '2024-11-19T13:48:10.4054638Z' client_updated_at: '2024-11-19T13:48:10.4054638Z' Fill_Grid_Element: value: id: 8b732b87-103d-4799-863d-d716e607ef7f field_id: 57001aa5-d5ab-4681-be7c-b1cd153405e3 form_template_instance_id: da946843-440c-4f8a-b299-8d73d10b9a76 order: 0 value_string: xxxx na_value: false is_valid_content: true client_created_at: '2024-11-19T13:50:09.1496227Z' client_updated_at: '2024-11-19T13:50:09.1496227Z' '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/form-answers/link: post: operationId: formsLinkItemToAnswer summary: Link item to answer description: "You can link an observation or a form to a form answer of a control field.\n\n Details \n\n project_id\ \ \n The ID of the project where the form reside \n\n Body mandatory info \n Details \n\n form_instance_id \n The\ \ ID of the form instance \n\n form_answer_id \n The ID of the answer you want to link \n\n target_id \n id of the\ \ linked item \n\n target_type \n sould be \"Observation\" or \"Form\" depending of the type of the linked item" tags: - Forms parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: form_instance_id: form_answer_id: target_id: target_type: Observation responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: message_id: '523152392112308224' '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/form-answers/{answer_id}: put: operationId: formsUpdateAnswer summary: Update answer description: "Based on a form ID, you can update the different fields of the form. Here is the list of field types you\ \ can fill from the API:\n\n Short answer\n\n Paragraph\n\n Single choice\n\n Multiple choice\n\n Control\n\n Phone\n\ \n Email\n\n Grid\n\n Disclaimer\n\n To do so, you have to get the field ID and type by using the \"Get form answer\"\ \ endpoint. Include the following info in the endpoint.\n\n Endpoint mandatory info \n Details \n\n project_id \n\ \ The ID of the project where the form has been created \n\n form_answer_id \n The ID of the form anwser \n\n Depending\ \ on type_field_presentation and type_field_data for each field you have to fill in the endpoint the following information\n\ but the value_form_template_instance_id is mandatory\n\n Check the table on Post create form answer.\n\n if no value\ \ is sent in the endpoint, the existing value will remain the same\n\n for linked files type,\nyou can remove an attached\ \ file by deleting the answer" tags: - Forms parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: answer_id in: path required: true schema: type: string description: Path variable `answer_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 179b7fcb-b15b-4cfe-8e4b-6ac91deb2463 field_id: 5d8c3490-b252-4156-b926-9e26b20f4117 form_template_instance_id: d1f71cb7-0658-41e0-9da8-d7a8304f3a49 order: 0 value_numeric: 1000 value_form_template_instance_id: d1f71cb7-0658-41e0-9da8-d7a8304f3a49 na_value: false is_valid_content: true client_created_at: '2023-03-09T09:44:13.4808035Z' client_updated_at: '2023-03-09T09:44:13.4808035Z' '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' delete: operationId: formsDeleteAnswer summary: Delete answer description: "Based on a form ID, you can delete the form answer of a form.\n\n Endpoint mandatory info \n Details \n\ \n project_id \n The ID of the project where the form has been created \n\n form_answer_id \n The ID of the form anwser" tags: - Forms parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: answer_id in: path required: true schema: type: string description: Path variable `answer_id` as published in the collection. responses: '204': description: No Content '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/form-answers/{answer_id}/attach-media: post: operationId: formsLinkFileToAnswer summary: Link file to answer description: "You can link a file to the following form answer types:\n\n attachments\n\n signature\n\n Details \n\n\ \ project_id \n The ID of the project where the form reside \n\n answer_id \n if of the answer \n\n Body mandatory\ \ info \n Details \n\n media_id \n id of the previously uploaded media" tags: - Forms parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: answer_id in: path required: true schema: type: string description: Path variable `answer_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: media_id: responses: '500': description: Internal Server Error content: application/json: schema: type: object examples: Success: value: id: 3c788ea7-681b-4776-bc31-d6d4c17a321a field_id: 56b550fe-fe4c-453b-a6f9-be0797376c1a form_template_instance_id: 7e5d3d16-ae18-41e8-bf43-bea879314a5b order: 0 value_string: test value_media_resources: - id: 5491c7d7-eb1f-459c-a160-5cee027ec786 file_name: LogoTest.png mime_type: image/png created_at: '2024-12-03T10:50:37.9123366Z' na_value: false is_valid_content: true client_created_at: '2024-12-03T10:50:23.628405Z' client_updated_at: '2024-12-03T10:50:23.628405Z' '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/form-answers/{answer_id}/detach-media: post: operationId: formsUnlinkFileToAnswer summary: Unlink file to answer description: "You can unlink a file in signature form answers.\n\n Details \n\n project_id \n The ID of the project\ \ where the form reside \n\n answer_id \n if of the answer \n\n Body mandatory info \n Details \n\n media_ids \n list\ \ of the media associated with the answer" tags: - Forms parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: answer_id in: path required: true schema: type: string description: Path variable `answer_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: media_ids: - 7b355a9e-f6ac-4c86-9c72-b92475195af4 responses: '200': description: Success '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/forms: get: operationId: formsGetProjectFormsList summary: Get project forms list description: "For a given project, you can list all the existing forms by IDs.\n\n Details \n\n project_Id \n The Id\ \ of the project \n\n Query params optionals \n\n see Commmon behaviors / differential" tags: - Forms parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Get_project_forms_list: value: form_instance_ids: - form_instance_id: bc6419a9-c5ca-42c5-8d5b-525634495ff6 form_id: 9b2de0df-6504-48db-a923-b71d6553e48b name: ess in categ num: 2 template_name: Test link item module_id: 117f1c84-e69d-4429-baf9-74e052f5e0bc category_id: 594f4f7c-6f7a-410b-bb5e-5aa6ef488a9c - form_instance_id: 19ff0620-c2be-4d81-a46a-a482c6e5c185 form_id: dd51ccda-0f53-444d-b9f5-45252c37ca37 name: Alaska num: 1 template_name: avec grid module_id: 117f1c84-e69d-4429-baf9-74e052f5e0bc limit: 50 offset: 0 count: 2 total_count: 2 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' post: operationId: formsCreateForm summary: Create form description: "Going along with the option to create a project from scratch, you can now also create forms using just\ \ a few parameters.\n\n Details \n\n project_id \n The ID of the project where the form will be created \n\n body\ \ optional info \n Details \n\n form_id \n The ID of the form template to be used \n\n name \n the name of the form\ \ instance \n\n body optional info \n Details \n\n priority_id \n The ID of the priority the form will be assigned\ \ \n\n status_id \n The ID of the status used for the new form. If not set the default one will be used \n\n assignee_id\ \ \n The user ID of the person that will be assigned to the form \n\n company_id \n The ID of the company that will\ \ be assigned to the form \n\n phase_id \n The ID of the phase that is set for the new form \n\n plan_id \n The ID\ \ of the plan that will be used ofr the form \n\n position_x \n X position of the pin on the plan \n\n position_y\ \ \n Y position of the pin on the plan \n\n due_date \n The date the form is due, set as a timestamp \n\n module_id\ \ \n Id of the module \n\n category_id \n id of the category \n\n latitude \n in decimal degres following ISO6709\ \ \n\n longitude \n in decimal degres \nfollowing ISO6709 \n\n NOTICE: This endpoint only creates the form. It cannot\ \ edit the fields of the form" tags: - Forms parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: form_id: name: module_id: category_id: '{{category_id}}' responses: '200': description: OK content: application/json: schema: type: object examples: Create_Form_with_phase: value: id: 6c5d14e5-3504-4516-a742-78c24d4b8c34 name: form_id: c5b6b135-89c2-484e-81a9-8d13f49086e2 status_id: a4abaa43-801c-4470-8e60-d093ebb611a0 priority_id: c5988ff9-62f1-4849-8403-38d5791be730 position_x: 0.5 position_y: 0.5 client_created_at: '2022-10-17T14:05:27.3993788Z' module_id: 1e870757-f1df-452f-a86c-d4115c10bf43 phase_id: 7675aa39-d7bd-4c5d-98eb-6025a668862d created_at: '2022-10-17T14:05:30.3430471Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2022-10-17T14:05:30.3430471Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a Create_Form: value: id: 0c49b94c-7d7e-4b62-89fe-034338acbaaf name: up form_id: cf9d18bd-d473-400a-909a-e48ea0eb1404 status_id: b9865da6-5267-4e9e-99a9-c280e743533e priority_id: f160d63c-5531-41d3-a80a-678a3026f6e7 position_x: 0.5 position_y: 0.5 client_created_at: '2024-04-11T14:37:41.1213818Z' client_updated_at: '2024-04-11T14:37:41.1213818Z' module_id: 117f1c84-e69d-4429-baf9-74e052f5e0bc category_id: 2a9558c9-de86-4d6d-8b82-93f9896870d9 created_at: '2024-04-11T14:37:41.2843793Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-04-11T14:37:41.2843793Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/forms-modules: get: operationId: modulesFormsGetFormModules summary: Get form modules description: "For a given project, get the list of all existing form modules.\n\n Details \n\n project_id \n The ID\ \ of the project where the form has been created \n\n Query params optionals \n\n see Commmon behaviors / differential" tags: - Modules parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: modules: - id: 117f1c84-e69d-4429-baf9-74e052f5e0bc name: Forms order: 0 icon: clipboard color: '#F7CE46' type: Forms names: - language: en translation: Forms - language: ar translation: إستمارات - language: ca translation: Formularis - language: cs translation: formuláře - language: da translation: Forms - language: de-DE translation: Formulare - language: el translation: Φόρμες - language: es translation: Formularios - language: fi translation: Lomakkeet - language: fr translation: Formulaires - language: he translation: טפסים - language: hu translation: Űrlapok - language: id translation: Formulir - language: it translation: Moduli - language: ja translation: 工事帳票 - language: ko-KR translation: 양식 - language: nb - language: nl-NL translation: Formulieren - language: pl translation: Formularze - language: pt translation: Formulários - language: ro translation: Formulare - language: ru translation: Формы - language: sl-SI translation: Obrazci - language: sv translation: Formulär - language: th translation: แบบฟอร์ม - language: tr translation: Formlar - language: vi translation: Biểu mẫu - language: zf - language: zh-Hans translation: 表单 created_at: '2023-06-30T15:16:42.168073Z' updated_at: '2023-07-14T11:40:48.382866Z' enabled: true - id: 0c254670-49ea-44ed-9009-1f3b0362ec88 name: New Forms test order: 0 icon: typePin color: '#E94F3D' type: Forms created_at: '2023-09-19T09:10:48.065264Z' updated_at: '2023-09-19T09:10:48.065264Z' enabled: false need_to_relaunch: true continuous_token: 0|2 count: 2 total_count: 21 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/forms-modules/{moduleId}: put: operationId: modulesFormsUpdateFormModule summary: Update form module description: "You can modify a specific module in a given project.\n\n Endpoint mandatory infos \n Details \n\n project_Id\ \ \n the id of the project to be modified \n\n module_id \n the id of the module to be modified \n\n body optional\ \ infos \n \n Details \n\n name \n \n new name of the module \n\n icon \n \n name of the icon \n\n color \n \n rbg\ \ value of the color \n\n enabled \n \n enable or disable the module" tags: - Modules parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: moduleId in: path required: true schema: type: string description: Path variable `moduleId` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: enabled: true responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: a41a8c18-b754-4b65-be6c-22c63987c995 name: New Forms order: 0 icon: typePin color: '#E94F3D' type: Forms created_at: '2023-09-20T13:43:34.245622Z' updated_at: '2023-09-26T12:43:52.419361Z' enabled: true '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' get: operationId: modulesFormsGetFormModule summary: Get form module description: "You can get information about one module.\n\n Details \n\n project_Id \n the id of the project to be checked\ \ \n\n module_id \n the id of the module to be checked" tags: - Modules parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: moduleId in: path required: true schema: type: string description: Path variable `moduleId` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: a41a8c18-b754-4b65-be6c-22c63987c995 name: New Forms order: 0 icon: typePin color: '#E94F3D' type: Forms created_at: '2023-09-20T13:43:34.245622Z' updated_at: '2023-09-20T13:43:34.245622Z' enabled: false '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/forms-modules/{moduleId}/link-form: post: operationId: modulesFormsAddFormTemplateLink summary: Add form template link description: "Activate a form template in a module.\n\n Details \n\n project_Id \n the id of the project to be modified\ \ \n\n module_id \n the id of the module to be modified \n\n body mandatory infos \n Details \n\n form_id \n id of\ \ the form template" tags: - Modules parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: moduleId in: path required: true schema: type: string description: Path variable `moduleId` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: form_id: responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 117f1c84-e69d-4429-baf9-74e052f5e0bc name: Forms order: 0 icon: clipboard color: '#F7CE46' type: Forms created_at: '2023-09-26T07:10:57.833287Z' updated_at: '2023-09-26T07:11:21.156687Z' enabled: true '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/forms-modules/{moduleId}/unlink-form: post: operationId: modulesFormsRemoveFormTemplateLink summary: Remove form template link description: "Deactivate a form template in a module.\n\n Details \n\n project_Id \n the id of the project to be modified\ \ \n\n module_id \n the id of the module to be modified \n\n body mandatory infos \n Details \n\n form_id \n id the\ \ the template" tags: - Modules parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: moduleId in: path required: true schema: type: string description: Path variable `moduleId` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: form_id: responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 117f1c84-e69d-4429-baf9-74e052f5e0bc name: Forms order: 0 icon: clipboard color: '#F7CE46' type: Forms created_at: '2023-09-26T07:10:57.833287Z' updated_at: '2023-09-26T07:11:21.156687Z' enabled: true '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/forms-priorities: get: operationId: projectLibrariesGetProjectFormPriorities summary: Get project form priorities description: "For a given project, you can list all the available form priorities.\n\n Details \n\n projectId \n the\ \ id of the project to be modified \n\n Query params optionals \n\n see Commmon behaviors / differential" tags: - Project libraries parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: priorities: - id: a93401c6-abc2-4ced-bb82-b558c1692581 position: 0 color: '#49CB0C' icon: ChevronDown is_default: true names: - language: de translation: Low - language: zh translation: Low - language: it translation: Low - language: ko translation: Low - language: vi translation: Low - language: en translation: Low - language: es translation: Low - language: fr translation: Faible - language: nl translation: Low - language: th translation: Low - language: ja translation: Low - language: ca translation: Low - language: pt translation: Low enabled: true created_at: '2024-05-22T09:26:34.390093Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-22T09:26:34.390093Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 15b66b49-7608-49c0-af75-d9112ab63f92 position: 1 color: '#FF8029' icon: ChevronUp is_default: false names: - language: th translation: Medium - language: vi translation: Medium - language: es translation: Medium - language: de translation: Medium - language: zh translation: Medium - language: ca translation: Medium - language: pt translation: Medium - language: nl translation: Medium - language: en translation: Medium - language: it translation: Medium - language: ko translation: Medium - language: fr translation: Moyenne - language: ja translation: Medium enabled: true created_at: '2024-05-22T09:26:34.535334Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-22T09:26:34.535334Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a need_to_relaunch: true continuous_token: 0|2 count: 2 total_count: 4 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/forms/custom/generate: post: operationId: exportsCreateCustomReportForForms summary: Create custom report for forms description: "You can generate a unit report from a form instance using a custom report template.\n\n Details \n\n project_id\ \ \n The ID of the project where the form will be created \n\n body mandatory infos \n Details \n\n form_instance_id\ \ \n Id of the form instance \n\n custom_template_id \n id of the custom template \n(returned by the Get Custom template\ \ infos endpoint) \n\n output_file_format \n output file format \n(sould be part of the list returned by the Get Custom\ \ template infos endpoint) \n\n time_zone \n text of the time zone (defalut to the project timezone)" tags: - Exports parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: form_instance_id: custom_template_id: '{{custom_template_id}}' output_file_format: PDF time_zone: Europe/Paris responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: key: YzhhZWEyZmMtM2NjMy00MzdiLThiOTYtOGI0MzIxOTkxZDY0 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/forms/differential: get: operationId: formsGetProjectFormsDifferential summary: Get project forms differential description: "For a given project, you can list all the existing form instances.\n\n Details \n\n project_id \n The\ \ ID of the project \n\n Query params optionals \n\n see Commmon behaviors / differential" tags: - Forms parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: forms: - id: bb8060b9-4334-4f1d-a44b-07a3a16891e9 form_id: 1aa8afc4-3106-446b-a471-55fc413d9867 name: '11111111111' project_id: 45d2b228-25681789-2dbe-42d7-8310-491ab3ab360f status_id: ab7060f9-a5c2-458d-ab14-4dc9a720b087 priority_id: a93401c6-abc2-4ced-bb82-b558c1692581 num: 1 client_created_at: '2024-05-22T12:47:28.436Z' client_updated_at: '2024-05-22T12:47:28.436Z' module_id: 117f1c84-e69d-4429-baf9-74e052f5e0bc created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a created_at: '2024-05-22T12:47:28.521403Z' updated_at: '2024-05-22T12:47:28.521403Z' enabled: true - id: cab6a6b3-ae05-4faf-a033-6314d582c2f4 form_id: 1aa8afc4-3106-446b-a471-55fc413d9867 name: '2222222222' project_id: 45d2b228-25681789-2dbe-42d7-8310-491ab3ab360f status_id: ab7060f9-a5c2-458d-ab14-4dc9a720b087 priority_id: a93401c6-abc2-4ced-bb82-b558c1692581 num: 2 client_created_at: '2024-05-22T12:47:39.632Z' client_updated_at: '2024-05-22T12:47:39.632Z' module_id: 117f1c84-e69d-4429-baf9-74e052f5e0bc created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a created_at: '2024-05-22T12:47:39.624331Z' updated_at: '2024-05-22T12:47:39.624331Z' enabled: true need_to_relaunch: true continuous_token: 0|2 count: 2 total_count: 6 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/forms/report/generate: post: operationId: exportsCreateFormsUnitExportInPdf summary: Create forms unit export in PDF description: "You can generate a unit PDF report from a selection of form instances.\n\n Details \n\n project_id \n\ \ The ID of the project where the form will be created \n\n body mandatory selection info \n Details \n\n form_instance_ids\ \ \n list of the Id of the form instances \n\n body optional selection info \n Details \n\n module_id \n Id of the\ \ module \n\n status_ids \n list of the status id \n\n priority_ids \n list of the priotities id \n\n form_ids \n\ \ list of the form templates ids \n\n plan_ids \n list of the locations ids \n\n folder_ids \n list of the ids of\ \ the folders of locations \n\n assignee_ids \n list of assigned users ids \n\n assigned_company_ids \n list of assigned\ \ companies ids \n\n creator_ids \n list of creator ids \n\n due_date_from \n minimal due date \n\n due_date_to \n\ \ maximal due date \n\n updated_at_from \n updated fter this date \n\n updated_at_to \n updated before this date \n\ \n Body optional presentation info \n Details \n\n time_zone \n text of the time zone (defalut to the project timezone)\ \ \n\n logo1_url \n url of the logo used as company logo \n\n logo2_url \n url of the logo used as customer logo \n\ \n image_size \n small / medium / large / none \n\n with_linked_items \n if false (default) do not generate informations\ \ for linked items \n\n with_linked_items_location \n if false (default) do not generate informations about locations\ \ of linked items \n\n only_fileds_with_values \n if true, do not generate informations for the empty fields (false\ \ is the default)" tags: - Exports parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: form_instance_ids: - responses: '200': description: OK content: application/json: schema: type: object examples: Export_for_a_template: value: key: ZGVmOGFmZDItNDMzZS00N2QyLWJjN2EtMDIzMGFlNmQ2ZDM3 Export_a_form_instance: value: key: ZjhiNjQ1NzQtZThhYS00YTQxLWE4NjAtZTk0YTI0YTNiMzFj Export_a_module: value: key: MTEwNDhmMDgtYWI2ZC00YzI3LWFhODktYjZhODA3ZDRmNzcx all_selection_fields: value: key: MTEwNDhmMDgtYWI2ZC00YzI3LWFhODktYjZhODA3ZDRmNzcx '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/forms/report/get: post: operationId: exportsGetFormsUnitExportInPdf summary: Get forms unit export in PDF description: "Get the URL of a unit report generated by the \"Create Forms PDF Unit\" endpoint.\n\n Details \n\n project_id\ \ \n The ID of the project where the form will be created \n\n body mandatory info \n Details \n\n key \n key returned\ \ by \"Create Forms Pdf Unit\" endpoint \n\n NOTICE: if the endpoint return is_available = false, the pdf report is\ \ in progress. Please retry later" tags: - Exports parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: key: '{{rapport_unit_key}}' responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: url: https://tf-report-generation-service-api-... is_available: true is_in_error: false In_Progress: value: is_available: false is_in_error: false '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/forms/report/xls: post: operationId: exportsCreateFormsExportInXlsx summary: Create forms export in XLSX description: "Generate a unit PDF report from a selection of form instances.\n\n Details \n\n project_id \n The ID of\ \ the project where the form will be created \n\n body mandatory selection info \n Details \n\n module_id \n Id of\ \ the module \n\n body optional selection info \n Details \n\n form_instance_ids \n list of the Id of the form instances\ \ \n\n status_ids \n list of the status id \n\n priority_ids \n list of the priotities id \n\n form_ids \n list of\ \ the form templates ids \n\n plan_ids \n list of the locations ids \n\n assignee_ids \n list of assigned users ids\ \ \n\n assigned_company_ids \n list of assigned companies ids \n\n creator_ids \n list of creator ids \n\n due_date_from\ \ \n minimal due date \n\n due_date_to \n maximal due date \n\n updated_at_from \n updated fter this date \n\n updated_at_to\ \ \n updated before this date \n\n search_term \n\n group_ids \n ids of the groups \n\n phase_ids \n ids of the phases\ \ \n\n Body optional presentation info \n Details \n\n time_zone \n text of the time zone (defalut to the project\ \ timezone)" tags: - Exports parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: module_id: d079cbfb-aa63-45d6-83e3-e20e537a7031 responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: file_name: TestExport_Forms_2024-03-28-10-54-38.xlsx file_stream: UEsDBBQAAAgIANNOfFhKIUMnYQEAAM8CAAAPAAAAeGwvd29ya2Jvb2sueG1sjVLfa8IwEP5XsqOvWq12G8VWBiL4sg2U7VFic7XBJilJdGV//ZJOZxAf9tS75Ptx36WzeScackJtuJI5jIcjIChLxbjc53C01eAZ5sWsy76UPuyUOhCHlybTOdTWtlkcm7JGQc1QtSjdXaW0oNa1eh+rquIlLlR5FChtnIxGj7HGhlrnZWreGjirdf9RM61GykyNaEXzKyYolxBO966Jmx1fqcAcNjU3n+cLILHH+fKD45cJSf6AVFwbu/biObgd0NLyE27oru8cN74h93NcKyJ7yze3yZODAOlPVyyHBIjOuCv0iiXnMULK0kU0AX4S4Cd38GMyIBs01gUVbYM2oE4D6vQONXFUfvyuUQekNCCll6jXdAwrLpH5jd72Z9Vt10gx3C55Y1EvqKU7ahBIo0rarC8uYyA1Zwz9PwZFn/kheonSLFpHqXcMdIubvvd1YqV/Xffp9ZL0Kfkb9/KSxQ9QSwMEFAAACAgA0058WG0HH02SAQAAoAQAABAAAABkb2NQcm9wcy9hcHAueG1snZRdT8IwFIb/Su09DggxhowS40e8UYkSvTS1O4PGrW16DhP49XZDYMIA4936nmfv+djp4uE8z1gBHrU1A945b3MGRtlEm8mAzyhtXfKhiKXrj7x14EkDsvCKwX5BAz4lcv0oQjWFXOJ5IEwIptbnksLRTyKbplrBjVWzHAxF3Xb7IkqsKt3wdbxwgPzHT7r/+sGcwCSQtNymRl7VfOVcppWk0Jt40MpbtCmx27mCLI524iU/1pQBPqUj6QlFXFC/AEXWsw+JUBY74JlD8pyhXoZDp8srqhLFUxhjoeErjjbSNngXesDGSIe12BiQmLK5y4AaoW6A9Gw5Bd8YXqc+G3lt6P3Kg/wLt+r3cL2n7OrQEa/dDk/ZHuCPZNiO55T3HrnvGm2+u6i2ZGcrgnIPsrwgI6n9gTUppNfS0HpReqs9+VFr5bxZ/4lTANqvoMbWn3VP9CogPBwFV16PMoeEPUszaWjycIrL5hS7o/k9iCCEi/kCauY1LUS7QupKSbwomcF1uKgilRlCxWy16rj91YhvUEsDBBQAAAgIANNOfFiVZ04SnQMAABIOAAAUAAAAeGwvc2hhcmVkU3RyaW5ncy54bWyNV99v2zgMfr+/gjBwT4fUdrp2vaBp0UsbbEB/Ae0G3KNsM7FWWTIkuUn614+y03UFSnl+cBLx00eKpEjm9HzbKHhG66TR8yQ/yBJAXZpK6vU86fxqcpKcn51uZ855IKh2s+08qb1vZ2nqyhob4Q5Mi5pkK2Mb4emnXaeutSgqVyP6RqXTLDtOGyF10lPJ8PZn99b8wNKfpuFHeA+CV/EjksqrbWssC1lKLVQpKmgHKvh6OeOwRyf5ESfbWwIWV2jp+DgGvNIVVMIjq22wO46ZnkxuhJ1Ms+kn+Pa4+CfLZ1kWJ8QKih1L+F0oZTxcdyXvMOXRsgT/UdCeKrPRpAWcF75zHPQhKr0tIGQDK/+bDbqByrCsdLiFaVolhebT5u7x4vqPDhgsBI/ER1FiTV3+juJAsnup0UYzuQyGI2v2O8sCVugdh13ExbfmlQCEc3KtseKgqL1t/yA/WUvI6pCUG+lr+HUb7zTrqIWS5ROQrxC8AYXCamiMZfH/mw5KoSGUmHcKwGjwNcIGC5Ar2BFuQ1kRWLGSPsgcDkl4wJF/veQkl+hKK1tPRZGD3JiqU6zd34eKytcRaaz0bAgvhrix9Jcd9rWF5a+F42MQgkbGRRkuOl8bNqOvBWX0tzYQRFl6XNfjQuVizVUU4lqiFbas46hb0fBeka7sXPC7A0047k6HRjZzrShxnlCfcmifMaFbZSy1vVAL/oLfnhvROlBSP70tcwbknCDkIStcxirllHWt2bB7pqMXl3oEDO2CJTkaJVmpyqZsaXFOyMld8QP9QVutYp5hz3gY28UK2TY/UoIP89ETP3jblb6zQsHG2Cc+asejVNPPo5B7QSNEBhO4NQ1UCEpAS0uSv/ZhQ04brqiu4wt0GvSwNb7vgWaaUBCCrtfvK6mwcuBk8Bk/BuzRHyp1g5AfRlBVvc5H3EZmvIAK/MRa8J1iwE0JVwoVBx0SiBwi1la0dRz6iaBWVJKdSQbYEcGUdHwhHGDHwbrayC00nRo58WfC7tDpEc0nBCtM58fc/C/hPCocO3Ae4kFTvRzxYf5hxMtaNMw8YfvXff9B/zf8haIOB89CzZOCmhUVWEwg7fEvw3Ke7xdKo4wFuy7myXKZ9c9eYpeGen6PXgglCyv3gpVopNoNkmm/lv7S7s/u2iFp3yy1sevXf9GRxvPR/Ynh3zL/C1INHk/9RW0MjTMF+g3iSKTDFbgKAYRzDvil7p/34vDh/NlPUEsDBBQAAAgIANNOfFhbpZ2tlgQAANVNAAANAAAAeGwvc3R5bGVzLnhtbO1cW4+bOhD+Kwipjy2XXJqsmlZJWqRKVVtt90jn1Qkm8amxkXG2SX/9MQYCSTc0pITirPMCnszYH5+G8Xhs8ebdNsTGI2QxomRiOq9s04BkSX1EVhNzw4OXI/Pd2zfbu5jvMPy2hpAbwoLEd9uJueY8urOseLmGIYhf0QgS8V9AWQi4aLKVFUcMAj9OzEJsubY9tEKAiJn0SDahF/LYWNIN4RPTLQmN9PLRn5gCT9rhnPpwYpqG9aSaM+wfKtovpKq1HycxCygpBnRGZi5LroIDPsVoRYxHgCfmAsQQIwKzAeOfqdhxMsGSYsoMtlpMTM+z5S/HBkKYKs8BRguGMnkAQoR36T9uDi4fPb8uUt3zwLh2DTBThgCuA+UKhLSKYdQfeeP3rWHoX5OHWm7h1HGLe7qgnLaKxbY/zGYzZ94AlpshZNz3er/6an0sSFlHUfT9qQ1lk/4fiwkW5yNfhIuLWReWpH9OT2PQMspEDLbdcWsRuAuz4ZNvd388n9m/hrv2vfhk5P0rUJ6OeWdCyW7StA5hvE/rhmYuSq4R4Bwy4ommkd0/7CLx2hCawbQK5d8arRjYOe6gtl1MMfJTXKv5wRvS94beKO+vZN9I/7btjT9MZ9Mr9j+aT+f9a/Uv+LEFP8Pq/rMb6QkLynyxlsl9oWcWQsNHYEUJwP9EclWRN9/THyQRJJoYBtyQK53MQarCiZXqJyoMrda1DKVBosNpVMdOqKdPxDkN6ximFolS/tx1rHObrKuEzudAbAh9tAk1taepPY+hLnnt/lbGiyXE+FvS479BUYgYyI63wXEVguxvRbjJbtO+sgaIIrz7vAkXkHmyFCGmvkyaxKyiNZNWhY2cQkNISgZfGeVwydOqjAQU7SUGpsvv0JfKa+T7UDpD9tTboAq9ozR6V2n0PaXR95VGPyjQu2X0zhno7SP0TuvohwX6Xl3uj9G3z/1r9TwnKycri7/E/qhA31fPd8YnuHcv4L6l9/bAdxTEX84WFE92StnOQD3fd1y14ffUhu+cSBkUga92vuYM1IavdsbmvFY6aTg1a52T7P/9SddWOu7YJ4K+GgutkxlDl+Bbh3WrvI5VLmGNLy1hbYNWgizIlYw1ZeinwJVs8awggSzZ/Em2ldBS7ijJCqBpcLjl95SDtBMx1g8GogchlA1EfDmguGUQC6VH+LEQ/beJOQp2n0DMPyECpSxeM0S+P1AP5WYgOfL0Zf8sVhslN81242xXlAg1242zXVHS1Gw/Z7aXQgcypdmuWEB1je0b8O2KAv35bP9RBvac2K5Ynl7Otvbt+hsgOpI0w/a5Gzaa78a9u2KDSceSxtmu2FC63Lf1PHnJBp7mu/laia1Dd5t0V2yQdi1238CKsmpDt2t034J3V2xAa7qvGkyON64UpNvpOt1drU/lgfq2QndX2b7RWFJx/EPT3Tzduh6og8ntpt0Vp5m0dzdOt3369JWumFyT7RtIuhVi+/h4mN6lbK88pSbdekXZ5oqyG2xb+7OZ+TFNeWyz+AiZeSA3ku9gTMzPCbO4xPpigzBHJGtZh2dAY9ksPtD29n9QSwMEFAAACAgA0058WDKwrVnCAwAA4g8AABgAAAB4bC93b3Jrc2hlZXRzL3NoZWV0MS54bWyVV9GOmzgU/RXEewN2IEA0mapNVO1KrWbUrrbPHnCCNWAj25nM9Nf2YT+pv1BjEyZENpAnsDmcc2zfe+H+/u//u4+vdeW9YC4IoxsfLELfwzRnBaGHjX+U+w+p7wmJaIEqRvHGf8PC/3h/97o+Mf4sSoylpxioWPONX0rZrINA5CWukViwBlP1bM94jaQa8kPA9nuS4x3LjzWmMoBhuAo4rpBU6qIkjfA7ttc5bKLhGBXaRF0ZshoR6rf29Owjb2/ZUVaE4kfuiWNdI/72GVfspBbrnye+k0Mp9URwfxcMXi6IctpujsfxfuN/AusdzDSug/1L8EkMRl67NU+MPbeDv4uNHw54hy980etR3gq8R8dKfmenv3BnJ+50claJ7urVhGqjNXrV1xMpZLnxswWIwhWM28N6q7DWzI9CsvqnAYB3LsMBO45lz7EMFwm4jSTqSKKeBMTzSIL3Zel92CGJ2gFnJ49rd6JBVCj4OtIHmrfTn9t5TaH2R+j5l/uwJXsxlD1ya0OCATLQaheiS4foUlPBARW0ihrkcoBcjotGDtHIIhpZRaOBaLe5Q5HYIRJbROJxvysH1cpCtbL6NchogEzGRROHaGIRTa2iieVksnHR1CGaWkRBOM4FQgeZfqAP6JJtIlABcLEBzbYastlj1Y5d2rA7OzaacOlKYmByMxmyxXaXBpuOpd2uA2XngrCYiGHgynRgErg9lEtr9jjuwKm1uPTWllfW4JQ3V0EA0Q27Fs2xFt1qzVVGgKkj4KraJnZvPXikqO3OKDivdANXsoLUll/pBFvmYstseZDZ12nFOvLLip3IL+iqKTDsTn/wwXJ8JsMZ+dWBZucXdNUnCGzOrOG57bGjzsCNzpw/FvCGEH4Hj4XwGTUzhKEru2BsCWEIJ9hc32m4soQatIbl1op1hLAdOxXCrg87TGyBYv//6bG2/63eXnIVKMlUpLgqCkxt1ux1uMeO1eEONL8OQ1d5gtktQZzNCuJsThAHV3/xDSdUPjS6rfNKxskvRiWqtqrpwxyblkg1nZLkV5OlauhU6yn04MBJ8VV1buLcQilidMDfED8QxVvhvVple5K+x03LZAaSNefbJyZV59GOYkOOeTfYMybNIIkvyH9geWy8BjWY/yC/sOkSlcv2LlQuWswD1zQFO9F/Skwf1Ep8Ty1SLUR3suqRaeaUfoXy50+0+FkSaXqhgiNtW3VFuKq2rG47YbVCqtpr1XtzzrgaFUQ0FXrDRWfNWP+iPZsZiZ4q/Ii4FF7OjlRetJl9a37/B1BLAwQUAAAICADTTnxYPvjHox8FAABgGAAAGAAAAHhsL3dvcmtzaGVldHMvc2hlZXQyLnhtbKVZ21LjOBT8FZffNxcnju0UYQrCMNxCAmztPItYSVTYkktWCPBr87CftL+wkuUkOLTZNfOEJbX7nNNqGXH459ffR99e0sR5pjJngo/cbqvjOpTPRcz4cuSu1eKP0HVyRXhMEsHpyH2lufvt+OhluBHyKV9RqhzNwPOhHLkrpbJhu53PVzQleUtklOu1hZApUXool22xWLA5PRPzdUq5anudzqAtaUKUjp6vWJa7JdvL/2HLM0lJXCSRJpYsJYy7Jr1idibNo1irhHE6k06+TlMiX09pIja6WHc7cc+WK1VMtI+P2pWXY6YzNeI4ki5G7kl3+BAVsBL1F6ObvDJyjDKPQjyZwWU8cjtFQhnh1Hl5yBKmzJTzWj76rqNEdkMXakyTREcYuA6ZK/ZMZ8QI/iiUEqlZLzZC6amFFG+UF+9XMjYBq6N9ZueFblqDmC7IOlH3YnNBy7L9sqC5SPLyp5MyXgiSkpfi54bFaqWf+q2g2xl4vknmNaFFKfN1rlP8WSL2ZJbEK0m8PUnYihqS9EqS4HcyCUuS8HcyibaaeL+TSndbkHn4ejLd/pYmapxNe7/hhUPOiCJmIMXGkfZ0aM/m+mmo2YuwZv7ELNi8tXfyYuH5uGPoni3pDnoKod0KtF0EfBfXq4vrFWRehcuDYS2yGrWHkGPEOUDIM4vsV6ND6JWFdg+wAcJOSqxfxYafS9Srk6gHyulDiXpbidp7MdDbIRSjBwSOoBYW2R1U64s+r69fV18fZOh/zuXXcfk2s6DqEuxjiO3CiseYtwt1xFho6u8YC219jrHQCT9wbTCHC8zrI+wlxHow3yvMC0/XNcbC03WDsdDTE4yFe3wLsX3onSnGQj/MMBbuxR3GQn3vMRb64QFj/+OUDaqnzDHXCs9v9YJOp9Pd/vbZ3TfencKBjRZWo8GdPy2xUdVRUMkxxPahS84wFrrkO8ZCl5xbrNepfq6gS36U2G71FMKTdbHPYf/xvkST1wfZvlu6KQMefEuhmBNYtA9teYt5oS2nDXhnGAstfIexUMx7INEHdwdfdXcA3Q3dchpAd0O3jCHWxxcXiK1xN8ZC3vOggbuDBu4OkLvR5HVQ7+6ggbuxmNjdDXinDXhn9aXcodLvAf6Da8OvujZErvXht/M0bOBaiPXxDRNia1yLsdi1YQPXltiDv14g70WIXIsmr8N614YNXIvFxK5twDttwDurL+UOlX4P8B9cG33VtRF0Lf7WRg1uEhA7gI45g9ga12IsvklEDVwbNfjWwhzwZl9izSDvVYQMN4D6XmN9YQ43mBdeLiYNarvFvPByMW3AO4vqD0iEDgjAbw9I+6BLQ9ZKnLNEUVk2Jv3hw7aPl1K5pKabmDtzsebK/KlembevXHnDG+/wFbs08Ya3NUtXveFtb5vaPpJBrl4zKhPGn6qjLaXryCGLR668jM0pFSJRLNPuZpwkcxKX4Q5eMx2E3WvR+9eETHcSVSNnknE1zYqmsrMSkr0JrkgyplzLRYuOrGl5KzY/mFxRYhrfeTFYShbfME7tqMgtI0s6IXLJNG9CF6aR2wq06tJ+juxAiWz7aHu3ZuRbcirLwUIIZQeB/478gap15mREV/PA3qjtwukszVNHZ2EwU1nQxGLD/1xRPtWVuI4uUhdS9NH1km3x6vgJmT+d8PjniinbB4wlWdj+81zv2likpg+vK+SCU9ehUgqpRzHLs4S80t2eFKmfFznbGUUeEzojUu0s1tnuxe4fA8f/AlBLAwQUAAAICADTTnxY6Y6GKHoDAADVDAAAGAAAAHhsL3dvcmtzaGVldHMvc2hlZXQzLnhtbI1X23LaMBD9FY/fGxuDbcKEdBLI/QJpO+2zYgusiS15JBGS/Fof+kn9hcqSIXHmwPQp3sNh9+xKbI7//v5z9PWlKr1nKhUTfOz3DkLfozwTOePLsb/Siy9D31Oa8JyUgtOx/0qV//X46GW0FvJJFZRqz2TgaiTHfqF1PQoClRW0IupA1JSbzxZCVkSbUC4DsViwjE5Ftqoo10EUhkkgaUm0qa4KViu/zfbyP9lULSnJrYiqdMkqwrjfyLPoXDaPYqVLxulcempVVUS+ntJSrE2z/gb4xpaFtkBwfBR0vpwzo7QZjifpYuyf9EYPqaW1rJ+MrlUn8prJPArx1ARX+dgPO2m7Xzi37RhpOV2QVam/ifUlbdXEbZ1MlKr961WMW50VMRPqJb63Zrkuxn4UHqS9MIni5rReS2qrZiulRfXLMbbNbdLZ+lOiSRNIsfakG0lNuDJPo15qB5k1+Enzganie0aYsvjzce+wSffskm6pp47a71CjXoca2IIf6ka76kagbr8P60ag7uBwf93+rrp9m8xAncIhLIy5PcSdYO4QcaeQO4DNn0FuEiPuueNG2+vVgBcIvETgFQKvEXiDwFsE3iHwHoEzBM4R+IBHkuy/EINdF2IASpwicILAKQLPBlBhCg8NJbhA4CUCrxB4jcAbBN4i8A6B9wicIXCOwAc8kuH+Q4u7h2bTDjbrz23YZrW9H2bsOEnnMBE4QeAUgWct+Ek5XJHnkJvC7XKBuXC7XGJuhLhXmAu3yzXmDhD3BnPhJrrF3ARx7zAX/ljuMRdu2RnmwnObQ+4w3H87k10rJXF3fdjd77D705Z72OXC7ieOG3X/acbwxkyhhhie1k2bt8sdwrzzLbe1ClG6f0jpriGlUCB2HikaUgJ/VpMUDSmB13/6riF4lx58clC1ZFzPautkvUJI9ia4JuXE+FwqqbOBxmdrln0CC+NhjdtWNlhKlt8as6o2ttEkJkt6R+SSmbwlXRi5xuuZmyidTXSBFvXm8VFos/aaKHbJqWyDhRDaBWn8Ifl3qle1V5Oayu/sjToXaFQ2T6FR0XBm0qbJxZr/KCifmU58zzRpGrHm3XzkDKypX5Ls6YTnvwqmnQ/NJbGyzUqmZTkRVWP+TYfcvFGY1w0phTRRzlRdkleat9Kc9HOr2SGaPJZ0TqRWXiZWXH+w1tu3keN/UEsDBBQAAAgIANNOfFhlk6i/AgMAADEJAAAYAAAAeGwvd29ya3NoZWV0cy9zaGVldDQueG1slVbBUtswEP0Vj+/FjmPHaYaEgYSknWkHBjrlLGw51iBLHkkhwK/10E/qL3QlOSGmG9qeon1+fvtW8mb168fP07OnhgePVGkmxTQcnMRhQEUhSybW03Bjqg/jMNCGiJJwKeg0fKY6PJudPk22Uj3omlITgILQEzUNa2PaSRTpoqYN0SeypQKeVVI1xECo1pGsKlbQhSw2DRUmSuJ4FCnKiYHsumatDju1p39R062ipHQmGu7FGsJEaO059FrZpdwYzgS9VoHeNA1RzxeUyy0UG+6AG7aujQOi2WnUe7lk4NRuTqBoNQ3PB5NV7mgd6zujW92LArsz91I+2OBzOQ3jnmz/haUrB6yVtCIbbm7k9hPt3GRdnkJy3f0GDRPOZ0Ngh8DIlpWmnoZJfJIP4lGS2cN65tQlLTbayObOM/a17dRc+gUxxAZKbgPld6QlQsNqkrttLCx8bnFIEgZgSzv8cTb4aNUeveaeeuGpwx41iXvUyOU7SJscSZsgaYdDNG2CpE1H76cdHkk7dFqDvJ83RvPi3AHGnePcMcZdoNwUrf0S5Y4TjLv03GT/aVlw1QP/2Kb0yDaliNQFBs4xcIGBlylaClr2EhNYpe+WkvVKccx01ye+E20PvJaYec6oVyIGzjFwgYGXHfimxBQtEedmGHeFc//SAqMjZzvy5zDuf354x3fcjz1uNkJbwHOTfktnaLssXj1gR5kfcZ5jzrMcdZ6jztGGnOf/4Tw/dL47906gb2yco+cTvfl7bhUT5qp1UzKopWIvUhjC5zBDqaJ+xMAMN6x4A9YwH2GSaxesFSu/wCDUu5EEwmRNvxK1ZqDLaQXOYJDAl6T8CPKBke1ueS8NtIqNMi9OVRdUUhof5NmB+C01mzZoSUvVLXuhfsSAS7uKwYXlXCknU8qt+FZTcQWVhAEUCYW4iwE88sMR8nNSPJyL8q5mxg+5UhFnG9qYcj6Xjb1YQIUCbitwlVFKKohKpltOnmnZWfPWl86zRwy55/SaKKODQm6EORjb+5vO7DdQSwMEFAAACAgA0058WGBMh7OmBQAAuBsAABMAAAB4bC90aGVtZS90aGVtZTEueG1s7VlNj9tEGP4rI99bx0mcZldNq002aaHddrUbinqcOBN7mrHHmpnsNjfUHpGQEAVxQeLGAQGVWolL+TULRVCk/gVeO449TsbdbLsIUDeHxDN+3u8Pv+Ncvf4wZOiICEl51LGcyzULkcjjYxr5HWumJpfa1vVrV/G2CkhIEIAjuY07VqBUvG3b0oNtLC/zmERwb8JFiBUshW+PBT4GJiGz67Vayw4xjSwU4ZB0rLuTCfUIGiYsrZx5n8FXpGSy4TFx6KUSdYoUO546yY+cyx4T6AizjgVyxvx4SB4qCzEsFdzoWLX0YyH72lU7p2KqglgjHKSfJWFGMZ7WU0Lhj3JKZ9DcurJbSKgvJKwD+/1+r+8UHFME9jyw1lkDNwdtp5tz1VCLy3XuvZpba64QaBIaawRb3W7X3SoTNAqC5hpBu9Zq7tTLBM2CwF23obvT67XKBG5B0FojGFzZajVXCFJUwGg0XYMnkS1ClGMmnN004tuAb+e5UMBsLdMWDCJVlXchfsDFAABplLGiEVLzmEywB7geDkeC4lQC3iZYu5XteXJ9LxGHpCdorDrWhzGGAikwr1/88PrFM/T6xdOTR89PHv188vjxyaOfTJQ3ceTrlK+++/yvbz5Bfz779tWTLysIpE7w24+f/vrLFxVIpSNffvX09+dPX3792R/fPzHhdwQe6fghDYlEd8gxOuBhYp9BBBmJM5IMA0xLJDgAqAnZV0EJeWeOmRHYJWUf3hPQFozIG7MHJX0PAzFT1IS8FYQl5B7nrMuF2aZbqTjNplnkV8gXMx14gPGRUXxvJcr9WQyZTY1MewEpqbrPIPDYJxFRKLnHp4SY6O5TWvLvHvUEl3yi0H2KupiaHTOkI2WmuklDCNDcqCNEveShvXuoy5lRwC45KkOhQjAzMiWs5M0beKZwaNYah0yH3sYqMCp6OBdeyfFSQdB9wjjqj4mURqK7Yl5S+RaGFmXOgD02D8tQoejUCL2NOdehu3zaC3AYm/WmUaCDP5BTyFiM9rky68HLNZOsISA4qo78PUrUGYv9I+oH5mRJ7szEsquX+nNIozc1a0ahW18065VmvQNPMGORrLboSuD/tDHv4lm0T5Lkv+jLF335oi+/ocI37sZFA7b1uTplGFYO2RPK2KGaM3Jbpq1bgt7jAWymi5QoH+rjAC6X8kpAX+D0GgmuPqYqOAxwDHKcVIQvM96+RDGXcJiwKpmnZ1MK5qd7bn6gBDhWe3y82G+UTpo5o3TlS11UI2GxqbjGlXcV5yyQG8pz3Ap57pvl2ZpPoTYQTt4cOK16pqb0MCPjxPsZh2V0zj1SMsBjkoXKMdviNDb1Xft012nythrvKm+TWOkCm1UC3fMIVm09WPZ6dbKovELHoJhbdy3k4bhjTWDwgsswBoYyaUmY+VHH8lRmzam1vWpzRYI6tWqbS0JiIdUulsGCLL2Vv5SJChPqbjNhdz42mPrThno02s6/qoe9GmEymRBPVewUy+wenykiDoPxMRqxmTjAoHlzkWVjKuFRUl8uBNRrM0vAch/I6mH11U9WJ5jFAc56VFvPgAU+vc6VSFeafnaF8m9pS+McbXHfZ1uS9IXxtjFOz2EwHwiMkjztWFyogEM/igPqDQRMFKkwUAxBbaQtiyWvsBNlyZHWwhZMFg3PD9QB9ZGg0PVUIAjZV5mlp3Bzlh0yK4+MU9ZxcoVlvPgdkSPChkkRtxIXWCjI20rmixS4GjjbVGMjf/BfnoqaVVPRKWNDIap5limlqT8EtGfD1rtqccYHcL3C7Lq7+QM4hpMKSr6gkVPhsWIGHvIDyAJUDJ2QkpfaWSnmmyPQuq3bl/D6Z2esIhDtqrif63iqebxR5fFTBL69x12Dw91T/G2vF6ytHXnS1drfXXz0AITvwplqxpTM3ks9hNNpb/nvBDDKZKbE1/4GUEsDBBQAAAgAANNOfFgRIY0S2gEAANoBAABRAAAAcGFja2FnZS9zZXJ2aWNlcy9tZXRhZGF0YS9jb3JlLXByb3BlcnRpZXMvYTgwOTg1ZDRiYzZlNDQyNTk4NDJjN2QxOTIzMDFmNDIucHNtZGNw77u/PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz48Y29yZVByb3BlcnRpZXMgeG1sbnM6ZGM9Imh0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvIiB4bWxuczpkY3Rlcm1zPSJodHRwOi8vcHVybC5vcmcvZGMvdGVybXMvIiB4bWxuczp4c2k9Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvWE1MU2NoZW1hLWluc3RhbmNlIiB4bWxucz0iaHR0cDovL3NjaGVtYXMub3BlbnhtbGZvcm1hdHMub3JnL3BhY2thZ2UvMjAwNi9tZXRhZGF0YS9jb3JlLXByb3BlcnRpZXMiPjxkY3Rlcm1zOmNyZWF0ZWQgeHNpOnR5cGU9ImRjdGVybXM6VzNDRFRGIj4yMDI0LTAzLTI4VDA5OjU0OjM4LjAyNzcwNzRaPC9kY3Rlcm1zOmNyZWF0ZWQ+PGRjdGVybXM6bW9kaWZpZWQgeHNpOnR5cGU9ImRjdGVybXM6VzNDRFRGIj4yMDI0LTAzLTI4VDA5OjU0OjM4LjAyNzcwNzhaPC9kY3Rlcm1zOm1vZGlmaWVkPjwvY29yZVByb3BlcnRpZXM+UEsDBBQAAAgAANNOfFjZ366CnAIAAJwCAAALAAAAX3JlbHMvLnJlbHPvu788P3htbCB2ZXJzaW9uPSIxLjAiIGVuY29kaW5nPSJ1dGYtOCI/PjxSZWxhdGlvbnNoaXBzIHhtbG5zPSJodHRwOi8vc2NoZW1hcy5vcGVueG1sZm9ybWF0cy5vcmcvcGFja2FnZS8yMDA2L3JlbGF0aW9uc2hpcHMiPjxSZWxhdGlvbnNoaXAgVHlwZT0iaHR0cDovL3NjaGVtYXMub3BlbnhtbGZvcm1hdHMub3JnL29mZmljZURvY3VtZW50LzIwMDYvcmVsYXRpb25zaGlwcy9vZmZpY2VEb2N1bWVudCIgVGFyZ2V0PSIveGwvd29ya2Jvb2sueG1sIiBJZD0iUmU0NGVhMjFkZDQ1YTQzZWEiIC8+PFJlbGF0aW9uc2hpcCBUeXBlPSJodHRwOi8vc2NoZW1hcy5vcGVueG1sZm9ybWF0cy5vcmcvb2ZmaWNlRG9jdW1lbnQvMjAwNi9yZWxhdGlvbnNoaXBzL2V4dGVuZGVkLXByb3BlcnRpZXMiIFRhcmdldD0iL2RvY1Byb3BzL2FwcC54bWwiIElkPSJySWQxIiAvPjxSZWxhdGlvbnNoaXAgVHlwZT0iaHR0cDovL3NjaGVtYXMub3BlbnhtbGZvcm1hdHMub3JnL3BhY2thZ2UvMjAwNi9yZWxhdGlvbnNoaXBzL21ldGFkYXRhL2NvcmUtcHJvcGVydGllcyIgVGFyZ2V0PSIvcGFja2FnZS9zZXJ2aWNlcy9tZXRhZGF0YS9jb3JlLXByb3BlcnRpZXMvYTgwOTg1ZDRiYzZlNDQyNTk4NDJjN2QxOTIzMDFmNDIucHNtZGNwIiBJZD0iUmM4OWNmMTIyNTZlZjRhZDIiIC8+PC9SZWxhdGlvbnNoaXBzPlBLAwQUAAAICADTTnxYAWurVfgAAAB1BAAAGgAAAHhsL19yZWxzL3dvcmtib29rLnhtbC5yZWxzzdRLbsMgEAbgq6DZ19hOmlZVSDbZZJvmAgiPH4oNCCZtcrYseqReodSVqk7VRTeWvAExwK8PhHi/va23l6EXLxhi56yCIstBoDWu6myj4Ez13SNsN+sD9prSith2Poq0xUYFLZF/kjKaFgcdM+fRppnahUFTGoZGem1OukFZ5vlKhp8ZwDPF8erxP4murjuDO2fOA1r6I1jGVgesnimkE0QQRx0aJAXy0vOpLCWD2FcKwr5agZDTieja42/KWGOGhykNry6cYotInPFd/ry31BVMVM5AVDLRYgaiBRMtZyBaMtH9lCJKe5FrxtJXy59PUYwSyT6PzQdQSwMEFAAACAgA0058WP1Nu/JDAQAAiQIAACMAAAB4bC93b3Jrc2hlZXRzL19yZWxzL3NoZWV0Mi54bWwucmVsc8WSS04DMQyGrzLKPpNH0+kE9bGBRRdsUC+QcZx26EwySlIoXI0FR+IKBBASSEiwY2n/9uffll+enpeb8zhUdxhTH/yKiJqTCj0E2/v9ipyyoy3ZrJc3OJhcKtKhn1JVWnxakUPO0wVjCQ44mlSHCX1RXIijySWMezYZOJo9Msl5w+JXBvnOrHYPE/6FGJzrAS8DnEb0+QcwOxRSHHp/JNXOxD3mD2wqXNd7M4CxNYTxU70Otgy+OmeMRSTV1q5I3NqWVOw/LQaP9B67Gk91Mt524Vx/dc/KIOP7x3cok0qKxUwBdUILquRsQQ3YlnYITooGjUHFphhuEXJirTOi0aCo1MAbKWbUgZRU8ZIySku6UILPNRdzsA172yyxMdjTgEyIhRPQKoqNtlQpqWlnnC4dyOfSzZF38Mth9fth2beHWr8CUEsDBBQAAAgIANNOfFhv/eqgSgEAANIFAAATAAAAW0NvbnRlbnRfVHlwZXNdLnhtbM2U204CMRCGX2XTW7NbQGOM4XCh3iqJvkDTzrIN20M6A8KzeeEj+QoOxaAhRIKQyE0n7cz8399D+vH23h8tXFvMIaENfiC6VUcU4HUw1k8GYkZ1eSNGw/7LMgIWXOpxIBqieCsl6gacwipE8JypQ3KKeJomMio9VROQvU7nWurgCTyVtNIQw/491GrWUvGw4OU1lttFcbeuW6EGQsXYWq2I03LuzRakDHVtNZigZ45bKowJlMEGgFxb5Vg5Zf1FFpY7mRGd0fEw7Ne+Kh0SlDFxNpEF/A2ToMW/Qbgz12Bj4zfiie8qWQPFWCV6VI71JJ/DmM2gZOXq2LOElXcDZtf+dsEXrcRGJTDPlPjR4NEGti/zh/ZeI7Rs4eQOsug+9GtI09yBMofuiV1s9A810jsXI5fnYuTqv4wQf5iwHo9/HllmQ5T5hx5+AlBLAQIUAxQAAAgIANNOfFhKIUMnYQEAAM8CAAAPAAAAAAAAAAAAAACkgQAAAAB4bC93b3JrYm9vay54bWxQSwECFAMUAAAICADTTnxYbQcfTZIBAACgBAAAEAAAAAAAAAAAAAAApIGOAQAAZG9jUHJvcHMvYXBwLnhtbFBLAQIUAxQAAAgIANNOfFiVZ04SnQMAABIOAAAUAAAAAAAAAAAAAACkgU4DAAB4bC9zaGFyZWRTdHJpbmdzLnhtbFBLAQIUAxQAAAgIANNOfFhbpZ2tlgQAANVNAAANAAAAAAAAAAAAAACkgR0HAAB4bC9zdHlsZXMueG1sUEsBAhQDFAAACAgA0058WDKwrVnCAwAA4g8AABgAAAAAAAAAAAAAAKSB3gsAAHhsL3dvcmtzaGVldHMvc2hlZXQxLnhtbFBLAQIUAxQAAAgIANNOfFg++MejHwUAAGAYAAAYAAAAAAAAAAAAAACkgdYPAAB4bC93b3Jrc2hlZXRzL3NoZWV0Mi54bWxQSwECFAMUAAAICADTTnxY6Y6GKHoDAADVDAAAGAAAAAAAAAAAAAAApIErFQAAeGwvd29ya3NoZWV0cy9zaGVldDMueG1sUEsBAhQDFAAACAgA0058WGWTqL8CAwAAMQkAABgAAAAAAAAAAAAAAKSB2xgAAHhsL3dvcmtzaGVldHMvc2hlZXQ0LnhtbFBLAQIUAxQAAAgIANNOfFhgTIezpgUAALgbAAATAAAAAAAAAAAAAACkgRMcAAB4bC90aGVtZS90aGVtZTEueG1sUEsBAhQDFAAACAAA0058WBEhjRLaAQAA2gEAAFEAAAAAAAAAAAAAAKSB6iEAAHBhY2thZ2Uvc2VydmljZXMvbWV0YWRhdGEvY29yZS1wcm9wZXJ0aWVzL2E4MDk4NWQ0YmM2ZTQ0MjU5ODQyYzdkMTkyMzAxZjQyLnBzbWRjcFBLAQIUAxQAAAgAANNOfFjZ366CnAIAAJwCAAALAAAAAAAAAAAAAACkgTMkAABfcmVscy8ucmVsc1BLAQIUAxQAAAgIANNOfFgBa6tV+AAAAHUEAAAaAAAAAAAAAAAAAACkgfgmAAB4bC9fcmVscy93b3JrYm9vay54bWwucmVsc1BLAQIUAxQAAAgIANNOfFj9TbvyQwEAAIkCAAAjAAAAAAAAAAAAAACkgSgoAAB4bC93b3Jrc2hlZXRzL19yZWxzL3NoZWV0Mi54bWwucmVsc1BLAQIUAxQAAAgIANNOfFhv/eqgSgEAANIFAAATAAAAAAAAAAAAAACkgawpAABbQ29udGVudF9UeXBlc10ueG1sUEsFBgAAAAAOAA4A4wMAACcrAAAAAA== content_type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/forms/{form_id}/form-instances/{form_instance_id}: get: operationId: formsGetFormAnswers summary: Get form answers description: "Based on a form ID and a form instance ID, we can access all the answers filled by users.\n\n Details\ \ \n\n project_Id \n the id of the project to be modified \n\n form_id \n id the the form template used by the form\ \ instance (look at get form detail to found it) \n\n form_instance_id \n id of the form instance to be checked" tags: - Forms parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: form_id in: path required: true schema: type: string description: Path variable `form_id` as published in the collection. - name: form_instance_id in: path required: true schema: type: string description: Path variable `form_instance_id` as published in the collection. - name: Accept-Language in: header required: false schema: type: string responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 668f333e-209a-41a0-bd5a-08cffd7e3a5e name: Test Luc Form parent_id: a353c628-ceea-487b-8117-8509f983ca6b version: 1 parts: - id: bde7bfde-4b46-412e-a865-41ac0364af32 form_template_id: 668f333e-209a-41a0-bd5a-08cffd7e3a5e name: part name num: 0 sections: - id: 562f12d3-b845-4263-b61d-eee50f009746 part_id: 00000000-0000-0000-0000-000000000000 name: section name num: 0 qr_code: false progress: 0 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/forms/{form_id}/messages: post: operationId: formsAddFormInstanceComment summary: Add form instance comment description: "You can add comments, link files, or link items to a form instance.\n\n Details \n\n project_id \n The\ \ ID of the project where the the form will be commented \n\n form_id \n The ID of the form instace \n\n Body optional\ \ infos \n Details \n\n for sending a comment \n\n text \n your text \n\n to attach a file or an image \n\n media_resource_id\ \ \n the id of a previously uploaded file via the upload media endpoint \n\n media_resource_name \n the display name\ \ of the file \n\n to link an observation \n\n reference_type \n \"Observation\" \n\n reference_id \n the id of the\ \ linked observation \n\n to link a form instance \n\n reference_type \n \"Form\" \n\n reference_id \n the id of the\ \ linked form instance" tags: - Forms parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: form_id in: path required: true schema: type: string description: Path variable `form_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: message_id: '531046467809312768' '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/forms/{form_instance_id}: get: operationId: formsGetFormDetails summary: Get form details description: "Based on a form instance ID, we can access its full properties.\n\n To go deeper, you will need to check\ \ user, plan, company info, and form answers based on the returned IDs.\n\n Details \n\n project_Id \n the id of the\ \ project to be modified \n\n form_instance_id \n the id of the form instance to be checked" tags: - Forms parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: form_instance_id in: path required: true schema: type: string description: Path variable `form_instance_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Get_form_details: value: id: bc6419a9-c5ca-42c5-8d5b-525634495ff6 enabled: true form_id: 9b2de0df-6504-48db-a923-b71d6553e48b project_id: 443aa663-aa766dc1-b82c-46d2-b2fc-05c327e688b7 description: ess in categ template_name: Test link item status: id: 335ca72f-11cc-417b-8811-37a7569e57c8 color: '#EBBB1C' name: To do priority: id: f160d63c-5531-41d3-a80a-678a3026f6e7 color: '#49CB0C' icon: ChevronDown name: Low module_id: 117f1c84-e69d-4429-baf9-74e052f5e0bc category_id: 594f4f7c-6f7a-410b-bb5e-5aa6ef488a9c created_at: '2024-02-22T14:50:24.775757Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-02-22T14:50:24.775757Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' put: operationId: formsUpdateForm summary: Update form description: "You now have the possibility to update form details via the API.\n\n If you don't include information\ \ for an optional detail in the endpoint, the existing value will be kept.\n\n Endpoint mandatory info \n Details\ \ \n\n project_id \n The ID of the project where the form will be created \n\n form_instance_id \n The ID of the form\ \ instance \n\n body optional info \n Details \n\n name \n The name you want to be assigned to the form \n\n priority_id\ \ \n The ID of the priority the form will be assigned \n\n status_id \n The ID of the status used for the form. If\ \ not set the default one will be used \n\n assignee_id \n The user ID of the person that will be assigned to the\ \ form \n\n company_id \n The ID of the company that will be assigned to the form \n\n phase_id \n The ID of the phase\ \ that is set for the form \n\n plan_id \n The ID of the plan that will be used for the form \n\n position_x \n X\ \ coordinate of the item regarding the affected 2D plan \n\n position_y \n Y coordinate of the item regarding the\ \ affected 2D plan \n\n due_date \n The date the form is due, set as a timestamp \n\n latitude \n in decimal degres\ \ following ISO6709 \n\n longitude \n in decimal degres \nfollowing ISO6709" tags: - Forms parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: form_instance_id in: path required: true schema: type: string description: Path variable `form_instance_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 67fea526-ed18-4f31-9a85-62b94eaec617 name: Test update 2 form_id: 482de6de-f53e-4c7b-bb12-b00624b4e26d status_id: 3eac1151-9f39-4618-86ef-33ddbb76dfa6 priority_id: b7384959-ef65-4e5d-8cf1-94bc0c3f5b7b position_x: 0.5 position_y: 0.5 client_created_at: '2023-03-13T13:15:25.045198Z' client_updated_at: '2023-03-14T07:58:38.3211502Z' module_id: 1e870757-f1df-452f-a86c-d4115c10bf43 phase_id: 2b71c5fd-ae17-49a7-8cdd-658e280e012d created_at: '2023-03-13T13:15:28.687231Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-03-14T07:58:45.3896935Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/forms/{form_instance_id}/messages: get: operationId: formsGetFormInstanceMessages summary: Get form instance messages description: "Based on a form instance ID, we can access its activity history.\n\n Details \n\n project_id \n The ID\ \ of the project where the the observation will be created \n\n form_id \n The ID of the form instance \n\n Query\ \ optional infos \n Details \n\n message_id \n id of a message to begin the reading \n\n get_newest \n if true, get\ \ the messages newest as the message_id \nfalse is the default value" tags: - Forms parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: form_instance_id in: path required: true schema: type: string description: Path variable `form_instance_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: messages: - message_id: '531045308637904896' channel_type: Form content_type: Content created_at: '2024-01-05T09:44:27.9246649Z' client_created_at: '2024-01-05T09:44:27.046Z' message: text: value: Test 1 - message_id: '531045309233496064' channel_type: Form content_type: Content created_at: '2024-01-05T09:44:28.067104Z' client_created_at: '2024-01-05T09:44:27.262Z' message: text: value: Test 2 - message_id: '531046467809312768' channel_type: Form content_type: Content created_at: '2024-01-05T09:49:04.292853Z' client_created_at: '2024-01-05T09:49:04.2608409Z' message: references: - type: Form id: 3e9ae473-fbda-4fb5-9f1b-83028e8b6a34 count: 3 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/formsforms: get: operationId: projectLibrariesGetProjectFormTemplates summary: Get project form templates description: "For a given project you can list all the available form templates for a module and a category\n\n Endpoint\ \ mandatory infos \n Details \n\n projectId \n the id of the project to be modified \n\n Query mandatory params \n\ \n module_id \n id of the module checked \n\n Query optionals params \n\n category_id \n id of the category of the\ \ module checked" tags: - Project libraries parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: forms: - id: dd51ccda-0f53-444d-b9f5-45252c37ca37 name: Form template 1 enabled: true version: 3 module_id: 117f1c84-e69d-4429-baf9-74e052f5e0bc category_id: 594f4f7c-6f7a-410b-bb5e-5aa6ef488a9c created_at: '2023-12-05T12:44:53.12674Z' updated_at: '2023-12-05T12:44:53.12674Z' - id: 0f5d26f7-523e-4453-b61c-0fd8d59f008a name: Form template 2 enabled: true version: 2 module_id: 117f1c84-e69d-4429-baf9-74e052f5e0bc category_id: 594f4f7c-6f7a-410b-bb5e-5aa6ef488a9c created_at: '2023-12-05T08:31:10.713542Z' updated_at: '2023-12-05T08:31:10.713542Z' - id: cf9d18bd-d473-400a-909a-e48ea0eb1404 name: Form template 3 enabled: true version: 1 module_id: 117f1c84-e69d-4429-baf9-74e052f5e0bc created_at: '2024-04-03T14:41:29.800809Z' updated_at: '2024-04-03T14:41:29.800809Z' - id: 40accad9-12c5-46da-aa2c-ad6c59972d81 name: Form template 4 enabled: true version: 1 module_id: 117f1c84-e69d-4429-baf9-74e052f5e0bc created_at: '2023-12-12T12:53:00.393272Z' updated_at: '2023-12-12T12:53:00.393272Z' - id: 869701f4-9ebb-4640-bffe-a676361350f7 name: Form template 5 enabled: true version: 1 module_id: 117f1c84-e69d-4429-baf9-74e052f5e0bc created_at: '2023-12-05T13:16:24.599323Z' updated_at: '2023-12-05T13:16:24.599323Z' count: 5 Success_by_category: value: forms: - id: dd51ccda-0f53-444d-b9f5-45252c37ca37 name: Form template 1 enabled: true version: 3 module_id: 117f1c84-e69d-4429-baf9-74e052f5e0bc category_id: 594f4f7c-6f7a-410b-bb5e-5aa6ef488a9c created_at: '2023-12-05T12:44:53.12674Z' updated_at: '2023-12-05T12:44:53.12674Z' - id: 537d7408-9330-4eb9-b90e-6092836a35e9 name: Form template 2 enabled: true version: 3 module_id: 117f1c84-e69d-4429-baf9-74e052f5e0bc category_id: 594f4f7c-6f7a-410b-bb5e-5aa6ef488a9c created_at: '2025-02-11T09:55:38.400067Z' updated_at: '2025-02-11T09:55:38.400067Z' - id: 1aa8afc4-3106-446b-a471-55fc413d9867 name: Form template 3 enabled: true version: 1 module_id: 117f1c84-e69d-4429-baf9-74e052f5e0bc category_id: 594f4f7c-6f7a-410b-bb5e-5aa6ef488a9c created_at: '2023-12-12T09:31:32.112705Z' updated_at: '2023-12-12T09:31:32.112705Z' count: 3 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/groups: post: operationId: discussionGroupsCreateDiscussionGroups summary: Create discussion groups description: "To create a group, you need to name it and select project members. You can give access to the group members\ \ to specific plans added to the project.\n\n In the current version, we are only sharing plans in groups and not\ \ folders. Shared folders won't be visible in apps.\n\n Endpoint mandatory infos \n Details \n\n project_Id \n the\ \ id of the project to be modified \n\n body mandatory infos \n Details \n\n name \n name of the group \n\n user_ids\ \ \n list of users ids to be added to the group \n\n plan_ids \n list of the plans ids to be shared in the group" tags: - Discussion groups parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: groups: - name: user_ids: - plan_ids: - responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: groups: - id: 4722102a-89ce-49d9-982c-662a071a75b4 name: My group group_members: - id: 8d42b732-e166-4688-9361-a96f147c783d user_id: 4168852f-721d4983-6b44-4525-abae-ac166afc1707 - id: 90c22f0c-b536-4f34-9f17-e19f37906421 user_id: 36d2cc81-cea5ea12-ba79-410b-a7d7-945cf2c2cc66 group_plans: - id: 1084a4ca-ef2f-4d71-ac0e-df0194c3422b '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' get: operationId: discussionGroupsGetDiscussionGroups summary: Get discussion groups description: "You can get the list of all discussion groups in a project.\n\n Details \n\n project_Id \n the id of the\ \ project to be modified \n\n body mandatory infos \n Details \n\n search_term \n filter term on group name" tags: - Discussion groups parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: groups: - id: 598e5dbf-a6ab-4b5e-90d0-9814f4d52bc8 name: Grp 1 C - id: 5a7ba4be-088d-488f-8de2-9d39b83ed5c3 name: Team count: 2 total_count: 2 limit: 50 offset: 0 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/groups/item: get: operationId: discussionGroupsGetDiscussionGroupsForAnItem summary: Get discussion groups for an item description: "You can find out in which discussion groups an item is shared.\n\n Details \n\n project_id \n The ID of\ \ the project where the the observation will be commented \n\n Query mandatory infos \n Details \n\n item_id \n id\ \ of the item \n\n item_type \n type of the item \ncan be Observation, Form, Plan, Folder, or Document" tags: - Discussion groups parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: shared_item_groups: - group_id: 18079031-0673-4e4c-8585-d73044d7ef16 name: G2 members_count: 1 count: 1 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/groups/{group_id}: get: operationId: discussionGroupsGetDiscussionGroup summary: Get discussion group description: "You can get the details of a discussion group.\n\n Endpoint mandatory infos \n Details \n\n project_Id\ \ \n the id of the project to be modified \n\n group_id \n the id of the grou^p" tags: - Discussion groups parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: group_id in: path required: true schema: type: string description: Path variable `group_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 5a7ba4be-088d-488f-8de2-9d39b83ed5c3 name: Team description: Default group is_default: true members_ids: - 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - 8f0eebde-0fa7f000-f573-4054-b1a6-b92b002a513e created_at: '2024-04-08T12:51:30.995153Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-04-09T08:09:37.095928Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' put: operationId: discussionGroupsUpdateDiscussionGroup summary: Update discussion group description: "To create a discussion group, you need to name it and select project members.\n\n You can give access\ \ to the discussion group members to specific plans added to the project. In the current version, we are only sharing\ \ plans in groups and not folders.\n\n Shared folders won't be visible in apps.\n\n Endpoint mandatory infos \n Details\ \ \n\n project_Id \n the id of the project to be modified \n\n group_id \n Id of the modified group \n\n body mandatory\ \ infos \n Details \n\n name \n new name of the group" tags: - Discussion groups parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: group_id in: path required: true schema: type: string description: Path variable `group_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: name: Grp 1 C responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 598e5dbf-a6ab-4b5e-90d0-9814f4d52bc8 name: Grp 1 C is_default: false members_ids: - 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - 8f0eebde-0fa7f000-f573-4054-b1a6-b92b002a513e created_at: '2024-04-08T13:17:42.46137Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-04-10T14:00:57.3847089Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/groups/{group_id}/add_members: post: operationId: discussionGroupsAddMembersToDiscussionGroup summary: Add members to discussion group description: "You can add members to a discussion group.\n\n Details \n\n project_Id \n the id of the project to be\ \ modified \n\n group_id \n Id the the modified group \n\n body mandatory infos \n Details \n\n user_ids \n list of\ \ users ids to be added to the group" tags: - Discussion groups parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: group_id in: path required: true schema: type: string description: Path variable `group_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: user_ids: - 13e8af9d-3d5175fe-90ce-444e-8cc2-0da4e19e3cce - a2159af5-4144345e-8c2e-4eb5-89b4-5b43a955d10c responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: group_members: - id: 43e0f0c8-afa4-403c-9a4a-f8060ae019c4 user_id: 13e8af9d-3d5175fe-90ce-444e-8cc2-0da4e19e3cce - id: 95ca5318-7dc7-48f4-9f14-32599f472e06 user_id: a2159af5-4144345e-8c2e-4eb5-89b4-5b43a955d10c '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/groups/{group_id}/messages: post: operationId: discussionGroupsAddDiscussionGroupMessage summary: Add discussion group message description: "You can add messages or link files or items to a discussion group.\n\n Details \n\n project_id \n The\ \ ID of the project where the the observation will be commented \n\n group_id \n The ID of the group \n\n Body optional\ \ infos \n Details \n\n for sending a comment \n\n text \n your text \n\n to attach a file or an image \n\n media_resource_id\ \ \n the id of a previously uploaded file via the upload media endpoint \n\n media_resource_name \n the display name\ \ of the file \n\n to link an observation \n\n reference_type \n \"Observation\" \n\n reference_id \n the id of the\ \ linked observation \n\n to link a form instance \n\n reference_type \n \"Form\" \n\n reference_id \n the id of the\ \ linked form instance \n\n to link a document \n\n reference_type \n \"Document\" \n\n reference_id \n the id of\ \ the document" tags: - Discussion groups parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: group_id in: path required: true schema: type: string description: Path variable `group_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object responses: '200': description: Success '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' get: operationId: discussionGroupsGetDiscussionGroupMessages summary: Get discussion group messages description: "Based on a discussion group ID, you can access its activity history.\n\n Details \n\n project_id \n The\ \ ID of the project where the the observation will be created \n\n group_id \n The ID of the group \n\n Query optional\ \ infos \n Details \n\n message_id \n id of a message to begin the reading" tags: - Discussion groups parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: group_id in: path required: true schema: type: string description: Path variable `group_id` as published in the collection. responses: '200': description: Success '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/groups/{group_id}/remove_members: post: operationId: discussionGroupsRemoveMembersToDiscussionGroup summary: Remove members to discussion group description: "You can remove members from a discussion group.\n\n Details \n\n project_Id \n the id of the project to\ \ be modified \n\n group_id \n Id the the modified group \n\n body mandatory infos \n Details \n\n user_ids \n list\ \ of users ids to be removed in the group" tags: - Discussion groups parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: group_id in: path required: true schema: type: string description: Path variable `group_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: user_ids: - a2159af5-4144345e-8c2e-4eb5-89b4-5b43a955d10c responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: group_members: - id: 95ca5318-7dc7-48f4-9f14-32599f472e06 user_id: a2159af5-4144345e-8c2e-4eb5-89b4-5b43a955d10c '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/logos: post: operationId: projectDetailsAddProjectLogo summary: Add project logo description: "You can add a logo to a project.\n\n Endpoint mandatory info \n Details \n\n project_id \n The ID of the\ \ project where the form will be created \n\n body mandatory infos \n Details \n\n media_id \n id of the previuosly\ \ uploaded image \n\n media_name \n display name of the logo" tags: - Project details parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: media_id: media_name: my logo responses: '200': description: OK content: application/json: schema: type: object examples: Add: value: url: https://api.eu.sandbox.finalcad.cloud/medias/c1eeb43a-1dd7-4d82-8c07-2fe188bd6c43 id: c1eeb43a-1dd7-4d82-8c07-2fe188bd6c43 file_name: LogoTest.png display_name: my logo mime_type: image/png created_at: '2024-04-23T13:17:06.8316631Z' '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' delete: operationId: projectDetailsRemoveProjectLogos summary: Remove project logos description: "You can remove a logo from a project.\n\n Details \n\n project_id \n The ID of the project where the form\ \ will be created \n\n body mandatory info \n Details \n\n logo_ids \n list of the logo ids to be removed" tags: - Project details parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: logo_ids: - '{{logo_id}}' responses: '204': description: No Content '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' get: operationId: projectDetailsGetProjectLogos summary: Get project logos description: "You can get the list of project logos.\n\n Endpoint mandatory info \n Details \n\n project_id \n The ID\ \ of the project where the form will be created" tags: - Project details parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Get: value: logos: - url: https://api.eu.sandbox.finalcad.cloud/medias/164030f0-6b4d-464c-a1c7-ccc7d3330d5a id: 164030f0-6b4d-464c-a1c7-ccc7d3330d5a file_name: LogoSpider.png display_name: LogoSpider.png mime_type: image/png created_at: '2024-03-26T15:01:44.216581Z' - url: https://api.eu.sandbox.finalcad.cloud/medias/2c20ad00-8654-4a22-81fc-38a5422a0588 id: 2c20ad00-8654-4a22-81fc-38a5422a0588 file_name: LogoClient.png display_name: LogoClient.png mime_type: image/png created_at: '2024-03-26T15:01:48.927053Z' - url: https://api.eu.sandbox.finalcad.cloud/medias/37230665-0042-4e18-a3a8-3c32e3d90131 id: 37230665-0042-4e18-a3a8-3c32e3d90131 file_name: LogoTest.png display_name: my logo mime_type: image/png created_at: '2024-04-23T13:08:54.265648Z' - url: https://api.eu.sandbox.finalcad.cloud/medias/d03df0f0-e7a2-42a2-bbf5-06a1083f022b id: d03df0f0-e7a2-42a2-bbf5-06a1083f022b file_name: LogoTest.png display_name: my logo mime_type: image/png created_at: '2024-04-23T13:10:06.69979Z' count: 4 total_count: 4 limit: 500 offset: 0 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/medias/uploadinit: post: operationId: mediasHandelingChunkUploadInit summary: Init description: "OBSOLETE - Please use the media endpoints at the application level. \n\n Initialize the chunk upload process\ \ by using the init endpoint.\n\n Endpoint mandatory infos \n Details \n\n project_Id \n the id of the project to\ \ be modified \n\n body mandatory infos \n Details \n\n file_name \n name of the madia \n\n total_bytes \n total size\ \ in bytes of the media \n\n md5 \n md5 of the media \n\n returned infos \n Details \n\n chunk_id \n id of the chunk\ \ \n\n media_id \n id of the new media" tags: - Medias handeling parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: file_name: lang1.png total_bytes: 445721 md5: 55ed5b904a472b4d576f20caaef21c24 responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: expires_after_secs: 3600 chunk_id: cc1aca15-a9f2-41b2-8968-c3905545b376 media_id: 03457d15-6ee1-4860-ba24-f554bf595962 min_chunk_size: 5242880 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/medias/uploads: post: operationId: mediasHandelingUploadMedias summary: Upload medias description: "OBSOLETE – Please use the media endpoints at the application level. \n\n For media files ≤ 5 MB, use the\ \ standard upload endpoint\n\n For media files > 5 MB, use the chunked upload process\n\n Endpoint mandatory infos\ \ \n Details \n\n project_Id \n the id of the project to be modified \n\n form_data mandatory infos \n Details \n\n\ \ media \n stream of the media \n\n returned infos \n Details \n\n id \n id of the newly created media \n\n file_name\ \ \n filename of the media \n\n mime_type \n mime type of the media" tags: - Medias handeling parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: multipart/form-data: schema: type: object properties: media: type: string responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 3019742b-8567-413b-8c40-af46acb58d2c file_name: Small r+1 A.dwg mime_type: application/dwg '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/medias/{media_id}/uploadabort: post: operationId: mediasHandelingChunkUploadAbort summary: Abort description: "OBSOLETE – Please use the media endpoints at the application level. \n Abort the chunk upload process.\n\ \n Endpoint mandatory infos \n Details \n\n project_Id \n the id of the project to be modified \n\n media_id \n id\ \ of the media in progress \n\n body mandatory infos \n Details \n\n chunk_id \n id of the chunk in proress" tags: - Medias handeling parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: media_id in: path required: true schema: type: string description: Path variable `media_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: chunk_id: '{{chunk_id}}' responses: '204': description: No Content '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/medias/{media_id}/uploadappend: post: operationId: mediasHandelingChunkUploadUpload summary: Upload description: "OBSOLETE - Please use the media endpoints at the application level. \n\n Upload a file part during the\ \ chunk upload process by using the upload endpoint.\n\n Endpoint mandatory infos \n Details \n\n project_Id \n the\ \ id of the project to be modified \n\n media_id \n id of the media in progress \n\n form-data mandatory infos \n\ \ Details \n\n chunk_id \n chunk id of the media in progress \n\n segment_index \n number of the chunk segment (first\ \ is 1) \n\n last_chunk \n true if it is the last chunk \n\n stream \n chunk content \n\n md5 \n md5 of the stream" tags: - Medias handeling parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: media_id in: path required: true schema: type: string description: Path variable `media_id` as published in the collection. requestBody: required: true content: multipart/form-data: schema: type: object properties: chunk_id: type: string description: chunk id returned by init function segment_index: type: string description: chunk segment number first = 1 last_chunk: type: string description: is it the last segment ? stream: type: string md5: type: string responses: '204': description: No Content '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/medias/{media_id}/uploadterminate: post: operationId: mediasHandelingChunkUploadTerminate summary: Terminate description: "OBSOLETE - Please use the media endpoints at the application level. \n\n Validate the chunk upload process\ \ by using the terminate endpoint.\n\n Endpoint mandatory infos \n Details \n\n project_Id \n the id of the project\ \ to be modified \n\n media_id \n id of the media in progress \n\n body mandatory infos \n Details \n\n chunk_id \n\ \ id of the chunk in progress" tags: - Medias handeling parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: media_id in: path required: true schema: type: string description: Path variable `media_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: chunk_id: '{{chunk_id}}' responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 3a9d8d0b-0b53-4d24-b786-3b6a53aab795 file_name: lang1.png mime_type: image/png '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/meetings: get: operationId: meetingsGetMeetings summary: Get meetings description: "Get the list of meetings for a given project.\n\n Details \n\n project_Id \n the id of the project to\ \ be modified \n\n Query params optionals \n\n see Commmon behaviors / differential" tags: - Meetings parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: meetings: - id: ed0c4147-c6b5-49e8-acc8-4c23a1368dc2 description: meet1 meeting_start_date: '2024-05-30T13:22:55Z' meeting_end_date: '2024-05-30T15:22:55Z' client_created_at: '2024-05-29T07:23:27.772Z' client_updated_at: '2024-05-29T07:23:27.772Z' created_at: '2024-05-29T07:23:28.087017Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-29T07:23:28.087017Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 83ae1a12-809f-4bbd-92fd-91c516ec9d13 description: meet1 meeting_start_date: '2024-05-30T13:22:55Z' meeting_end_date: '2024-05-30T15:22:55Z' client_created_at: '2024-05-29T07:23:48.21Z' client_updated_at: '2024-05-29T07:23:48.21Z' created_at: '2024-05-29T07:23:48.519077Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-29T07:23:48.519077Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a need_to_relaunch: true continuous_token: 0|2 count: 2 total_count: 5 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/meetings/{meeting_id}: get: operationId: meetingsGetMeetingDetails summary: Get meeting details description: "Get the details of a specific meeting for a given project.\n\n Details \n\n project_Id \n the id of the\ \ project to be modified \n\n meeting_id \n id of the meeting" tags: - Meetings parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: meeting_id in: path required: true schema: type: string description: Path variable `meeting_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 336a8f8e-17b9-4d94-8a81-33a85861888f description: Reu 1 meeting_start_date: '2023-04-05T07:51:19.4Z' meeting_end_date: '2023-04-05T09:51:19.4Z' client_created_at: '2023-04-05T07:51:29.24Z' client_updated_at: '2023-04-05T07:52:36.470651Z' export_status: Success export_media_resource: id: 3e56a79d-81e2-46af-9f7e-5606d279319a file_name: TestFormsAnswer-Reu1-2023-04-05-09-52-23-568 mime_type: application/pdf created_at: '2023-04-05T07:52:36.473358Z' created_at: '2023-04-05T07:51:29.571677Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-04-05T07:52:36.475478Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/members: get: operationId: projectMembersManagementGetMembers summary: Get members description: "Before adding members to your project, you might want to have an overview of the current project users\ \ and their roles.\n\n Endpoint mandatory infos \n Details \n\n projectId \n the id of the project to be modified\ \ \n\n Query params optionals \n\n see Commmon behaviors / differential" tags: - Project members management parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: project_members: - user_id: 8f0eebde-0fa7f000-f573-4054-b1a6-b92b002a513e first_name: Mathieu last_name: Bourgois email: person-c@example.com project_role_id: a5403a10-6cf2-4a1f-84d1-c772f63594c7 enabled: true created_at: '2024-05-22T11:54:15.928262Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-22T11:54:15.928262Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - user_id: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a first_name: Luc last_name: Vallot email: person.redacted+sandbox@example.com project_role_id: 041391c6-cb0a-4157-bb5e-fc3469ea9c69 picture: id: 737a4362-0371-4742-9b58-ffe4d4d2e768 file_name: logo.png mime_type: image/png created_at: '2023-07-26T13:24:40.672379Z' enabled: true created_at: '2024-05-22T09:26:29.576287Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-22T09:26:29.576287Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a need_to_relaunch: true continuous_token: CT:Unknown-0-2 count: 2 total_count: 6 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' post: operationId: projectMembersManagementAddMembersToAProject summary: Add members to a project description: "To ease this step, you can directly add a list of members. Your invitations can fall into two cases:\n\ \n The email is already linked to a Finalcad One account. The member will be directly added to the project and receive\ \ a notification\n\n The email is not linked to a Finalcad One account. The member will be invited to create an account\ \ by email. Meanwhile, the invitations will be visible as pending in the project member list\n\n To invite a member\ \ to your project, an email needs to be associated with a project role. See Get project roles .\n\n Endpoint mandatory\ \ infos \n Details \n\n projectId \n the id of the project to be modified \n\n Endpoint optional query infos \n Details\ \ \n\n doNotSendEmail \n if true, no email are send to the final user \n\n body mandatory infos \n Details \n\n email\ \ \n the email of the newly member \n\n project_role_id \n the id of the role od the user" tags: - Project members management parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: invitations: - email: project_role_id: responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: project_roles: - user_ids: - 45783245-d958fc8e-f176-4197-8bf6-075517ac8778 id: 233984d5-4c7d-49c2-9022-ff72a4ec06a2 names: - language: en translation: Project editor - user_ids: - 35409434-f3329bd6-53fa-4152-bc2e-cde8dfaff364 id: 2343dc76-8b0e-43a6-89e1-f6902a623507 names: - language: en translation: Limited group editor '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/modules: post: operationId: modulesObservationsCreateObservationModule summary: Create observation module description: "You can create a custom observation module in a specific project.\n\n Endpoint mandatory infos \n Details\ \ \n\n project_Id \n the id of the project to be modified \n\n body mandatory infos \n details \n\n name \n name of\ \ the new module \n\n icon \n name of the icon \n(look at finalcad libraries) \n\n color \n rbg value of the color\ \ \n(look at finalcad libraries) \n\n body optional infos \n \n Details \n\n settings \n\n is_observation_library_mandatory\ \ \n activate or not the trade choice \n(default is false) \n\n is_description_mandatory \n activate or not the description\ \ input \n(default is true) \n\n is_photo_mandatory \n activate or not the photo selection (mobile only) (default\ \ is true) \n\n is_company_mandatory \n activate or not the company choice (mobile only)(default is true) \n\n is_group_mandatory\ \ \n activate or not the group link choice (default is false) \n\n is_observation_library_enabled \n OBSOLETE activate\ \ or not the trade choice \n(default is false) \n\n is_description_enabled \n OBSOLETE activate or not the description\ \ input \n(default is true) \n\n is_photo_enabled \n OBSOLETE activate or not the photo selection (mobile only) (default\ \ is true) \n\n is_company_enabled \n OBSOLETE activate or not the company choice (mobile only)(default is true)" tags: - Modules parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: name: Test module obs icon: color: settings: is_observation_library_mandatory: false is_description_mandatory: true is_photo_mandatory: true is_company_mandatory: true is_group_mandatory: true responses: '200': description: OK content: application/json: schema: type: object examples: Success_observation: value: id: ef04d901-34aa-4aeb-b9d1-6bcf850553e4 project_id: 9c898871-b8d2ebe5-10ab-4b42-96b7-056f114b7fd3 name: Paradigm order: 3072 icon: alert color: '#E94F3D' type: Observations names: - language: en translation: Paradigm created_at: '2023-09-25T13:46:56.9518476Z' updated_at: '2023-09-25T13:46:56.9518476Z' enabled: true settings: is_observation_library_mandatory: false is_description_mandatory: true is_photo_mandatory: true is_company_mandatory: true is_group_mandatory: true '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' get: operationId: modulesObservationsGetObservationModules summary: Get observation modules description: "For a given project, get the list of all existing observations modules.\n\n Endpoint mandatory info \n\ \ Details \n\n project_id \n The ID of the project where the form has been created \n\n Query params optionals \n\n\ \ see Commmon behaviors / differential" tags: - Modules parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Get_Modules_Observations: value: modules: - id: fcef77d8-21a9-4594-9bf7-6b06679fe1bb project_id: 45d2b228-25681789-2dbe-42d7-8310-491ab3ab360f name: Observations order: 1024 icon: alert color: '#E94F3D' type: Observations names: - language: en translation: Observations - language: fr translation: Observations - language: es translation: Observaciones created_at: '2024-05-22T09:26:29.808Z' updated_at: '2024-05-22T09:26:29.808Z' enabled: true settings: is_observation_library_mandatory: false is_description_mandatory: true is_photo_mandatory: true is_company_mandatory: true is_group_mandatory: false need_to_relaunch: true continuous_token: 0|NDN8MHxNb2R1bGUjZDg1YTVmYTctMjAzNC00N2NhLTk4N2EtYWViNmZkMmJjNGNhNHwyfEdTSTE1M3wzfFByb2plY3QjNDVkMmIyMjgtMjU2ODE3ODktMmRiZS00MmQ3LTgzMTAtNDkxYWIzYWIzNjBmMjR8NHwyMDI0LTA1LTIyVDA5OjI2OjI5LjgwOFo= count: 1 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/modules/forms-suggestion: post: operationId: modulesFormsCreateFormModuleBySuggestion summary: Create form module by suggestion description: "You can create a module using a standard form description (named a suggestion).\n\n The suggestions can\ \ be found in the \"Get modules suggestions\" at the organization or workspace level, depending on your use case.\n\ \n Endpoint mandatory infos \n Details \n\n project_Id \n the id of the project to be modified \n\n body mandatory\ \ infos \n Details \n\n from_module_id \n ID the the suggestion to be used as template" tags: - Modules parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: from_module_id: responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 99e78c6b-2095-4500-9e42-ae97ea0ab63f name: ddddd order: 0 icon: typePin color: '#E94F3D' type: Forms created_at: '2023-09-20T13:43:34.229153Z' updated_at: '2023-09-20T13:44:55.190924Z' enabled: false '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/modules/meetings: post: operationId: modulesMeetingsEnableMeetingModule summary: Enable meeting module description: "You can enable or disable the meeting module for a specific project.\n\n If the meeting module is already\ \ enabled, it will be returned without any modifications.\n\n Endpoint mandatory infos \n Details \n\n project_Id\ \ \n the id of the project to be modified \n\n body mandatory infos \n details \n\n enabled \n enable or disable the\ \ module" tags: - Modules parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: enabled: true responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 07310b5f-4eea-4383-a5fa-ea9911b0951e project_id: 4bae44b3-935aabbb-127e-44e3-ba5d-1cfea984bf68 name: Meetings order: 1024 icon: meetings color: '#4CABF2' type: Meetings names: - language: en translation: Meetings - language: fr translation: Réunions - language: es translation: Reuniónes created_at: '2023-10-23T13:28:51.493Z' updated_at: '2023-10-23T13:29:02.9671594Z' enabled: true '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/modules/meetings/{module_id}: get: operationId: modulesMeetingsGetMeetingModule summary: Get meeting module description: "You can obtain information about a specific meeting module.\n\n The meeting module ID can be retrieved\ \ from the \"Enable module meeting\" endpoint.\n\n Endpoint mandatory infos \n Details \n\n project_Id \n the id of\ \ the project to be checked \n\n module_id \n the id of the module to be checked" tags: - Modules parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: module_id in: path required: true schema: type: string description: Path variable `module_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 07310b5f-4eea-4383-a5fa-ea9911b0951e project_id: 4bae44b3-935aabbb-127e-44e3-ba5d-1cfea984bf68 name: Meetings order: 1024 icon: meetings color: '#4CABF2' type: Meetings names: - language: en translation: Meetings - language: fr translation: Réunions - language: es translation: Reuniónes created_at: '2023-10-23T13:28:51.493Z' updated_at: '2023-10-23T13:29:02.967Z' enabled: true '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' put: operationId: modulesMeetingsUpdateMeetingModule summary: Update meeting module description: "You can modify a specific meeting module within a particular project. The meeting module ID can be retrieved\ \ from the \"Enable module meeting\" endpoint.\n\n Endpoint mandatory infos \n Details \n\n project_Id \n the id of\ \ the project to be modified \n\n module_id \n the id of the module to be modified \n\n body optional infos \n Details\ \ \n\n name \n new name of the module \n\n icon \n name of the icon \n\n color \n rbg value of the color \n\n order\ \ \n position order \n\n enabled \n enable or disable the module" tags: - Modules parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: module_id in: path required: true schema: type: string description: Path variable `module_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: name: responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 07310b5f-4eea-4383-a5fa-ea9911b0951e project_id: 4bae44b3-935aabbb-127e-44e3-ba5d-1cfea984bf68 name: forecast order: 1024 icon: meetings color: '#4CABF2' type: Meetings names: - language: en translation: forecast - language: fr translation: Réunions - language: es translation: Reuniónes created_at: '2023-10-23T13:28:51.493Z' updated_at: '2023-10-23T14:30:01.2524987Z' enabled: true '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/modules/suggestion: post: operationId: modulesObservationsCreateObservationModuleBasedOnSuggestions summary: Create observation module based on suggestions description: "You can create an observation module using a standard description (referred to as a suggestion).\n\n These\ \ suggestions can be obtained from the module suggestions available at the organization or workspace level, depending\ \ on your use case.\n\n Endpoint mandatory infos \n Details \n\n project_Id \n the id of the project to be modified\ \ \n\n body mandatory infos \n Details \n\n from_module_id \n ID the the suggestion to be used as template" tags: - Modules parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: from_module_id: responses: '200': description: Success '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/modules/{moduleId}: put: operationId: modulesObservationsModifyObservationModule summary: Modify observation module description: "You can modify a specific module in a specific project.\n\n Details \n\n project_Id \n the id of the project\ \ to be modified \n\n module_id \n the id of the module to be modified \n\n body optional infos \n Details \n\n name\ \ \n new name of the module \n\n icon \n name of the icon \n\n color \n rbg value of the color \n\n order \n position\ \ order \n\n enabled \n enable or disable the module \n\n settings \n please look at create module observation documentation" tags: - Modules parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: moduleId in: path required: true schema: type: string description: Path variable `moduleId` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: enabled: true settings: is_photo_mandatory: false is_group_mandatory: false responses: '200': description: Success '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' get: operationId: modulesObservationsGetObservationModule summary: Get observation module description: "You can get information about one module.\n\n Details \n\n project_Id \n the id of the project to be checked\ \ \n\n module_id \n the id of the module to be checked" tags: - Modules parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: moduleId in: path required: true schema: type: string description: Path variable `moduleId` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Get_Module_Observation: value: id: 18e9ea1a-e576-471f-ad8d-702ef394849c project_id: ab3852d3-5fffdcbf-6c71-46d9-ab80-1910ba4336ec name: Quality order: 4096 icon: star color: '#01D194' type: Observations names: - language: en translation: Quality - language: fr translation: Qualité - language: es translation: Calidad created_at: '2023-09-26T07:11:06.707Z' updated_at: '2023-09-26T07:11:06.707Z' enabled: true settings: is_observation_library_mandatory: false is_description_mandatory: true is_photo_mandatory: true is_company_mandatory: true is_group_mandatory: true '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/observations: get: operationId: observationsGetProjectObservationsList summary: Get project observations list description: "For a given project, you can list all the existing observations by IDs.\n\n Details \n\n project_id \n\ \ The ID of the project where the the observation will be created \n\n Query params optionals \n\n see Commmon behaviors\ \ / differential" tags: - Observations parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: observations: - observation_id: a59598d2-9a93-408d-b592-3e15b3dda236 module_id: fcef77d8-21a9-4594-9bf7-6b06679fe1bb enabled: true name: aaaaaaaaaa status_id: a7462d5b-a0ab-4fb0-a984-54ba62a9f02e priority_id: 62df924d-a39f-4817-8f96-89a6a5aa7e0e client_created_at: '2024-05-22T12:45:12.656Z' client_updated_at: '2024-05-22T12:45:12.656Z' created_at: '2024-05-22T12:45:13.209756Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-22T12:45:13.209756Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - observation_id: b36db168-f842-4708-8748-cbd92dcce9bb module_id: fcef77d8-21a9-4594-9bf7-6b06679fe1bb enabled: true name: bbbbbbbbbbb status_id: a7462d5b-a0ab-4fb0-a984-54ba62a9f02e priority_id: 62df924d-a39f-4817-8f96-89a6a5aa7e0e client_created_at: '2024-05-22T12:45:21.569Z' client_updated_at: '2024-05-22T12:45:21.569Z' created_at: '2024-05-22T12:45:21.577982Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-22T12:45:21.577982Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - observation_id: a39ad104-431e-4cd7-9ce4-d34fbb616bea module_id: fcef77d8-21a9-4594-9bf7-6b06679fe1bb enabled: true name: ccccccccccccccc status_id: a7462d5b-a0ab-4fb0-a984-54ba62a9f02e priority_id: 62df924d-a39f-4817-8f96-89a6a5aa7e0e client_created_at: '2024-05-22T12:45:29.216Z' client_updated_at: '2024-05-22T12:45:29.216Z' created_at: '2024-05-22T12:45:29.212387Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-22T12:45:29.212387Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - observation_id: 67f1f21e-3602-4d31-81ae-348b1d33bcee module_id: fcef77d8-21a9-4594-9bf7-6b06679fe1bb enabled: true name: eeeeeeeee status_id: a7462d5b-a0ab-4fb0-a984-54ba62a9f02e priority_id: 62df924d-a39f-4817-8f96-89a6a5aa7e0e client_created_at: '2024-05-27T12:38:49.976Z' client_updated_at: '2024-05-27T12:38:49.976Z' created_at: '2024-05-27T12:38:49.952373Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-27T12:38:49.952373Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - observation_id: f94ebbe1-909a-43de-a4b4-3f415d1ba8be module_id: fcef77d8-21a9-4594-9bf7-6b06679fe1bb enabled: false name: dddddddddddd status_id: a7462d5b-a0ab-4fb0-a984-54ba62a9f02e priority_id: 62df924d-a39f-4817-8f96-89a6a5aa7e0e client_created_at: '2024-05-27T12:29:15.145Z' client_updated_at: '2024-05-27T12:29:15.145Z' created_at: '2024-05-27T12:29:15.184524Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-28T12:29:58.795097Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a need_to_relaunch: false continuous_token: 638524961987950970|0 count: 5 total_count: 5 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' post: operationId: observationsCreateObservation summary: Create observation description: "Going along with the option to create a project from scratch, you can now also create observations in\ \ a project using just a few parameters.\n\n Details \n\n project_id \n The ID of the project where the the observation\ \ will be created \n\n Body mandatory infos \n Details \n\n module_id \n Id of the module \n\n Body optional infos\ \ \n \n Details \n\n description \n Your best wording to describe the observation \n\n trade_id \n The ID of the category\ \ used in the observation \n\n common_observation_id \n The ID of the model used in the new observation \n\n priority_id\ \ \n The ID of the priority of the new observation. If not set the default one will be used \n\n status_id \n The\ \ ID of the status of the new observation. \nIf not set the default one will be used \n\n assignee_id \n The ID of\ \ the user that will have the new observation assigned \n\n phase_id \n The ID of the phase that is set for the new\ \ observation. \n\n company_id \n The ID of the company that will be assigned to the new observation \n\n plan_id\ \ \n The ID of the plan used for the observation \n\n position_x \n X coordinate of the item regarding the affected\ \ 2D plan \n\n position_y \n Y coordinate of the item regarding the affected 2D plan \n\n due_date \n The due date\ \ of the observation, set as a date format \n\n group_id \n id of the linked discussion group \nthis id is mandatory\ \ if the module settings is_group_mandatory=true \n\n latitude \n in decimal degres following ISO6709 \n\n longitude\ \ \n in decimal degres \nfollowing ISO6709 \n\n Please note that the combinations for description , trade_id and common_observation_id\ \ are limited to only 3 specific cases:\n\n Case 1 : Description, Trade Id, Common observation Id\n\n Case 2 : Trade\ \ Id, Common observation Id\n\n Case 3 : Description" tags: - Observations parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: description: module_id: group_id: '{{group_id}}' responses: '200': description: OK content: application/json: schema: type: object examples: Create_Observation_with_phase: value: id: f547f0a9-583d-4cf0-8f9b-dda8efd41dd6 project_id: a1bf361f-abd4b854-523d-4857-8e82-b0d6325b07d1 description: priority_id: 94dccc2b-fecf-4725-86cb-3ec524c50654 position_x: 0.5 position_y: 0.5 client_created_at: '2022-10-17T14:06:32.830934Z' module_id: 1e870757-f1df-452f-a86c-d4115c10bf43 phase_id: 7675aa39-d7bd-4c5d-98eb-6025a668862d created_at: '2022-10-17T14:06:35.585692Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2022-10-17T14:06:35.585692Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a Create_Observation_in_group: value: id: f547f0a9-583d-4cf0-8f9b-dda8efd41dd6 project_id: a1bf361f-abd4b854-523d-4857-8e82-b0d6325b07d1 description: priority_id: 94dccc2b-fecf-4725-86cb-3ec524c50654 position_x: 0.5 position_y: 0.5 client_created_at: '2022-10-17T14:06:32.830934Z' module_id: 1e870757-f1df-452f-a86c-d4115c10bf43 phase_id: 7675aa39-d7bd-4c5d-98eb-6025a668862d group_id: 7675aa39-d7bd-4c5d-98eb-6025a6688633 created_at: '2022-10-17T14:06:35.585692Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2022-10-17T14:06:35.585692Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/observations-priorities: get: operationId: projectLibrariesGetProjectObservationPriorities summary: Get project observation priorities description: "For a given project, you can list all the available observation priorities.\n\n Details \n\n projectId\ \ \n the id of the project to be modified \n\n Query params optionals \n\n see Commmon behaviors / differential link" tags: - Project libraries parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: priorities: - id: 62df924d-a39f-4817-8f96-89a6a5aa7e0e position: 0 color: '#49cb0c' icon: ChevronDown is_default: true names: - language: en translation: LowLow enabled: true created_at: '2024-05-22T09:26:34.112731Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-22T09:26:34.112731Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 03d4b645-21f3-4228-badc-d5411d77270a position: 2 color: '#e94f3d' icon: AlertTriangle is_default: false names: - language: en translation: High enabled: true created_at: '2024-05-22T09:26:34.378054Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-22T09:26:34.378054Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a need_to_relaunch: true continuous_token: 0|2 count: 2 total_count: 3 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/observations/filter: post: operationId: observationsGetFilteredObservationIds summary: Get filtered observation IDs description: "Get a filtered list of the observations.\n\n Details \n\n project_id \n The ID of the project where the\ \ the observation will be created \n\n Endpoint optional Query params \n Details \n\n limit \n max number od observations\ \ to get \n\n offset \n Returned after the first call. \nOffset index from where to begin getting observations. \n\ Send it for the next calls. \n\n Body optional infos \n \n Details \n\n modules_ids \n list of modules ids \n\n search_term\ \ \n string to filter descriptions \n\n status_ids \n list of status ids \n\n priority_ids \n list of priorities ids\ \ \n\n trade_ids \n list of categories ids \n\n plan_ids \n list of plans ids \n\n assignee_ids \n list of users ids\ \ \n\n company_ids \n list of companies ids \n\n creator_ids \n list of users ids \n\n phase_ids \n list of phases\ \ ids \n\n observation_ids \n list of observations ids \n\n due_date_from \n Date \n\n due_date_to \n Date \n\n created_at_from\ \ \n Date \n\n created_at_to \n Date" tags: - Observations parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: modules_ids: - responses: '200': description: OK content: application/json: schema: type: object examples: Get_observations_ids_filtered_full_filter: value: observations: - observation_id: 42c8ba52-8564-4f91-b0d2-1d58e534bcdc name: obs1 status_id: f0f9f6a7-7b62-4af6-b078-bca515ce08d9 priority_id: 29472e27-9de7-4bc2-91da-53b3815eca10 trade_id: ac2157a9-024b-42bf-8a03-d25ce5c39ca3 common_observation_name: mdl export assignee_id: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a company_id: 9d194f0c-b2de-4f63-818e-96b237281cbc due_date: '2024-04-30T00:00:00Z' client_created_at: '2024-03-22T10:22:09.379Z' client_updated_at: '2024-04-25T09:42:50.321401Z' created_at: '2024-03-22T10:22:09.403612Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-04-25T09:42:50.329082Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a phase_id: 16afbdfd-8a25-4687-9446-d78770f76d47 - observation_id: 65e62723-49a4-4c12-a2b6-6cd7d9982f09 name: cat 1 status_id: 13af83ef-27d4-45f5-9ddf-d017474dbfc9 priority_id: 29472e27-9de7-4bc2-91da-53b3815eca10 trade_id: ac2157a9-024b-42bf-8a03-d25ce5c39ca3 common_observation_name: mdl export client_created_at: '2024-03-29T09:14:47.246Z' client_updated_at: '2024-03-29T09:14:47.246Z' created_at: '2024-03-29T09:14:47.973085Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-03-29T09:14:47.973085Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - observation_id: fa897bff-1e7f-4c2e-8462-3d44e47e0678 name: obs2 status_id: 13af83ef-27d4-45f5-9ddf-d017474dbfc9 priority_id: 29472e27-9de7-4bc2-91da-53b3815eca10 client_created_at: '2024-03-22T10:22:27.598Z' client_updated_at: '2024-03-22T10:22:27.598Z' created_at: '2024-03-22T10:22:27.660162Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-03-22T10:22:27.660162Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a count: 3 total_count: 3 limit: 50 offset: 0 Get_observations_ids_filtered: value: observations: - observation_id: 42c8ba52-8564-4f91-b0d2-1d58e534bcdc name: obs1 status_id: f0f9f6a7-7b62-4af6-b078-bca515ce08d9 priority_id: 29472e27-9de7-4bc2-91da-53b3815eca10 trade_id: ac2157a9-024b-42bf-8a03-d25ce5c39ca3 common_observation_name: mdl export assignee_id: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a company_id: 9d194f0c-b2de-4f63-818e-96b237281cbc due_date: '2024-04-30T00:00:00Z' client_created_at: '2024-03-22T10:22:09.379Z' client_updated_at: '2024-04-25T09:42:50.321401Z' created_at: '2024-03-22T10:22:09.403612Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-04-25T09:42:50.329082Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a phase_id: 16afbdfd-8a25-4687-9446-d78770f76d47 - observation_id: 65e62723-49a4-4c12-a2b6-6cd7d9982f09 name: cat 1 status_id: 13af83ef-27d4-45f5-9ddf-d017474dbfc9 priority_id: 29472e27-9de7-4bc2-91da-53b3815eca10 trade_id: ac2157a9-024b-42bf-8a03-d25ce5c39ca3 common_observation_name: mdl export client_created_at: '2024-03-29T09:14:47.246Z' client_updated_at: '2024-03-29T09:14:47.246Z' created_at: '2024-03-29T09:14:47.973085Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-03-29T09:14:47.973085Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - observation_id: fa897bff-1e7f-4c2e-8462-3d44e47e0678 name: obs2 status_id: 13af83ef-27d4-45f5-9ddf-d017474dbfc9 priority_id: 29472e27-9de7-4bc2-91da-53b3815eca10 client_created_at: '2024-03-22T10:22:27.598Z' client_updated_at: '2024-03-22T10:22:27.598Z' created_at: '2024-03-22T10:22:27.660162Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-03-22T10:22:27.660162Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a count: 3 total_count: 3 limit: 50 offset: 0 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/observations/report/xls: post: operationId: exportsCreateObservationsExportInXlsx summary: Create observations export in XLSX description: "You can generate a unit PDF report from a selection of form instances.\n\n Details \n\n project_id \n\ \ The ID of the project where the form will be created \n\n body optional selection info \n Details \n\n observations_ids\ \ \n id of the observations \n\n module_id \n Id of the module \n\n status_ids \n list of the status id \n\n priority_ids\ \ \n list of the priotities id \n\n trades_ids \n list of the trades ids \n\n plan_ids \n list of the locations ids\ \ \n\n assignee_ids \n list of assigned users ids \n\n assigned_company_ids \n list of assigned companies ids \n\n\ \ creator_ids \n list of creator ids \n\n due_date_from \n minimal due date \n\n due_date_to \n maximal due date \n\ \n created_at_from \n created after this date \n\n created_at_to \n created before this date \n\n search_term \n\n\ \ group_ids \n ids of the groups \n\n phase_ids \n ids of the phases \n\n Body optional presentation info \n Details\ \ \n\n time_zone \n text of the time zone (defalut to the project timezone)" tags: - Exports parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: {} responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: file_name: TestExport_Quality_2024-03-28-15-22-25.xlsx file_stream: UEsDBBQAAAgIAMxyfFjPWMN7MQEAADACAAAPAAAAeGwvd29ya2Jvb2sueG1sjZFda8IwFIb/Snbo7YwWdKPYykAG3owNZbscMTm1wXyUJGr375d0LYpXu8r5fN6Xk+Wq04qc0XlpTQmzyRQIGm6FNIcSTqF+fIZVteyKi3XHvbVHEueNL1wJTQhtQannDWrmJ7ZFE3u1dZqFmLoDtXUtOa4tP2k0gebT6YI6VCxELd/I1sNA6/5D861DJnyDGLT6g2kmDdy6e3ckesc3prGEXSP919AAQtNcCj8lXvztUiqQWjoftgleQrwB40Geccf2fRZ36d1y7+MaEdNLfpyYkuEHSF/ciBJyIK6QMXAbkY+k67LAWhoUyfB9PiC/O2X05PtVqoBuzQLbM49AlOVMbUeV6LGRQmD6QqgGFw/ZS7Yosl22SJo35Oou75UjjqfzxScRZ/n8KZ+PhsdTVb9QSwMEFAAACAgAzHJ8WLDTabVaAQAAOgMAABAAAABkb2NQcm9wcy9hcHAueG1snZPdTsMwDIVfpeR+6zYmhKo20wRI3ACFIbhEJnW3iDaJErfaeHrSbmxlPwhxFx9/cY6dJJ4syyKo0TqpVcKG/QELUAmdSTVPWEV575JNeAwmSq02aEmiC/wW5aKaErYgMlEYOrHAElzfE8onc21LIB/aeajzXAq81qIqUVE4GgwuwkyLppp7eV4ZdGxTD8x/6+GSUGWY9czWI2s9T40ppADyvfE7Kax2OqfgZimwiMO9fMM/SyrQPeQpWHI8rimqUZC2wTs4bMwmrDCOLAuc/PTBOWuhVuOPFRSSVnG4VQ5yZ6mVit6mFuEP2NpNFwy3jnjrf8+vV24RmqtLQdoTDdRgJSj6bmG8bmGjdry8avvhFoh06KDDdtdyzIct4Be/guta91BiFjyBmh9p8vQRo+NH7I/m5yC84J/MDEVl/Xz5oEW6SkPMBBR45Z8Qz6Fw2DI7rQ13n4B/AVBLAwQUAAAICADMcnxYhTpuOasCAAAWCQAAFAAAAHhsL3NoYXJlZFN0cmluZ3MueG1sxVbbbtswDH3fVxB+T+14a9e5TYqgaYACTdthF2CPiszEWmXJkOQm2dP+aP+0Lxltp1eU7vY0I5BhnSOKh6SoHJ9sSg236LyyZhQN95II0EibK7MaRXVYDg6jk/HxJvM+AFGNzzajqAihyuLYywJL4fdshYawpXWlCPTpVrGvHIrcF4ih1HGaJAdxKZSJWlOqGcP42tnvKMNx3Hw0YwfcwZ+RtjzbVNaxlJkyQkuRQ9WZgvNpxnH3D4f7HNbtArkIyK5PDwdz4QZpkr7jKKekOWAOaxUKuPftyiC7QCt5AwU6hGBBo3AGSutY/i5i4HBJa4xkiZ0gcmWxZQV9FVrbABe15BjfbA1SGGjy+0QPWAOhQFjjAtQStsRbCxMaEZir0GCeSAuP7lYEqiy/95qkM5P3x3+mdEDHwU1tZr4SEkcRlV6zMUbjuc1rjdnHWmgVtkfA2T6fcsgUvXSqajRwlG4TtoqdyPn827KkUD4K1MtM1w7X7YvOaphotTJwK/QoWgiPWhmMIG75P7rpYbKbkFZbB261GEWzWdI+O8TNLKWsZU+cEno3vRSl0ttuPm3n4vu9w/hCmZsHH91z51Rn4//6eImYexBSovfg1KoI/onLL9Sgso4KhEvTpyBC7Tl04j0pxb4kV8Kwxqc1toXPHpCCotfbcahsei1M6lBYx6EXgtrsl6ox0Gul5dUtr2krrLtaGA+FQiecLHppcClKdrup8rL2za3kwRCPC//LB//UWkdXGPnq38CjZy4qD1SKNw/T/UknJT5Yx+qgozvksF3b4eCrpqtS6qiJsjG3a/qxXcsAdc8Vif634LCS38ZpGvddcHRXQHdtvGoChkmWplny4ffPX5M5DOAS13AEz/HhwR3+upom2CmHkfm/9Sl9/8inp4vi9o/O+A9QSwMEFAAACAgAzHJ8WCTZlXSzAwAA/SgAAA0AAAB4bC9zdHlsZXMueG1s7Vpbb5swFP4riPcVktIsqUqrXIpUqeqmtZP2asAQr8ZGxmmT/vr5AglJJRpakoU2yYPtwznHnz8bc3y5uJon2HiCLEOUuGbnxDYNSAIaIhK75oxH3/rm1eXF/DzjCwzvpxByQ1iQ7HzumlPO03PLyoIpTEB2QlNIxLOIsgRwUWSxlaUMgjCTZgm2urbdsxKAiCk9klniJTwzAjojXFRdEho6uQldU+DRDsc0hK5pGtblhbU0liYRJSUvtlnIZCoaxocYxcR4Atg1fZBBjAhUXkSbXrS408kFAcWUGSz2XdPzbPXLnxCQQK08Bhj5DOXyCCQIL/STbgGuqL1Ifa3bRjBODTBDhgCuA2UHhOwVQ9/pe4PJxzHU6xJ7l3TM9PNMvP64qPlduLiYE2BJ+nF6GoOWUyb6z+4O9jaCDrXbOlt229ZTTZ7RczPCeDk3O2YhkmkKOIeMeKJo5PmHRSrqJjQHaa2U3zSKGVh0ume17TKKUahxxeO10WF7Pa9X+CvZN+XfEf771f7zjGLSpywUX+n1r6UWGiECMSUA/07V97IoTugzkQKpiWHEDfUNzwmuGoqW1pcqDMXTWobKQOpwmtaxE+q6RZzTpI6htpBKRbvrWBc2uStJZymrmA8gxvfS459oRb/mfx5tRipkmRUdl2e1r7wA0hQv7maJD5mn4hrZl1oqe39VGimrlY16lRNISgY/GeUw4DpyU4DSpcTANHiEoVKeojCEaijkrZ5HVeg7rUbfbTX601ajd1qN/myFvlsXvf3f0fdajf57q9GXRs5p+9D3W41+0II5x1qPIoqoohxQOO8NKObRXloLCiVjShl6Ebhk6B9DAplcqsjFBgrUOkPFY6bB4Zz/ohxoJ6KuZwbSByFUBURCVaHIMoiF0hO8WYn+zjKOosUtyPitWLIoWTZliDw+UA8VZkBuUv1YtsXaRwB0ZLtxtls0tgOhA1mr2a4Ijw+N7U8wtivC+SPbjbNdsfw4sv2V2f4E83bF4nR7tj8UrX8ltisW00e2G2e7YvF/aGx/gnm7YrOihWx3Dpztis2VI9tfeWxvMW8fOtsVW2+HFgG2Zt62lluDa2ePGwe/S7khD+hd805Si0u0+zOEOSJ5yVrfglSuw3m0cTIf6t7euHZROjy17f5A/l/dQqh/Cg5mnCoSVB1++Wzcticj+X/zbDzHuwVsZzwcea8vTzQMezy4PvOahF26obJD2J436Y+uG4R9PXC808nOYffHw7GzHWydZiqzush4+Q9QSwMEFAAACAgAzHJ8WJL7WnyaBQAAexcAABgAAAB4bC93b3Jrc2hlZXRzL3NoZWV0MS54bWylWMtS4zgU/RWVV91V0yS28zApoIsO0AmvZAJMr4WtJCpsySMphPSv9WI+aX5h9LCDzdyQ0NmAJR8dnXvvkWLp31//HH19yVL0TISknB17/kHTQ4TFPKFsduwt1PRL5CGpMEtwyhk59lZEel9Pjl56Sy6e5JwQhTQDkz1x7M2VynuNhoznJMPygOeE6XdTLjKsdFPMGnw6pTE54/EiI0w1gmaz0xAkxUrPLuc0l17B9rILm8wFwYkVkaWOLMOUeUae7R0L88gXKqWMjAWSiyzDYvWNpHypg/XKjgmdzZXtaJwcNWqDE6qVmuQgQabH3qnfe4gsrED9RclS1lrIZOaR8yfTGCbHXtMKyjEj6OUuT6kyXWhVPLY9pHh+TaaqT9JUz9DxEI4VfSZjbBL+yJXimXlvC6F011Twn4TZ8TXFZsJ661XZhc2bzkFCpniRqglfDkgRdrsIKOapLP6jjDKbkAzrUoQeWtJEzXVP66DrNztB24hZpcSGEi+klvijQLySOZJWQdJ6JYkODj9I0i5I2u+Q+NtIOgVJtE84hwXJ4T7h+M2CxTz8vha/LJB52EgTbKUJSppgLzVhSfOeX7arKQ3j7+UYv7SM395LTWma4OOVarwuKbsGz7DCpiH4Egm3/+hdQeqnXuDbTSI2/afmhV10enFK2/980jRsz45zjfwGIf0asmGnq8wabJo1sFytGlcAzuqQ7RoyhJB9iLMFIc8cslNDtiHkpUN2a8gOhLxxyKiG7L6fnXBTdkIgkgjMTlhmp/GaB2j0IZiHEMitDxb/0kEP69At1W9tiq8FKPTB8vdBKFj/sxYUTet9iZ1NEjuWzOyYVTbQJN9gLGiTPoztggHBWNAI5zAWLPtFgfXrqw+s+3eQN/Ah7ADGgnUdwliwsJcwFlzaVwU2qGPBul3DvPDyhnnBut3CvGDdRjAvWLcxyBuCdfsTxoJ1m8BYsG53MBas2z2MBev2AGPrdfvf6u1uWr1dy9YEf6TKVVtiahPCixaEgrU/d1C/uiFfFH31X84Q9MN3cCrQDgMI2gLdMAShYFquHDSoBnCz7qsOB/1xC84E2mO0O+t4d9YHELrlVyDa5KOo5iP4AyWCJgQ3nD4E3eCjCPBR9AEfgVPBPgIDABfCEITCPooAH0W7+wicCfbR7qzj3VkfQCj8Qdd488mNF4pf0FQRUZzjOz2zF9pEZETMiDl8SxTzBVPmK7DW74ZcBr3r4O0Q9+om6N1ueHUZ9m7D8jTwOpMNirOEmpsPnLrTuaJshuTfdtygN3Cmn04WKUFqletjhh6hMGXynrzok3/yMnXXCygXlAuqVtadPCcCKy7ewpX+q6tIlpbX3KMsUnxyO7r/NLw7n0xGk09356eT/uCTxfwx8D9//mxEl0ibYatmN11+VVewTdc9Rwnfqsyh9tcWVLWF27QNGRoLPhNEyq0Kq9j9dYZVna1tOhWR6noRjxdqq8wK9H2VjQ0+3Wrgq94VYGDt/aGsBtWuBqXThvUSvZ9jVovAC6IvN1h8CZpBy/sdpXM9u0gpe5K1Vrl6PSR6VKdbDBN7HcdTRXO9u1NNFOOkWNlvhpnz13pYpzKsz7OMM8QfJRHP9moTJjAfIWuCboVglBM9nKEledwwMqqMjN4Z2Xgbuk48U6Pc3reiua7BT+OjtE+Yzjtxu8kzEYrGbzrnBJs7Ybf/zgRNrikjrmUV5nhGdIlm2pIoJVNzx3nQ1ckU7o7RNRTPy0d3rWlabUdORNGYcq5co9uukN8RtchRjnU0d/Snu+6TWqV5apo9UGNGwtIkfMnu54SNdCTaXoLqQGwd9Ct3+6nnT3H8dMqSH3Oq3AVOIvDUXc0al5oi6mE6QsYZ8RARggvdSqjMU7wia1NY6RdWs+tR+DElYyzU+uekWdZifWd+8h9QSwMEFAAACAgAzHJ8WGBMh7OmBQAAuBsAABMAAAB4bC90aGVtZS90aGVtZTEueG1s7VlNj9tEGP4rI99bx0mcZldNq002aaHddrUbinqcOBN7mrHHmpnsNjfUHpGQEAVxQeLGAQGVWolL+TULRVCk/gVeO449TsbdbLsIUDeHxDN+3u8Pv+Ncvf4wZOiICEl51LGcyzULkcjjYxr5HWumJpfa1vVrV/G2CkhIEIAjuY07VqBUvG3b0oNtLC/zmERwb8JFiBUshW+PBT4GJiGz67Vayw4xjSwU4ZB0rLuTCfUIGiYsrZx5n8FXpGSy4TFx6KUSdYoUO546yY+cyx4T6AizjgVyxvx4SB4qCzEsFdzoWLX0YyH72lU7p2KqglgjHKSfJWFGMZ7WU0Lhj3JKZ9DcurJbSKgvJKwD+/1+r+8UHFME9jyw1lkDNwdtp5tz1VCLy3XuvZpba64QaBIaawRb3W7X3SoTNAqC5hpBu9Zq7tTLBM2CwF23obvT67XKBG5B0FojGFzZajVXCFJUwGg0XYMnkS1ClGMmnN004tuAb+e5UMBsLdMWDCJVlXchfsDFAABplLGiEVLzmEywB7geDkeC4lQC3iZYu5XteXJ9LxGHpCdorDrWhzGGAikwr1/88PrFM/T6xdOTR89PHv188vjxyaOfTJQ3ceTrlK+++/yvbz5Bfz779tWTLysIpE7w24+f/vrLFxVIpSNffvX09+dPX3792R/fPzHhdwQe6fghDYlEd8gxOuBhYp9BBBmJM5IMA0xLJDgAqAnZV0EJeWeOmRHYJWUf3hPQFozIG7MHJX0PAzFT1IS8FYQl5B7nrMuF2aZbqTjNplnkV8gXMx14gPGRUXxvJcr9WQyZTY1MewEpqbrPIPDYJxFRKLnHp4SY6O5TWvLvHvUEl3yi0H2KupiaHTOkI2WmuklDCNDcqCNEveShvXuoy5lRwC45KkOhQjAzMiWs5M0beKZwaNYah0yH3sYqMCp6OBdeyfFSQdB9wjjqj4mURqK7Yl5S+RaGFmXOgD02D8tQoejUCL2NOdehu3zaC3AYm/WmUaCDP5BTyFiM9rky68HLNZOsISA4qo78PUrUGYv9I+oH5mRJ7szEsquX+nNIozc1a0ahW18065VmvQNPMGORrLboSuD/tDHv4lm0T5Lkv+jLF335oi+/ocI37sZFA7b1uTplGFYO2RPK2KGaM3Jbpq1bgt7jAWymi5QoH+rjAC6X8kpAX+D0GgmuPqYqOAxwDHKcVIQvM96+RDGXcJiwKpmnZ1MK5qd7bn6gBDhWe3y82G+UTpo5o3TlS11UI2GxqbjGlXcV5yyQG8pz3Ap57pvl2ZpPoTYQTt4cOK16pqb0MCPjxPsZh2V0zj1SMsBjkoXKMdviNDb1Xft012nythrvKm+TWOkCm1UC3fMIVm09WPZ6dbKovELHoJhbdy3k4bhjTWDwgsswBoYyaUmY+VHH8lRmzam1vWpzRYI6tWqbS0JiIdUulsGCLL2Vv5SJChPqbjNhdz42mPrThno02s6/qoe9GmEymRBPVewUy+wenykiDoPxMRqxmTjAoHlzkWVjKuFRUl8uBNRrM0vAch/I6mH11U9WJ5jFAc56VFvPgAU+vc6VSFeafnaF8m9pS+McbXHfZ1uS9IXxtjFOz2EwHwiMkjztWFyogEM/igPqDQRMFKkwUAxBbaQtiyWvsBNlyZHWwhZMFg3PD9QB9ZGg0PVUIAjZV5mlp3Bzlh0yK4+MU9ZxcoVlvPgdkSPChkkRtxIXWCjI20rmixS4GjjbVGMjf/BfnoqaVVPRKWNDIap5limlqT8EtGfD1rtqccYHcL3C7Lq7+QM4hpMKSr6gkVPhsWIGHvIDyAJUDJ2QkpfaWSnmmyPQuq3bl/D6Z2esIhDtqrif63iqebxR5fFTBL69x12Dw91T/G2vF6ytHXnS1drfXXz0AITvwplqxpTM3ks9hNNpb/nvBDDKZKbE1/4GUEsDBBQAAAgAAMxyfFiY4iQ62gEAANoBAABRAAAAcGFja2FnZS9zZXJ2aWNlcy9tZXRhZGF0YS9jb3JlLXByb3BlcnRpZXMvNDgwYzBhMWNmYTZiNDMzMDkzNTg2ZmQ5OGI0MTRjMGEucHNtZGNw77u/PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz48Y29yZVByb3BlcnRpZXMgeG1sbnM6ZGM9Imh0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvIiB4bWxuczpkY3Rlcm1zPSJodHRwOi8vcHVybC5vcmcvZGMvdGVybXMvIiB4bWxuczp4c2k9Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvWE1MU2NoZW1hLWluc3RhbmNlIiB4bWxucz0iaHR0cDovL3NjaGVtYXMub3BlbnhtbGZvcm1hdHMub3JnL3BhY2thZ2UvMjAwNi9tZXRhZGF0YS9jb3JlLXByb3BlcnRpZXMiPjxkY3Rlcm1zOmNyZWF0ZWQgeHNpOnR5cGU9ImRjdGVybXM6VzNDRFRGIj4yMDI0LTAzLTI4VDE0OjIyOjI1LjcyNTU4MDRaPC9kY3Rlcm1zOmNyZWF0ZWQ+PGRjdGVybXM6bW9kaWZpZWQgeHNpOnR5cGU9ImRjdGVybXM6VzNDRFRGIj4yMDI0LTAzLTI4VDE0OjIyOjI1LjcyNTU4MDdaPC9kY3Rlcm1zOm1vZGlmaWVkPjwvY29yZVByb3BlcnRpZXM+UEsDBBQAAAgAAMxyfFhEc0vcnAIAAJwCAAALAAAAX3JlbHMvLnJlbHPvu788P3htbCB2ZXJzaW9uPSIxLjAiIGVuY29kaW5nPSJ1dGYtOCI/PjxSZWxhdGlvbnNoaXBzIHhtbG5zPSJodHRwOi8vc2NoZW1hcy5vcGVueG1sZm9ybWF0cy5vcmcvcGFja2FnZS8yMDA2L3JlbGF0aW9uc2hpcHMiPjxSZWxhdGlvbnNoaXAgVHlwZT0iaHR0cDovL3NjaGVtYXMub3BlbnhtbGZvcm1hdHMub3JnL29mZmljZURvY3VtZW50LzIwMDYvcmVsYXRpb25zaGlwcy9vZmZpY2VEb2N1bWVudCIgVGFyZ2V0PSIveGwvd29ya2Jvb2sueG1sIiBJZD0iUjYxN2YwMDYwMWU4MzQ0YTciIC8+PFJlbGF0aW9uc2hpcCBUeXBlPSJodHRwOi8vc2NoZW1hcy5vcGVueG1sZm9ybWF0cy5vcmcvb2ZmaWNlRG9jdW1lbnQvMjAwNi9yZWxhdGlvbnNoaXBzL2V4dGVuZGVkLXByb3BlcnRpZXMiIFRhcmdldD0iL2RvY1Byb3BzL2FwcC54bWwiIElkPSJySWQxIiAvPjxSZWxhdGlvbnNoaXAgVHlwZT0iaHR0cDovL3NjaGVtYXMub3BlbnhtbGZvcm1hdHMub3JnL3BhY2thZ2UvMjAwNi9yZWxhdGlvbnNoaXBzL21ldGFkYXRhL2NvcmUtcHJvcGVydGllcyIgVGFyZ2V0PSIvcGFja2FnZS9zZXJ2aWNlcy9tZXRhZGF0YS9jb3JlLXByb3BlcnRpZXMvNDgwYzBhMWNmYTZiNDMzMDkzNTg2ZmQ5OGI0MTRjMGEucHNtZGNwIiBJZD0iUjQ0MjU4YjU1MjYzMDQwYTEiIC8+PC9SZWxhdGlvbnNoaXBzPlBLAwQUAAAICADMcnxY5SwmJOMAAAC/AgAAGgAAAHhsL19yZWxzL3dvcmtib29rLnhtbC5yZWxztZJBTsMwEEWvYs2eOCkIIVS3Gzbdll7AciZx1MS2ZqalPRsLjsQVMEFCGLFgk40t//E8vbH8/vq23l6mUZ2ReIjBQFPVoDC42A6hN3CS7uYBtpv1Hkcr+Qb7IbHKLYENeJH0qDU7j5PlKiYMudJFmqzkI/U6WXe0PepVXd9r+smAkqkO14T/IcauGxw+RXeaMMgfYM3eErbPQnkCBnWw1KMY0JexLFWZDGrXGqBdewtKL2ck1xF/q8xZ4XC3pMNLpCN7RCk1vuPPd8tbUxitljSS3IulzRx9raVIU88muviGmw9QSwMEFAAACAgAzHJ8WJ+e/AmPAQAAsgUAACMAAAB4bC93b3Jrc2hlZXRzL19yZWxzL3NoZWV0MS54bWwucmVsc+2UwWrcMBCGX8X4PpYly7JdssklOeTQS8kLjEajXTe2ZCxvuu2r9dBH6itUJBQ2UNhCCr3kKP2ab37+H/Tz+4+rm9M8FU+8pjGGXSmruiw4UHRj2O/K4+ahL2+urz7xhFt+kQ7jkoo8EtKuPGzb8kGIRAeeMVVx4ZAVH9cZt3xc92JBesQ9C1XXRqznjPI1s3j4uvDfEKP3I/FtpOPMYfsDWBwyaZ3G8FgWD7jueXvBpsz1Y8CJ0FUU59/qx+jy4rvTxmsWy+Le7cr13rVlIf6nxRgYvrCt+FglDM7GU3XuXuRFGMZvz1ChtJJdowm8HCRo1XSA5HqwTF5Jw4isxbLGz0xbEr1HaQbSoAaqjZINeFIKdJ2vUA8KOi3rdqhlS86IaBOvTy/mxRzdcWJBpsW6tQ2gNRb0QAjoJEHboffOST+o7kK+5j3ft+V7Pii0ot5iq6BvjQbts0tbOwXStT23jbbk6EIh3Xsh/7AQj/3QWe9BcudBk2LotVHQOK1Zd1ybrr9QSP9ciHj1817/AlBLAwQUAAAICADMcnxYWjtSQDsBAAA3BAAAEwAAAFtDb250ZW50X1R5cGVzXS54bWytlM1OAjEQx19l06vZLXgwxrBwUK9Koi/QtLNsQ7/SGRCezYOP5Cs4FIOGEInApU07M//fv5+f7x+jycq7agkZbQytGDYDUUHQ0dgwa8WCuvpWTMaj13UCrDg1YCt6onQnJeoevMImJggc6WL2iniYZzIpPVczkNeDwY3UMRAEqmmjIcajB+jUwlH1uOLpLZbLRXW/zdugWqFSclYr4rBcBrMHqWPXWQ0m6oXnkgZTBmWwByDvmtI3XtlwVYTlQWZCb3T6H/Z7XY2OGeqUOZrJAv6FyeDwNAhXlhzsbfpBPPNZZWugmqpMT8qznuR9mLIZlKzcnLuXsPFuwBxa3yH4yknsVQbzQpkvDZ5tYP8wf2kfNUJrBxd3UESPod9inpcKlKUbXtjFTv+YEeJXCdv2fA9FZkeU5RsYfwFQSwECFAMUAAAICADMcnxYz1jDezEBAAAwAgAADwAAAAAAAAAAAAAApIEAAAAAeGwvd29ya2Jvb2sueG1sUEsBAhQDFAAACAgAzHJ8WLDTabVaAQAAOgMAABAAAAAAAAAAAAAAAKSBXgEAAGRvY1Byb3BzL2FwcC54bWxQSwECFAMUAAAICADMcnxYhTpuOasCAAAWCQAAFAAAAAAAAAAAAAAApIHmAgAAeGwvc2hhcmVkU3RyaW5ncy54bWxQSwECFAMUAAAICADMcnxYJNmVdLMDAAD9KAAADQAAAAAAAAAAAAAApIHDBQAAeGwvc3R5bGVzLnhtbFBLAQIUAxQAAAgIAMxyfFiS+1p8mgUAAHsXAAAYAAAAAAAAAAAAAACkgaEJAAB4bC93b3Jrc2hlZXRzL3NoZWV0MS54bWxQSwECFAMUAAAICADMcnxYYEyHs6YFAAC4GwAAEwAAAAAAAAAAAAAApIFxDwAAeGwvdGhlbWUvdGhlbWUxLnhtbFBLAQIUAxQAAAgAAMxyfFiY4iQ62gEAANoBAABRAAAAAAAAAAAAAACkgUgVAABwYWNrYWdlL3NlcnZpY2VzL21ldGFkYXRhL2NvcmUtcHJvcGVydGllcy80ODBjMGExY2ZhNmI0MzMwOTM1ODZmZDk4YjQxNGMwYS5wc21kY3BQSwECFAMUAAAIAADMcnxYRHNL3JwCAACcAgAACwAAAAAAAAAAAAAApIGRFwAAX3JlbHMvLnJlbHNQSwECFAMUAAAICADMcnxY5SwmJOMAAAC/AgAAGgAAAAAAAAAAAAAApIFWGgAAeGwvX3JlbHMvd29ya2Jvb2sueG1sLnJlbHNQSwECFAMUAAAICADMcnxYn578CY8BAACyBQAAIwAAAAAAAAAAAAAApIFxGwAAeGwvd29ya3NoZWV0cy9fcmVscy9zaGVldDEueG1sLnJlbHNQSwECFAMUAAAICADMcnxYWjtSQDsBAAA3BAAAEwAAAAAAAAAAAAAApIFBHQAAW0NvbnRlbnRfVHlwZXNdLnhtbFBLBQYAAAAACwALABEDAACtHgAAAAA= content_type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/observations/{observation_id}: get: operationId: observationsGetObservationDetails summary: Get observation details description: "Based on an observation ID, we can access the full version of it.\n\n To go deeper, you will need to check\ \ user, plan, and company info based on the returned IDs.\n\n Endpoint mandatory infos \n Details \n\n project_id\ \ \n The ID of the project where the the observation will be created \n\n observation_id \n The ID of the observation" tags: - Observations parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: observation_id in: path required: true schema: type: string description: Path variable `observation_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 4a8ae783-e4f1-4d13-ae9f-feefa1a0f0cf enabled: true project_id: a1bf361f-abd4b854-523d-4857-8e82-b0d6325b07d1 description: Test phase obs priority: id: 94dccc2b-fecf-4725-86cb-3ec524c50654 color: '#AABBF0' icon: RoundOne names: - language: en translation: Low - language: fr translation: Observation Faible creator_id: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a creation_date: '2022-10-17T12:40:47.058Z' client_updated_at: '2022-10-17T12:40:47.058Z' module_id: ffbd9938-c88d-46b3-af75-79c29f76724f phase_id: 7675aa39-d7bd-4c5d-98eb-6025a668862d created_at: '2022-10-17T12:40:49.613444Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2022-10-17T12:40:54.769595Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/observations/{observation_id}/messages: post: operationId: observationsAddObservationComment summary: Add observation comment description: "You can add comments, link files, or link items to an observation.\n\n Details \n\n project_id \n The\ \ ID of the project where the the observation will be commented \n\n observation_id \n The ID of the observation \n\ \n Body optional infos \n Details \n\n for sending a comment \n\n text \n your text \n\n to attach a file or an image\ \ \n\n media_resource_id \n the id of a previously uploaded file via the upload media endpoint \n\n media_resource_name\ \ \n the display name of the file \n\n to link an observation \n\n reference_type \n \"Observation\" \n\n reference_id\ \ \n the id of the linked observation \n\n to link a form instance \n\n reference_type \n \"Form\" \n\n reference_id\ \ \n the id of the linked form instance" tags: - Observations parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: observation_id in: path required: true schema: type: string description: Path variable `observation_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object responses: '200': description: OK content: application/json: schema: type: object examples: Success_send_text: value: message_id: '525602108968271872' Success_link_item: value: message_id: '525661302899605504' Success_attach_file: value: message_id: '525661426749014016' '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' get: operationId: observationsGetObservationMessages summary: Get observation messages description: "Based on an observation ID, we can access its activity history.\n\n Details \n\n project_id \n The ID\ \ of the project where the the observation will be created \n\n observation_id \n The ID of the observation \n\n Query\ \ optional infos \n Details \n\n message_id \n id of a message to begin the reading \n\n get_newest \n if true, get\ \ the messages newest as the message_id \nfalse is the default value" tags: - Observations parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: observation_id in: path required: true schema: type: string description: Path variable `observation_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: messages: - message_id: '516983453749608448' channel_type: Observation content_type: ActionTracking created_at: '2023-11-27T14:27:40.4629455Z' - message_id: '516983456085835776' channel_type: Observation content_type: Content created_at: '2023-11-27T14:27:41.0203124Z' client_created_at: '2023-11-27T14:27:41.022Z' message: media_resources: - id: a2c195a0-e20b-4478-a14d-ff15c4a30947 mime_type: image/png created_at: '2023-11-27T14:27:41.0203124Z' - message_id: '516984099139747840' channel_type: Observation content_type: ActionTracking created_at: '2023-11-27T14:30:14.335632Z' - message_id: '516984372897775616' channel_type: Observation content_type: Content created_at: '2023-11-27T14:31:19.6053099Z' client_created_at: '2023-11-27T14:31:19.608Z' message: references: - type: Observation id: 31a12174-b984-4d27-addd-2764755c989c - message_id: '516984526031814656' channel_type: Observation content_type: ActionTracking created_at: '2023-11-27T14:31:56.1144243Z' - message_id: '516984527478849536' channel_type: Observation content_type: Content created_at: '2023-11-27T14:31:56.4594085Z' client_created_at: '2023-11-27T14:31:56.545Z' message: media_resources: - id: b5542949-ff29-4fd4-a517-b25f3209411c mime_type: image/png created_at: '2023-11-27T14:31:56.4594085Z' - message_id: '516984663206526976' channel_type: Observation content_type: ActionTracking created_at: '2023-11-27T14:32:28.8204254Z' - message_id: '516984756827586560' channel_type: Observation content_type: ActionTracking created_at: '2023-11-27T14:32:51.1411903Z' - message_id: '517285591298080768' channel_type: Observation content_type: ActionTracking created_at: '2023-11-28T10:28:15.6680051Z' - message_id: '516983244671942656' channel_type: Observation content_type: Content created_at: '2023-11-28T10:32:02.7915791Z' client_created_at: '2023-11-27T14:26:50.614Z' client_updated_at: '2023-11-28T10:32:01.163Z' message: text: value: Premier comment modif - message_id: '520584181252620288' channel_type: Observation content_type: Content created_at: '2023-12-07T12:55:40.8022783Z' client_created_at: '2023-12-07T12:55:40.122Z' message: text: value: autre texte count: 11 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/phases: post: operationId: phasesCreatePhase summary: Create phase description: "You can create a list of phases for your project.\n\n Creating a new phase for a project only involves\ \ giving it a name.\n\n Phases are ordered, which determines where each specific phase is displayed in the list of\ \ phases.\n\n Endpoint mandatory infos \n Details \n\n project_Id \n the id of the project to be modified \n\n body\ \ mandatory infos \n Details \n\n name \n name of the phase \n\n order \n ordre of the new phase in the list of phase" tags: - Phases parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: name: order: 22 responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: d7e0f2df-b305-46fc-a011-d38e3498dd0e order: 20 names: - language: en translation: '666666666' created_at: '2022-10-18T08:51:54.8029455Z' updated_at: '2022-10-18T08:51:54.8029455Z' '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/phases/{phase_id}: put: operationId: phasesUpdatePhase summary: Update phase description: "Update a phase.\n\n Details \n\n project_Id \n the id of the project to be modified \n\n phase_id \n id\ \ of the phase to be modified \n\n body optional infos \n Details \n\n name \n new name of the phase \n\n order \n\ \ new order of the phase in the list" tags: - Phases parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: phase_id in: path required: true schema: type: string description: Path variable `phase_id` as published in the collection. - name: Accept-Language in: header required: false schema: type: string requestBody: required: true content: application/json: schema: type: object example: name: order: 0.2 responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: eb1acb59-f8f2-4caa-b33a-c1cc2780e6de order: 0.2 names: - language: en translation: the new name created_at: '2022-10-18T08:10:04.43209Z' updated_at: '2022-10-18T13:10:08.3315228Z' '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' delete: operationId: phasesDeletePhase summary: Delete phase description: "Delete a phase from the list.\n\n Phases already assigned to existing items will be tagged as deleted\ \ entities.\n\n Endpoint mandatory infos \n Details \n\n project_Id \n the id of the project to be modified \n\n phase_id\ \ \n id of the phase to be deleted" tags: - Phases parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: phase_id in: path required: true schema: type: string description: Path variable `phase_id` as published in the collection. responses: '204': description: No Content '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/plans: get: operationId: locationsGetPlanTree summary: Get plan tree description: "Before creating new plans, you might want to have an overview of the ones deployed in your project. This\ \ helps you manage it based on the current context.\n\n Endpoint mandatory infos \n Details \n\n project_Id \n the\ \ id of the project to be modified \n\n Query params optionals \n\n see Commmon behaviors / differential" tags: - Locations parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: plans: - id: ccf9856b-6b58-44e2-886d-d34c202f4ac8 name: LogoTest.png project_id: 45d2b228-25681789-2dbe-42d7-8310-491ab3ab360f media_resource: id: 29b0a2c8-ecf4-4d25-834d-fa551be8bc67 file_name: LogoTest.png mime_type: image/png created_at: '2024-05-22T11:57:48.475643Z' enabled: true form_instances_counter: 0 observations_counter: 0 created_at: '2024-05-22T11:57:50.396692Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-22T11:57:50.396692Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: b2c569b7-566a-4b60-b3a9-008d117fe59d name: postman.png project_id: 45d2b228-25681789-2dbe-42d7-8310-491ab3ab360f media_resource: id: 41a26f90-fa62-49e7-8758-c2115265e0e2 file_name: postman.png mime_type: image/png created_at: '2024-05-22T11:57:48.47598Z' enabled: true form_instances_counter: 0 observations_counter: 0 created_at: '2024-05-22T11:57:50.396858Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-22T11:57:50.396858Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a need_to_relaunch: true continuous_token: 0|2 count: 2 total_count: 5 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' post: operationId: locationsCreatePlans summary: Create plans description: "Plans will be used in applications to localize items. You can specify where to add the plans in your hierarchy\ \ by specifying its parent (a folder or the root).\n\n Adding a media to a plan is mandatory. You need to go through\ \ \"Upload medias\" to get a media ID.\n\n Here is information regarding plan formats that can be used:\n\n Plans\ \ Format \n Details \n\n PNG, JPG \n Image format with fixed size and zoom \n\n DWG, PDF \n Vector format with infinite\ \ zoom \n\n Endpoint mandatory infos \n Details \n\n project_Id \n the id of the project to be modified \n\n body\ \ mandatory infos \n Details \n\n name \n name of the plan \n\n media_id \n id of the media of the plan \n\n body\ \ optional infos \n Details \n\n folder_id \n the id of the parent folder in the hierarchy \n\n plan_id \n the id\ \ of the new plan (if omitted, an id should be automatcly affected)" tags: - Locations parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: name: media_id: responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 4569a529-ca5e-4def-a842-a353df901384 name: test 1 project_id: 234081e3-99f07760-3af6-4349-99d2-4e32319404ab media_resource: id: 9e03638e-2ddd-40b2-8656-d07f875edc35 file_name: lang1.png mime_type: image/png enabled: true created_at: '2022-11-29T14:01:41.0414517Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2022-11-29T14:01:41.0414517Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/plans/upload_bim: post: operationId: locationsUploadIfc summary: Upload IFC description: "Upload an IFC or RVT file part.\n\n Endpoint mandatory infos \n Details \n\n project_id \n id of the project\ \ \n\n form-data mandatory infos \n Details \n\n segment_index \n number of the chunk segment (first is 0) \n\n last_chunk\ \ \n true if it is the last chunk \n\n total_size \n total size of the file \n\n name \n name of the file \nwith ifc\ \ or rvt extension \n\n folder_id \n id of the parent folder \n\n id \n id of the new plan \nshould not exist \n\n\ \ stream \n chunk content" tags: - Locations parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: multipart/form-data: schema: type: object properties: segment_index: type: string description: chunk segment number first = 0 last_chunk: type: string description: is it the last segment ? total_size: type: string description: total size of the file stream: type: string description: chunk segment name: type: string description: name of the file folder_id: type: string description: if of parent folder id: type: string description: Id of the new plan responses: '200': description: OK content: application/json: schema: type: object examples: Upload_Ifc: value: id: 25a33d45-f93f-400b-bd6d-339bc2eb6a32 name: ok.rvt project_id: 61f1177e-2b78b3f1-598d-4cb4-8ac1-85f4461354e9 media_resource: id: 15149c74-a8b5-4416-aba5-173239395d0e file_name: ok.rvt mime_type: bim created_at: '2024-03-21T14:47:22.7458688Z' enabled: true created_at: '2024-03-21T14:47:22.5626664Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-03-21T14:47:22.7557876Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/plans/{plan_id}: get: operationId: locationsGetPlan summary: Get plan description: "Given the plan ID, you can get its media details and then download it.\n\n You need to go through \"Get\ \ media\" to extract it with the media_resource ID.\n\n Endpoint mandatory infos \n Details \n\n project_id \n the\ \ id of the project to be modified \n\n plan_id \n the id of the plan to be checked" tags: - Locations parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: plan_id in: path required: true schema: type: string description: Path variable `plan_id` as published in the collection. responses: '200': description: Success '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' put: operationId: locationsUpdatePlan summary: Update plan description: "Update an existing plan in your project:\n\n Name\n\n Move it to another folder\n\n Update media\n\n Endpoint\ \ mandatory infos \n Details \n\n project_Id \n the id of the project to be modified \n\n body optional infos \n Details\ \ \n\n name \n new name of the plan \n\n folder_id \n id of the new parent folder \n\n media_id \n id of the new media\ \ of the plan" tags: - Locations parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: plan_id in: path required: true schema: type: string description: Path variable `plan_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: name: folder_id: responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 4569a529-ca5e-4def-a842-a353df901384 name: Test 2 project_id: 234081e3-99f07760-3af6-4349-99d2-4e32319404ab media_resource: id: 9e03638e-2ddd-40b2-8656-d07f875edc35 file_name: lang1.png mime_type: image/png enabled: true form_instances_counter: 0 observations_counter: 0 created_at: '2022-11-29T14:01:41.041451Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2022-11-29T14:08:30.8753297Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' delete: operationId: locationsDeletePlan summary: Delete plan description: "You can delete an existing plan in your project.\n\n Details \n\n project_Id \n the id of the project\ \ to be modified \n\n plan_id \n the id of the plan" tags: - Locations parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: plan_id in: path required: true schema: type: string description: Path variable `plan_id` as published in the collection. responses: '200': description: Success '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/plansfromdoc: post: operationId: locationsCreatePlansFromDocument summary: Create plans from document description: "You can create a plan from a document.\n\n Endpoint mandatory infos \n Details \n\n project_Id \n the\ \ id of the project to be modified \n\n body mandatory infos \n Details \n\n document_id \n id of the document \n\n\ \ body optional infos \n Details \n\n folder_id \n the id of the parent folder in the hierarchy \n\n plan_id \n the\ \ id of the new plan (if omitted, an id should be automatcly affected) \n\n name \n name of the plan (default to document\ \ name)" tags: - Locations parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: document_id: name: my new plan responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: a65556b5-c7ba-463b-9925-ac779cca24c2 name: my new plan project_id: 22f5e75f-e661b6e8-d867-446b-bb5a-f213c82d603b media_resource: id: ac59eb17-b53c-4b46-b8cc-d95a1a3cd029 file_name: LIZE 7A PRO IND4 07092021 PLAN MASSE.pdf mime_type: application/pdf created_at: '2024-02-08T10:37:18.9095803Z' enabled: true created_at: '2024-02-08T10:37:18.921824Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-02-08T10:37:18.921824Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/remove-members: post: operationId: projectMembersManagementRemoveMembersInAProject summary: Remove members in a project description: "You can remove users from a project.\n\n Endpoint mandatory infos \n Details \n\n projectId \n the id\ \ of the project to be modified \n\n body mandatory infos \n Details \n\n List of user ids to be removed" tags: - Project members management parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: user_ids: - the_user_id - another_user_id responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: project_roles: - user_ids: - 19727e12-e5b6df02-625b-47f2-be7a-69622f45e73f - 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a id: a5403a10-6cf2-4a1f-84d1-c772f63594c7 names: - language: th translation: ผู้แก้ไข - language: pt translation: Editor - language: ca translation: Editor - language: fr translation: Éditeur - language: nl translation: Editor - language: it translation: Editor - language: vi translation: Biên tập viên - language: de translation: Editor - language: es translation: Editor - language: en translation: Editor - language: zh translation: 编辑 - language: ja translation: 編集者 descriptions: - language: nl translation: Inhoud aanmaken & bewerken - language: vi translation: Tạo và chỉnh sửa nội dung - language: th translation: สร้างและแก้ไขเนื้อหา - language: es translation: Crear y editar contenido - language: pt translation: Criar e editar conteúdos - language: ja translation: コンテンツの作成と編集 - language: it translation: Crea e modifica contenuti - language: de translation: Erstellen und Bearbeiten von Inhalten - language: fr translation: Créer et modifier du contenu - language: zh translation: 创建和编辑内容 - language: ca translation: Crea i edita el contingut - language: en translation: Create & Edit content created_at: '2021-08-02T14:07:44.009581Z' created_by: 022df861-cb019c2d-b420-4784-ab86-dc01fdb5812f updated_at: '2022-05-09T16:55:23.586739Z' updated_by: 022df861-cb019c2d-b420-4784-ab86-dc01fdb5812f count: 1 total_count: 1 limit: 0 offset: 0 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/restore: post: operationId: projectDetailsRestoreAProject summary: Restore a project description: "You can restore a project.\n\n The project_id must be stored on your side before deletion, as it is not\ \ possible to retrieve the list of deleted projects from an organization.\n\n Endpoint mandatory info \n Details \n\ \n project_id \n The ID of the project you want to delete" tags: - Project details parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '204': description: No Content '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/roles: get: operationId: projectMembersManagementGetProjectRoles summary: Get project roles description: "You can here get project roles format that you will associate with new members.\n\n To ensure confidence\ \ and project management we come with different of project roles.\n\n See here to learn more.\n\n Endpoint mandatory\ \ infos \n Details \n\n project_id \n the id of the project to be modified \n\n Query params optionals \n\n see Commmon\ \ behaviors / differential" tags: - Project members management parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: project_roles: - id: 233984d5-4c7d-49c2-9022-ff72a4ec06a2 names: - language: en translation: Project editor - id: 2343dc76-8b0e-43a6-89e1-f6902a623507 names: - language: en translation: Limited group editor - id: 3693aea1-2625-4eb2-94a2-3cba0ea4c7bf names: - language: en translation: Group editor - user_ids: - ec3ee0a7-a38dcc7f-42e6-4fef-9a90-4858d025fd0e id: e83b6ed9-d9a9-4108-8fc1-3a9bce4aa329 names: - language: en translation: Project admin count: 4 total_count: 4 limit: 10 offset: 0 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/status: get: operationId: projectLibrariesGetProjectObservationStatus summary: Get project observation status description: "For a given project, you can list all the available observation statuses.\n\n Details \n\n projectId \n\ \ the id of the project to be modified \n\n Query params optionals \n\n see Commmon behaviors / differential" tags: - Project libraries parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: statuses: - id: f3fd7fd9-2fe1-4451-ba9a-66c73f5d5979 position: 3 color: '#E94F3D' is_default: false enabled: false names: - language: en translation: testLucPut - language: fr translation: testLucPut created_at: '2024-05-22T09:26:36.488199Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-23T13:32:20.522241Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: a7462d5b-a0ab-4fb0-a984-54ba62a9f02e position: 0 color: '#898989' is_default: true enabled: true names: - language: ja translation: New - language: ko translation: New - language: vi translation: New - language: fr translation: New - language: nl translation: New - language: ca translation: New - language: zh translation: New - language: es translation: New - language: it translation: New - language: th translation: New - language: en translation: New - language: de translation: New - language: pt translation: New - language: da translation: New - language: cs translation: New - language: sv translation: New - language: zf translation: New - language: pl translation: New - language: sl translation: New - language: fi translation: New - language: hu translation: New - language: ru translation: New - language: 'no' translation: New - language: he translation: New created_at: '2024-05-22T09:26:36.684002Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-23T13:32:20.572173Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a need_to_relaunch: true continuous_token: 0|2 count: 2 total_count: 5 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/statuses/{status_id}/next-statuses: get: operationId: projectLibrariesGetProjectObservationNextStatus summary: Get project observation next status description: "For a given project, you can get the next statuses following your workflow choices for a given status.\n\ \n Details \n\n projectId \n the id of the project to be modified \n\n status_id \n the id of the status \n\n Query\ \ params optionals \n\n see Commmon behaviors / differential" tags: - Project libraries parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: status_id in: path required: true schema: type: string description: Path variable `status_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: statuses: - id: 65ccd56b-93c0-476a-a5cf-f4610361cfca position: 1 color: '#4CABF2' is_default: false enabled: true names: - language: ja translation: To do - language: fr translation: To do - language: th translation: To do - language: ca translation: To do - language: it translation: To do - language: pt translation: To do - language: nl translation: To do - language: es translation: To do - language: vi translation: To do - language: zh translation: To do - language: de translation: To do - language: ko translation: To do - language: en translation: To do - language: he translation: To do - language: cs translation: To do - language: pl translation: To do - language: ru translation: To do - language: da translation: To do - language: hu translation: To do - language: sl translation: To do - language: fi translation: To do - language: zf translation: To do - language: sv translation: To do - language: 'no' translation: To do created_at: '2024-05-22T09:26:36.686019Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-23T13:32:20.572349Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 74eac5cd-9986-4367-b137-a48778f7d1de position: 3 color: '#E94F3D' is_default: false enabled: true names: - language: de translation: TestLucDiv - language: vi translation: TestLucDiv - language: sv translation: TestLucDiv - language: sl translation: TestLucDiv - language: ru translation: TestLucDiv - language: ko translation: TestLucDiv - language: cs translation: TestLucDiv - language: ca translation: TestLucDiv - language: ja translation: TestLucDiv - language: pt translation: TestLucDiv - language: nl translation: TestLucDiv - language: da translation: TestLucDiv - language: he translation: TestLucDiv - language: th translation: TestLucDiv - language: pl translation: TestLucDiv - language: es translation: TestLucDiv - language: fi translation: TestLucDiv - language: fr translation: TestLucDiv - language: en translation: TestLucDiv - language: 'no' translation: TestLucDiv - language: hu translation: TestLucDiv - language: it translation: TestLucDiv - language: zh translation: TestLucDiv - language: zf translation: TestLucDiv created_at: '2024-05-23T13:32:20.574164Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-23T13:32:20.574164Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: bbdea31d-a3de-4437-83fa-0b31cda925dc position: 2 color: '#FF8029' is_default: false enabled: true names: - language: ca translation: In Progress - language: th translation: In Progress - language: en translation: In Progress - language: pt translation: In Progress - language: ja translation: In Progress - language: nl translation: In Progress - language: ko translation: In Progress - language: es translation: In Progress - language: zh translation: In Progress - language: vi translation: In Progress - language: it translation: In Progress - language: de translation: In Progress - language: fr translation: In Progress - language: cs translation: In Progress - language: fi translation: In Progress - language: sl translation: In Progress - language: he translation: In Progress - language: da translation: In Progress - language: 'no' translation: In Progress - language: sv translation: In Progress - language: hu translation: In Progress - language: ru translation: In Progress - language: zf translation: In Progress - language: pl translation: In Progress created_at: '2024-05-22T09:26:36.681583Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-23T13:32:20.572412Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a count: 3 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/trades: get: operationId: projectLibrariesGetProjectTrades summary: Get project trades description: "Given the project, you can get the list of trades.\n\n Endpoint mandatory infos \n Details \n\n projectId\ \ \n the id of the project to be modified \n\n Query params optionals \n\n see Commmon behaviors / differential" tags: - Project libraries parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: trades: - id: eb8ed4ee-d788-46a4-b537-ee05d2a292ff enabled: true names: - language: en translation: Carrelage module_id: fcef77d8-21a9-4594-9bf7-6b06679fe1bb created_at: '2024-05-22T09:26:38.185112Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-22T09:26:38.185112Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: ee676e7e-c9ba-4751-9565-330fe38c08a2 enabled: true names: - language: en translation: CVC/Plomberie module_id: fcef77d8-21a9-4594-9bf7-6b06679fe1bb created_at: '2024-05-22T09:26:38.185499Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-05-22T09:26:38.185499Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a need_to_relaunch: true continuous_token: 0|2 count: 2 total_count: 27 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' post: operationId: modulesObservationsCreateTrade summary: Create trade description: "Create a category for a given module.\n\n Details \n\n project_Id \n the id of the project to be modified\ \ \n\n body mandatory infos \n Details \n\n module_id \n ID of the module who use this trades \n\n names \n list of\ \ language and names translation" tags: - Modules parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: module_id: names: - language: en translation: - language: fr translation: responses: '200': description: OK content: application/json: schema: type: object examples: Create_Trade: value: id: 274e9196-fd0f-4d26-a54c-ec71565c556d enabled: true names: - language: en translation: job - language: fr translation: boulot module_id: 4fa1469c-0849-4f69-beb8-e3590aa4fd05 '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/trades/module: get: operationId: modulesObservationsGetProjectTradesByModule summary: Get project trades by module description: "Given the project and a module you can get the list of the trades for this module\n\n Endpoint mandatory\ \ infos \n Details \n\n projectId \n the id of the project to be modified \n\n Query mandatory parameters \n\n module_id\ \ \n id of the module" tags: - Modules parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: trades: - id: 40f66c0e-b63e-4b45-82b3-1ff9d2df2ed9 enabled: true name: azerty names: - language: fr translation: azerty module_id: 6c77e442-ee7f-4648-9873-fe502c93583e created_at: '2025-01-30T13:33:25.702254Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.702254Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 9f2ac638-d513-4d5d-9602-812735e42b6e enabled: true name: Carrelage names: - language: en translation: Carrelage module_id: 6c77e442-ee7f-4648-9873-fe502c93583e created_at: '2025-01-30T13:33:25.703578Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.703578Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 072a0a35-3857-4536-84c1-a54b6439f03c enabled: true name: CVC/Plomberie names: - language: en translation: CVC/Plomberie module_id: 6c77e442-ee7f-4648-9873-fe502c93583e created_at: '2025-01-30T13:33:25.70422Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.70422Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 7bf9aa40-7c1e-4585-8b30-05aacb2712d0 enabled: true name: electrician names: - language: fr translation: electricien - language: en translation: electrician module_id: 6c77e442-ee7f-4648-9873-fe502c93583e created_at: '2025-01-30T13:33:25.704809Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.704809Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: b554b587-87dd-4d04-96f7-31139ee48d31 enabled: true name: ess create 2 names: - language: fr translation: ess create 2 module_id: 6c77e442-ee7f-4648-9873-fe502c93583e created_at: '2025-01-30T13:33:25.705722Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.705722Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 58e41c75-7bd3-4af2-a296-9a975819ecf0 enabled: true name: ess create 3 names: - language: fr translation: ess create 3 module_id: 6c77e442-ee7f-4648-9873-fe502c93583e created_at: '2025-01-30T13:33:25.706252Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.706252Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 33de83fb-370a-4bd6-87a2-816f693db94d enabled: true name: et un autre nom names: - language: en translation: et un autre nom module_id: 6c77e442-ee7f-4648-9873-fe502c93583e created_at: '2025-01-30T13:33:25.707129Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.707129Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 97750629-c26f-465b-b8f3-1ec0145d2ef3 enabled: true name: Gros oeuvre names: - language: en translation: Gros oeuvre module_id: 6c77e442-ee7f-4648-9873-fe502c93583e created_at: '2025-01-30T13:33:25.707696Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.707696Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: ffa2f451-e10e-4f4b-ba0a-ee5e426424d8 enabled: true name: Menuiseries extérieures names: - language: en translation: Menuiseries extérieures module_id: 6c77e442-ee7f-4648-9873-fe502c93583e created_at: '2025-01-30T13:33:25.70814Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.70814Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 172de6fc-efde-4d95-8a8a-422da2813efc enabled: true name: Menuiseries intérieures names: - language: en translation: Menuiseries intérieures module_id: 6c77e442-ee7f-4648-9873-fe502c93583e created_at: '2025-01-30T13:33:25.719089Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.719089Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 5283a74e-c1d6-4819-94a8-95719662ec73 enabled: true name: Peinture names: - language: en translation: Peinture module_id: 6c77e442-ee7f-4648-9873-fe502c93583e created_at: '2025-01-30T13:33:25.719552Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.719552Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 70c6e155-3b61-4975-9820-284e0ccb3bd4 enabled: true name: plumber names: - language: fr translation: plombier - language: en translation: plumber module_id: 6c77e442-ee7f-4648-9873-fe502c93583e created_at: '2025-01-30T13:33:25.720002Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.720002Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 7a8ea5b4-b656-49bc-bcbc-0c05b6a814a7 enabled: true name: test 2025-01-27 names: - language: en translation: test 2025-01-27 module_id: 6c77e442-ee7f-4648-9873-fe502c93583e created_at: '2025-01-30T13:33:25.720526Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.720526Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 2039abb7-0630-402b-809e-65373b4ff5ac enabled: true name: Test lang en names: - language: fr translation: Test Lang - language: en translation: Test lang en module_id: 6c77e442-ee7f-4648-9873-fe502c93583e created_at: '2025-01-30T13:33:25.720987Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.720987Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 11fab9e4-88f1-45b2-b57a-fbe0092bdedf enabled: true name: Test Luc Orga 1 names: - language: fr translation: Test Luc Orga 1 module_id: 6c77e442-ee7f-4648-9873-fe502c93583e created_at: '2025-01-30T13:33:25.721562Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.721562Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 1722239b-6f44-4397-afcf-97ac7c68babf enabled: true name: Test Luc Orga 2 bis names: - language: fr translation: Test Luc Orga 2 bis module_id: 6c77e442-ee7f-4648-9873-fe502c93583e created_at: '2025-01-30T13:33:25.72193Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.72193Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 3be9458a-d17e-42c5-8f6c-d0382cba5801 enabled: true name: Test Luc Orga 50 names: - language: fr translation: Test Luc Orga 50 module_id: 6c77e442-ee7f-4648-9873-fe502c93583e created_at: '2025-01-30T13:33:25.722275Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.722275Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 1f9c241f-31a8-4447-aed9-40b21aae62b5 enabled: true name: Un super nom trop nul names: - language: en translation: Un super nom trop nul module_id: 6c77e442-ee7f-4648-9873-fe502c93583e created_at: '2025-01-30T13:33:25.722623Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.722623Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: f45ad375-8412-49b3-b6ab-0031b2d7776d enabled: true name: wireless names: - language: en translation: wireless - language: fr translation: sans fil module_id: 6c77e442-ee7f-4648-9873-fe502c93583e created_at: '2025-01-30T13:33:25.723052Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.723052Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/trades/{trade_id}: get: operationId: modulesObservationsGetProjectTrade summary: Get project trade description: "Given the project, you can get the details of a trade.\n\n Details \n\n projectId \n the id of the project\ \ to be modified \n\n tradeId \n Id of the trade to be verified" tags: - Modules parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: trade_id in: path required: true schema: type: string description: Path variable `trade_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 907b66bb-cf34-4813-9ac8-3eb7d18a9714 enabled: true names: - language: en translation: Peinture module_id: 31193b47-8561-412f-a999-d91742f9d401 created_at: '2023-10-10T09:50:43.023461Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-10-10T09:50:43.023461Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' /projects/{project_id}/trades/{trade_id}/commonobservations: get: operationId: modulesObservationsGetProjectCommonObservationsByTrade summary: Get project common observations by trade description: "For a given project you can list the model (= common observation) available for a trade\n\n Endpoint mandatory\ \ infos \n Details \n\n project_id \n the id of the project to be modified \n\n trade_id \n the id the the trade" tags: - Modules parameters: - name: project_id in: path required: true schema: type: string description: Path variable `project_id` as published in the collection. - name: trade_id in: path required: true schema: type: string description: Path variable `trade_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Get_project_common_observations_by_trade: value: common_observations: - id: 18b3b5ee-540e-4e46-ae73-62cfba6ca46d trade_id: 9f2ac638-d513-4d5d-9602-812735e42b6e name: Coupe à réaliser names: - language: fr translation: Coupe à réaliser enabled: true created_at: '2025-01-30T13:33:25.970997Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.970997Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 7353852a-9d48-41c2-b3bb-e6beca56a8b4 trade_id: 9f2ac638-d513-4d5d-9602-812735e42b6e name: Dégradation à traiter names: - language: fr translation: Dégradation à traiter enabled: true created_at: '2025-01-30T13:33:25.9724Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.9724Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: dc19516e-d4c8-4d82-a1cb-cc1e899ac832 trade_id: 9f2ac638-d513-4d5d-9602-812735e42b6e name: Joint à poser names: - language: fr translation: Joint à poser enabled: true created_at: '2025-01-30T13:33:25.977333Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.977333Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 47dac686-4942-4720-9021-d61a7294c1c4 trade_id: 9f2ac638-d513-4d5d-9602-812735e42b6e name: Joint à reprendre names: - language: fr translation: Joint à reprendre enabled: true created_at: '2025-01-30T13:33:25.977736Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:25.977736Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: ef387aba-6a13-4d7e-bcdc-caf2278207b9 trade_id: 9f2ac638-d513-4d5d-9602-812735e42b6e name: Sol à nettoyer names: - language: fr translation: Sol à nettoyer enabled: true created_at: '2025-01-30T13:33:26.052226Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:33:26.052226Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a '400': description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml. content: application/json: schema: $ref: '#/components/schemas/ApiError' '401': description: Unauthorized — the API key or user token is missing or invalid. content: application/json: schema: $ref: '#/components/schemas/ApiError' '500': description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope. content: application/json: schema: $ref: '#/components/schemas/ApiError' components: securitySchemes: apiKey: type: apiKey in: header name: X-API-Key description: Organization API key issued by Finalcad to organizations on an Enterprise licence. Sent on every call. tokenAuth: type: apiKey in: header name: Authorization description: '`Authorization: token `, or `Authorization: bearer ` for the legacy user-token flow (POST /auth).' schemas: ApiError: type: object description: Finalcad One error envelope. `api_code` is either a static code (mostly 4xx, e.g. INVALID_INSTANCE_STATE) or a constructed code of the form {ProcessCode}_ERR{n} / {ProcessCode}_WRN{n} (mostly 5xx). properties: statut: type: integer description: HTTP status code, repeated in the body (spelled `statut`). api_code: type: string description: Internal Finalcad API error code. message: type: string description: Short explanation of the abnormality encountered. data: type: object description: Complementary data to help understand the error. additionalProperties: true Paginated: type: object description: Finalcad's shared pagination / differential envelope. Re-sending the last continuous_token returns only elements added, modified or deleted since that call. properties: need_to_relaunch: type: boolean description: True when more elements remain to retrieve. continuous_token: type: string description: Opaque cursor to send on the next call. count: type: integer description: Number of elements returned by this call. total_count: type: integer description: Total number of elements across all calls. limit: type: integer description: Maximum elements per page. Default 50. offset: type: integer description: Offset paging; must be a multiple of limit. parameters: AcceptLanguage: name: Accept-Language in: header required: false schema: type: string default: en description: Language the API operates in. Allowed values come from GET /languages. Default English (en).