Finalcad Modules API

The Modules API from Finalcad — 20 operation(s) for modules.

Operations 24

GET /modules/colors Get module colors #
GET /modules/icons Get module icons #
GET /modules/suggestions Get module suggestions #
GET /projects/{project_id}/categories Get form categories #
POST /projects/{project_id}/commonobservations Create common observation #
GET /projects/{project_id}/commonobservations/{commonObs_id} Get project common observation #
GET /projects/{project_id}/forms-modules Get form modules #
PUT /projects/{project_id}/forms-modules/{moduleId} Update form module #
GET /projects/{project_id}/forms-modules/{moduleId} Get form module #
POST /projects/{project_id}/modules Create observation module #
GET /projects/{project_id}/modules Get observation modules #
POST /projects/{project_id}/modules/forms-suggestion Create form module by suggestion #
POST /projects/{project_id}/modules/meetings Enable meeting module #
GET /projects/{project_id}/modules/meetings/{module_id} Get meeting module #
PUT /projects/{project_id}/modules/meetings/{module_id} Update meeting module #
POST /projects/{project_id}/modules/suggestion Create observation module based on suggestions #
PUT /projects/{project_id}/modules/{moduleId} Modify observation module #
GET /projects/{project_id}/modules/{moduleId} Get observation module #
POST /projects/{project_id}/trades Create trade #
GET /projects/{project_id}/trades/module Get project trades by module #
GET /projects/{project_id}/trades/{trade_id} Get project trade #
GET /projects/{project_id}/trades/{trade_id}/commonobservations Get project common observations by trade #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/finalcad-modules-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

finalcad-modules-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Finalcad Modules API
  version: '2.41'
  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/
  description: 'Operations tagged Modules across 2 of this provider''s published API definitions: finalcad-libraries-openapi.yml, finalcad-projects-openapi.yml. Each path carries the servers of the definition it was published in.'
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: Modules
paths:
  /modules/colors:
    get:
      operationId: modulesGetModuleColors
      summary: Get module colors
      description: Get all the colors usable for module creation.
      tags:
      - Modules
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              examples:
                Get_modules_colors:
                  value:
                    icons:
                    - code: '#E94F3D'
                    - code: '#ED75A0'
                    - code: '#7783FF'
                    - code: '#3B7CDE'
                    - code: '#92D8FF'
                    - code: '#01D194'
                    - code: '#C0DF43'
                    - code: '#F7CE46'
                    - code: '#FFC267'
                    - code: '#FF8029'
                    count: 0
                    total_count: 0
                    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'
    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.
  /modules/icons:
    get:
      operationId: modulesGetModuleIcons
      summary: Get module icons
      description: Get all the icon names usable for module creation.
      tags:
      - Modules
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              examples:
                Get_modules_icons:
                  value:
                    icons:
                    - name: typePin
                    - name: alert
                    - name: clipboard
                    - name: bookOpen
                    - name: draw
                    - name: checkCircle
                    - name: filesAndFolders
                    - name: people
                    - name: alertTriangle
                    - name: measure
                    - name: plan
                    - name: camera
                    - name: clock
                    - name: calendar
                    - name: flag
                    - name: eye
                    - name: help
                    - name: info
                    - name: key
                    - name: signature
                    - name: rail
                    - name: road
                    - name: zap
                    - name: euro
                    - name: search
                    - name: truck
                    - name: cardboard
                    - name: focus
                    - name: parcel
                    - name: star
                    - name: helmet
                    - name: clean
                    - name: environment
                    - name: brush
                    - name: hammer
                    - name: bricks
                    count: 0
                    total_count: 0
                    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'
    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.
  /modules/suggestions:
    get:
      operationId: modulesGetModuleSuggestions
      summary: Get module suggestions
      description: Get all the predefined modules for custom module creation.
      tags:
      - Modules
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              examples:
                Get_modules_suggestions:
                  value:
                    suggestions:
                    - id: 44d459d4-fa20-4484-b4bf-fd520c459566
                      name: Observations
                      icon: alert
                      color: '#E94F3D'
                      type: Observations
                      names:
                      - language: en
                        translation: Observations
                      - language: fr
                        translation: Observations
                      - language: es
                        translation: Observaciones
                    - id: 117f1c84-e69d-4429-baf9-74e052f5e0bc
                      name: Forms
                      icon: clipboard
                      color: '#F7CE46'
                      type: Forms
                      names:
                      - language: en
                        translation: Forms
                      - language: fr
                        translation: Formulaires
                      - language: es
                        translation: Formularios
                    - id: 7fe77495-2ae5-4345-b647-f455be6a19d4
                      name: Tasks
                      icon: checklist
                      color: '#3B7CDE'
                      type: Observations
                      names:
                      - language: en
                        translation: Tasks
                      - language: fr
                        translation: Tâches
                      - language: es
                        translation: Tareas
                    - id: 125ae973-3e43-4862-9af4-3cb13dcac81c
                      name: Quality
                      icon: star
                      color: '#01D194'
                      type: Observations
                      names:
                      - language: en
                        translation: Quality
                      - language: fr
                        translation: Qualité
                      - language: es
                        translation: Calidad
                    - id: 3fd4f4af-089b-4e06-a924-32ee4f600f02
                      name: Security
                      icon: helmet
                      color: '#FF8029'
                      type: Observations
                      names:
                      - language: en
                        translation: Security
                      - language: fr
                        translation: Securité
                      - language: es
                        translation: Seguridad
                    - id: eab12a4a-7b44-46c1-abbb-9a6624369335
                      name: Hygiene
                      icon: clean
                      color: '#92D8FF'
                      type: Observations
                      names:
                      - language: en
                        translation: Hygiene
                      - language: fr
                        translation: Hygiène
                      - language: es
                        translation: Higiene
                    - id: 1d0ae170-f499-4649-b17d-d44008220600
                      name: Environment
                      icon: environment
                      color: '#7FCE1A'
                      type: Observations
                      names:
                      - language: en
                        translation: Environment
                      - language: fr
                        translation: Environnemment
                      - language: es
                        translation: Medio Ambiente
                    - id: 478eb22c-30ee-4691-b27e-f2539f644794
                      name: Quote
                      icon: euro
                      color: '#7783FF'
                      type: Observations
                      names:
                      - language: en
                        translation: Quote
                      - language: fr
                        translation: Chiffrage
                      - language: es
                        translation: Presupuesto
                    - id: be73ba88-1584-4d87-98a2-fee38da1b467
                      name: Additional works
                      icon: brush
                      color: '#FFC267'
                      type: Observations
                      names:
                      - language: en
                        translation: Additional works
                      - language: fr
                        translation: Travaux supplémentaires
                      - language: es
                        translation: Trabajos adicionales
                    - id: 391ede05-46a9-4676-99d7-cfe0d07f8a75
                      name: Construction diary
                      icon: diary
                      color: '#4CABF2'
                      type: Observations
                      names:
                      - language: en
                        translation: Construction diary
                      - language: fr
                        translation: Journal de chantier
                      - language: es
                        translation: Diario de obra
                    - id: e53cc00d-4980-409e-9a52-40706fd77b5f
                      name: Equipment
                      icon: hammer
                      color: '#01D194'
                      type: Observations
                      names:
                      - language: en
                        translation: Equipment
                      - language: fr
                        translation: Équipement
                      - language: es
                        translation: Equipamiento
                    - id: 70df7ea5-7ef6-4b71-9b52-848ec968a680
                      name: Materials
                      icon: bricks
                      color: '#FF8029'
                      type: Observations
                      names:
                      - language: en
                        translation: Materials
                      - language: fr
                        translation: Matériaux
                      - language: es
                        translation: Materiales
                    - id: bbb01e29-efb0-4a11-9ab7-63849c58fd48
                      name: Staff
                      icon: people
                      color: '#ED75A0'
                      type: Observations
                      names:
                      - language: en
                        translation: Staff
                      - language: fr
                        translation: 'Personnel '
                      - language: es
                        translation: Colaboradores
                    count: 0
                    total_count: 0
                    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'
    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.
  /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'
    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.
  /projects/{project_id}/commonobservations:
    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: <string>
              - language: fr
                translation: <string>
      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'
    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.
  /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
              

# --- truncated at 32 KB (99 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/finalcad/refs/heads/main/openapi/finalcad-modules-api-openapi.yml