Finalcad Libraries API

openapi: 3.2.0
info:
  title: Finalcad Libraries 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 Libraries across 2 of this provider''s published API definitions: finalcad-libraries-openapi.yml, finalcad-organizations-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: Libraries
paths:
  /time-zones:
    get:
      operationId: getListOfTimeZones
      summary: Get list of time zones
      description: "Each project is linked to a specific time zone.\n\n By default, if not specified, Paris time is chosen. To create your project, you may want to select a different time zone.\n\n To assist you in this process, you can request the list of available time zones here."
      tags:
      - Libraries
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              examples:
                Success:
                  value:
                    time_zones:
                    - id: Pacific/Niue
                      display_name: (UTC-11:00) Niue Time
                      standard_name: Niue Time
                      utc_offset: '-11:00:00'
                    - id: Pacific/Midway
                      display_name: (UTC-11:00) Samoa Standard Time
                      standard_name: Samoa Standard Time
                      utc_offset: '-11:00:00'
                    - id: Pacific/Pago_Pago
                      display_name: (UTC-11:00) Samoa Standard Time
                      standard_name: Samoa Standard Time
                      utc_offset: '-11:00:00'
                    - id: Pacific/Rarotonga
                      display_name: (UTC-10:00) Cook Islands Standard Time
                      standard_name: Cook Islands Standard Time
                      utc_offset: '-10:00:00'
                    - id: Pacific/Honolulu
                      display_name: (UTC-10:00) Hawaii-Aleutian Standard Time
                      standard_name: Hawaii-Aleutian Standard Time
                      utc_offset: '-10:00:00'
                    - id: America/Adak
                      display_name: (UTC-10:00) Hawaii-Aleutian Standard Time
                      standard_name: Hawaii-Aleutian Standard Time
                      utc_offset: '-10:00:00'
                    - id: Pacific/Tahiti
                      display_name: (UTC-10:00) Tahiti Time
                      standard_name: Tahiti Time
                      utc_offset: '-10:00:00'
                    - id: Pacific/Marquesas
                      display_name: (UTC-09:30) Marquesas Time
                      standard_name: Marquesas Time
                      utc_offset: -09:30:00
                    - id: America/Nome
                      display_name: (UTC-09:00) Alaska Standard Time
                      standard_name: Alaska Standard Time
                      utc_offset: -09:00:00
                    - id: America/Anchorage
                      display_name: (UTC-09:00) Alaska Standard Time
                      standard_name: Alaska Standard Time
                      utc_offset: -09:00:00
                    count: 10
                    total_count: 425
                    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'
    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.
  /organizations/{organizationId}/common-observations:
    put:
      operationId: librariesObservationLibraryAddOrUpdateOrganizationCommonObservations
      summary: Add or update organization common observations
      description: "For a given category, you can add models to your library. For each, you can define translations. You can also update existing models.\n\n Compared to creation, you need to specify the ID of the ones you want to manage.\n\n Endpoint mandatory parameters \n Details \n\n organization_id \n id of your organization \n\n Body parameters \n Details \n\n a list of \n\n trade_id \n id of the category \n\n id \n id of the model if modified \n\n icon \n icon name \n\n names \n list of names and langages"
      tags:
      - Libraries
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
        description: Path variable `organizationId` as published in the collection.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              common_observations:
              - names:
                - language: en
                  translation: array
                - language: fr
                  translation: feed
                trade_id: <uuid>
                id: <uuid>
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              examples:
                Success:
                  value:
                    common_observations:
                    - trade_id: 6198a574-7b61-44b7-8142-903349d7c7ef
                      id: e7f3607b-be5a-4556-82e7-dc90e6f7db8a
                      names:
                      - language: fr
                        translation: Prises
                      - language: en
                        translation: Outlets
                    - trade_id: 9adcae91-2db4-4a7f-840c-aaf00c980d7c
                      id: c2394c8d-47c5-4c14-96e7-0b805d550bb7
                      names:
                      - language: fr
                        translation: Evacuations
                      - language: en
                        translation: Draining
        '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: librariesObservationLibraryDeleteOrganizationCommonObservations
      summary: Delete organization common observations
      description: "You can provide the list of model IDs and their corresponding category IDs that you want to remove from your library. Those values won't be used as default project values, but they will still be usable in existing projects.\n\n Endpoint mandatory parameters \n Details \n\n organization_id \n id of your organization \n\n Body parameters \n Details \n\n a list of \n\n id \n id of the model \n\n trade_id \n id of the category"
      tags:
      - Libraries
      parameters:
      - name: organizationId
        in: path
        required: true
        schema:
          type: string
        description: Path variable `organizationId` as published in the collection.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
            example:
              common_observations:
              - id: <uuid>
                trade_id: <uuid>
      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'
    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.
  /organizations/{organization_id}/forms:
    get:
      operationId: librariesFormTemplatesGetOrganizationFormTemplates
      summary: Get organization form templates
      description: "Get the list of form templates in your organization.\n\n Endpoint mandatory parameters \n Details \n\n organization_id \n id of your organization \n\n Query params optionals \n\n limit \n number max of elements to get \n\n offset \n index of the first returned element"
      tags:
      - Libraries
      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:
                    form_templates:
                    - id: 0401e23a-5031-419f-9f93-aef05fc572ef
                      names:
                      - language: en
                        translation: Formulaire avec tous les champs
                      form_template_languages:
                      - language: en
                        is_default: true
                      visibility: Available
                    - id: 68cf2910-1044-4e6c-a11b-a4b319f8da98
                      names:
                      - language: en
                        translation: mon_modele
                      form_template_languages:
                      - language: fr
                        is_default: true
                      visibility: Available
                    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'
    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.
  /organizations/{organization_id}/forms/{form_id}:
    get:
      operationId: librariesFormTemplatesGetFormTemplate
      summary: Get form template
      description: "You can get a complete form template description.\n\n Endpoint mandatory infos \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)"
      tags:
      - Libraries
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable `organization_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: Accept-Language
        in: header
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              examples:
                Get_form_template:
                  value:
                    id: 6146039d-8734-48e5-bf2b-5034c63a7bbc
                    names:
                    - locale: fr
                      translation: FormTemplate dans WS
                    created_at: '2024-04-30T13:34:01.728Z'
                    created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a
                    updated_at: '2024-04-30T13:35:07.052Z'
                    updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a
                    enabled: false
                    version: 1
                    form_statuses:
                    - id: 290d3800-1b2d-47bc-a590-8986e9f796b4
                      color: '#49CB0C'
                      num: 1
                      default_status: false
                      names:
                      - locale: th
                        translation: ทำเสร็จแล้ว
                      - locale: vi
                        translation: Đã hoàn thành
                      - locale: es
                        translation: Realizado
                      - locale: de
                        translation: Erledigt
                      - locale: ca
                        translation: Fet
                      - locale: fr
                        translation: Terminé
                      - locale: zh
                        translation: 已完成
                      - locale: nl
                        translation: Gedaan
                      - locale: ja
                        translation: 完了
                      - locale: it
                        translation: Fatto
                      - locale: en
                        translation: Done
                      - locale: pt
                        translation: Feito
                    - id: 31fcfbca-82e5-4010-a7e9-e0351560e70a
                      color: '#E94F3D'
                      num: 2
                      default_status: false
                      names:
                      - locale: nl
                        translation: Niet conform
                      - locale: ca
                        translation: No conforme
                      - locale: pt
                        translation: Não conforme
                      - locale: de
                        translation: Nicht konform
                      - locale: it
                        translation: Non conforme
                      - locale: vi
                        translation: Không tuân thủ
                      - locale: zh
                        translation: 不合要求
                      - locale: en
                        translation: Not Compliant
                      - locale: es
                        translation: No conforme
                      - locale: fr
                        translation: Non conforme
                      - locale: th
                        translation: ไม่เป็นไปตามข้อกำหนด
                      - locale: ja
                        translation: 対応不可
                    - id: ad9bc5a6-c774-4292-958c-045787968a1f
                      color: '#EBBB1C'
                      num: 0
                      default_status: true
                      names:
                      - locale: fr
                        translation: À faire
                      - locale: de
                        translation: Zu erledigen
                      - locale: zh
                        translation: 待办
                      - locale: th
                        translation: ที่ต้องทำ
                      - locale: ca
                        translation: Per fer
                      - locale: en
                        translation: To do
                      - locale: nl
                        translation: Te doen
                      - locale: ja
                        translation: するために
                      - locale: es
                        translation: Pendiente
                      - locale: it
                        translation: Da fare
                      - locale: pt
                        translation: Para fazer
                      - locale: vi
                        translation: Cần làm
                    - id: e792f411-093d-4fba-abdd-93a3af5e26da
                      color: '#264AA7'
                      num: 3
                      default_status: false
                      names:
                      - locale: fr
                        translation: Annulé
                    form_template:
                      id: 2ce76c9c-d083-4cf3-82f2-25150236a097
                      name: FormTemplate dans WS
                      version: 1
                      parts:
                      - id: f3a1b5b0-a9b1-4029-bc5f-2f05474ebf69
                        form_template_id: 2ce76c9c-d083-4cf3-82f2-25150236a097
                        name: Nom de la partie
                        num: 0
                        sections:
                        - id: 8017ce0e-8c55-47b0-9462-103c63d77c49
                          part_id: f3a1b5b0-a9b1-4029-bc5f-2f05474ebf69
                          name: Nom de la section
                          num: 0
                          qr_code: false
                          fields:
                          - id: ed90fc28-cbe9-4194-9f88-4c03a18e4485
                            form_template_section_id: 8017ce0e-8c55-47b0-9462-103c63d77c49
                            name: Entrez un nom de champ
                            num: 0
                            type_field_data: Text
                            type_field_presentation: SingleChoice
                            required: false
                            form_field_sa_control:
                              id: f658e05f-cbfa-4a3a-861d-52024331c5e7
                              form_field_id: ed90fc28-cbe9-4194-9f88-4c03a18e4485
                              na_values_allowed: true
                              presentation: RadioButton
                            form_field_choices:
                            - id: 53330627-6c44-43fe-a9e0-3eb8e754d302
                              form_field_id: ed90fc28-cbe9-4194-9f88-4c03a18e4485
                              name: Option 1
                              num: 1
                              is_default_value: false
                              evaluate_value: 3
                            - id: da7b9df8-0246-4a78-b138-4e21e1ed7cc6
                              form_field_id: ed90fc28-cbe9-4194-9f88-4c03a18e4485
                              name: Option 2
                              num: 2
                              is_default_value: false
                              evaluate_value: 3
                          - id: 4c79f526-d279-410f-ad62-3c1da3e8fafe
                            form_template_section_id: 8017ce0e-8c55-47b0-9462-103c63d77c49
                            name: Entrez un nom de champ
                            num: 1
                            type_field_data: Text
                            type_field_presentation: Paragraph
                            required: false
                            form_field_sa_text:
                              id: c16c788b-0a34-4963-8911-751933b5662f
                              form_field_id: 4c79f526-d279-410f-ad62-3c1da3e8fafe
                              only_text: false
                              case_sensitive: InitCapWholeText
                      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'
    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.
  /organizations/{organization_id}/forms/{form_id}/custom/infos:
    get:
      operationId: librariesFormTemplatesGetCustomTemplateAssociationInformation
      summary: Get custom template association information
      description: "Get the association between a form template and a custom report template.\n\n Endpoint mandatory parameters \n Details \n\n organization_id \n id of your organization \n\n form_id \n the id of the form template"
      tags:
      - Libraries
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable `organization_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.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              examples:
                In_Progress:
                  value:
                    custom_template_name: DB-example-v1.odt
                    possible_output_formats:
                    - PDF
                    - ODT
                    - DOC
                    - DOCX
                    - TXT
                    - JPG
                    - PNG
                    - EPUB
                Success:
                  value:
                    custom_template_id: de838bffa11667325082594464bbc11974749f4de5729b1209ea7a4427c71129
                    custom_template_name: DB-example-v1.odt
                    possible_output_formats:
                    - PDF
                    - ODT
                    - DOC
                    - DOCX
                    - TXT
                    - JPG
                    - PNG
                    - EPUB
        '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.
  /organizations/{organization_id}/forms/{form_id}/custom/set:
    post:
      operationId: librariesFormTemplatesSetOrganizationFormTemplateCustomReportAssociation
      summary: Set organization form template custom report association
      description: "Set the association between a form template and a custom report template previously uploaded.\n\n Endpoint mandatory parameters \n Details \n\n organization_id \n id of your organization \n\n form_id \n id the the form template \n\n Body mandatory params \n\n media_id \n id returned by the media upload process"
      tags:
      - Libraries
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable `organization_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
            example:
              media_id: <uuid>
      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'
    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.
  /organizations/{organization_id}/forms/{form_id}/statuses:
    get:
      operationId: librariesFormTemplatesGetFormTemplatesStatuses
      summary: Get form templates statuses
      description: "For a given form template you can list his statuses\n\n Endpoint mandatory infos \n Details \n\n organization_id \n the id of your organization \n\n form_id \n the form template id"
      tags:
      - Libraries
      parameters:
      - name: organization_id
        in: path
        required: true
        schema:
          type: string
        description: Path variable `organization_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.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              examples:
                Success:
                  value:
                    statuses:
                    - id: 91a6da3e-426d-42bd-bdb9-9ea9e4f02e3e
                      name: To do
                      position: 0
                      color: '#EBBB1C'
                      enabled: false
                    - id: ac7bbfde-1ae8-4af9-b2e0-ca69023dad52
                      name: Done
                      position: 0
                      color: '#49CB0C'
                      enabled: false
                    - id: 8e2e608a-dbf9-4166-a601-0d85b4a930a7
                      name: Not Compliant
                      position: 0
                      color: '#E94F3D'
                      enabled: false
                    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'
    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.
  /organizations/{organization_id}/modules:
    get:
      operationId: librariesModulesFormModuleTypeGetModules
      summary: Get modules
      description: "Get the list of all existing form modules for a workspace.\n\n Endpoint mandatory info \n Details \n\n organization_id \n The ID of your organization \n\n workspace_id \n id of your workspace \n\n Query params optionals \n\n limit \n number max of rows returned \n\n offset \n number of the first record in the list"
      tags:
      - Libraries
      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:
                Get_Modules:
                  value:
                    modules:
                    - id: 117f1c84-e69d-4429-baf9-74e052f5e0bc
                      container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323
                      container_type: Finalcad
                      name: Forms
                      icon: clipboard
                      color: '#F7CE46'
                      type: Forms
                      visibility: Default
                      module_forms:
                      - form_id: 9b2de0df-6504-48db-a923-b71d6553e48b
                        container_id: 2421734c-f191-4237-acd8-becf216eaae4
                        container_type: Organization
                      - form_id: 1aa8afc4-3106-446b-a471-55fc413d9867
                        container_id: 242173

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