openapi: 3.1.0 info: title: Finalcad One Organization Management API version: '2.41' summary: 'Organization-level administration of a Finalcad One Enterprise tenant: workspaces, members and roles, observation status / trade / common-observation / priority / form-template libraries, form and observation module types, data referentials, and Power BI dataset configuration.' description: 'Organization-level administration of a Finalcad One Enterprise tenant: workspaces, members and roles, observation status / trade / common-observation / priority / form-template libraries, form and observation module types, data referentials, and Power BI dataset configuration. 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: Datasets - name: Libraries - name: Members - name: Referential - name: User organizations - name: Workspaces paths: /organizations: get: operationId: userOrganizationsGetOrganizationId summary: Get organization ID description: You can get the IDs of all the organizations where you are a member and that have the correct license type here. tags: - User organizations responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: - id: 0ca0f152-1111-3333-995e-f6b4fdf3e2eb name: My organization - id: 02a59bf6-2222-4444-b870-ca3b14c8e603 name: Shared organization '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/user-infos/{user_id}: get: operationId: membersGetUserInformation summary: Get user information description: "You can check member info.\n\n Endpoint mandatory infos \n Details \n\n user_id \n the id of the user\ \ to be checked" tags: - Members parameters: - name: user_id in: path required: true schema: type: string description: Path variable `user_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: first_name: last_name: email: is_active: 'true' email_validated: 'true' created_at: '2022-06-02T07:28:34.483278Z' updated_at: '2023-07-26T13:24:40.68237Z' media_resource: id: 737a4362-0371-4742-9b58-ffe4d4d2e768 file_name: logo.png mime_type: image/png created_at: '2023-07-26T13:24:40.672379Z' '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/{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: id: 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: trade_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' /organizations/{organization_id}/add-members: post: operationId: membersAddMembers summary: Add members 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 organization member list.\n\n To invite a\ \ member to your project, an email needs to be associated with a project role. See Get roles . \n\n Endpoint mandatory\ \ infos \n Details \n\n organization_id \n the id of the project to be modified \n\n body mandatory infos \n Details\ \ \n\n role_users \n list of roles and users \neach contains : \n\n role_id \n organization role id to be used \n\ if missing , use the default one \n\n users_info \n list of user_id or email as string" tags: - Members 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: role_users: - role_id: e735e603-225a-47d1-bd39-72a1afae7c9f users_info: - the_user_email - another_email 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' /organizations/{organization_id}/change-members-role: post: operationId: membersChangeRole summary: Change role description: "You can change the role of a user.\n\n Endpoint mandatory infos \n Details \n\n organization_id \n the\ \ id of the project to be modified \n\n body mandatory infos \n Details \n\n role_id \n organization role id to be\ \ used \n\n users_info \n list of user_id to be changed" tags: - Members 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: role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7 users_info: - the_user_id - another_user_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' /organizations/{organization_id}/change-members-role-bulk: post: operationId: membersChangeSeveralRoles summary: Change several roles description: "You can change several roles for several users.\n\n Endpoint mandatory infos \n Details \n\n organization_id\ \ \n the id of the organization to be modified \n\n body mandatory infos \n Details \n --- \n\n List of \n\n role_id\ \ \n organization role id to be used \n\n users_info \n list of user_id to be changed" tags: - Members 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 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}/data/config: get: operationId: datasetsGetDatasets summary: Get datasets description: "Get the list of datasets for the organization.\n\n Endpoint mandatory parameters \n Details \n\n organization_id\ \ \n id of your organization" tags: - Datasets 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: data_sets: - name: Observations is_active: true - name: Statuses is_active: true - name: CommonObservations is_active: true - name: FormInstances is_active: true - name: FormTemplates is_active: true - name: Plans is_active: true - name: Companies is_active: true - name: Phases is_active: true - name: Modules is_active: true - name: Users is_active: true - name: Projects is_active: true - name: Workspaces is_active: true - name: Documents is_active: true - name: FormAnswers is_active: 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' post: operationId: datasetsPostDatasets summary: Post datasets description: "Set the list of active datasets.\n\n Endpoint mandatory parameters \n Details \n\n organization_id \n\ \ id of your organization \n\n body mandatory \n\n data_sets \n list of the active datasets \nall missing dataset\ \ are invalidated \n\n Dataset list :\nCommonObservations, Companies, FormInstances, FormTemplates, Modules, Observations,\ \ Phases, Plans, Statuses, Projects, Workspaces, Documents, Users, FormAnswers, UserActivities, Priorities, ProjectsUsersRoles" tags: - Datasets 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: data_sets: - CommonObservations - Companies - FormInstances - FormTemplates - Modules - Observations - Phases - Plans - Statuses - Projects - Workspaces - Documents - Users - FormAnswers - UserActivities - Priorities - ProjectsUsersRoles responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: data_sets: - name: Observations is_active: true url: https://tf-business-organization......Amz....a886e - name: Forms is_active: true - name: Plans is_active: false - name: Documents is_active: 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' /organizations/{organization_id}/data/config/dataset: get: operationId: datasetsGetDatasetContent summary: Get dataset content description: "Get the content for an active dataset (limited to 10MB).\n\n Endpoint mandatory parameters \n Details\ \ \n\n organization_id \n id of your organization \n\n name \n name of the dataset" tags: - Datasets 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 '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}/data/config/dataseturl: get: operationId: datasetsGetDatasetUrl summary: Get dataset URL description: "Get a downloadable URL for an active dataset.\n\n Endpoint mandatory parameters \n Details \n\n organization_id\ \ \n id of your organization \n\n name \n name of the dataset" tags: - Datasets 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: url: https://medias....LSEQ '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}/datareferentials: get: operationId: referentialGetDataReferentials summary: Get data referentials description: "Get the list of all data referentials for your organization.\n\n Details \n\n organization_id \n id of\ \ your organization \n\n Query params optionals \n\n see Commmon behaviors / differential" tags: - Referential 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: data_referentials: - id: 56f2caea-9f65-402f-8b80-0dcac4815a3e name: Employés organization_id: 2421734c-f191-4237-acd8-becf216eaae4 media_resource: id: 9ddf1fcf-7067-4ad6-a8fb-7a1883af71b1 file_name: MDD-Employes.csv mime_type: text/csv created_at: '0001-01-01T00:00:00Z' status: Success structure: - ID - UPN - Email - Matricule - Nom - Prenom - Fonction - Service - Telephone - GUID Entite - Nom Entite - Type de contrat - Libellé emploi - Aptitude - Dernière date de visite médicale - Interne - Source - Modifié le - EtatEnr - Emploi Foederis - Restriction - Nom du contact/Num Téléphone - Habilitation(s) created_at: '2024-01-19T13:08:07.992Z' created_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a updated_at: '2024-01-19T13:08:22.831Z' updated_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a - id: 14753cc4-3059-4f4e-83d6-729e43081b4d name: Test organization_id: 2421734c-f191-4237-acd8-becf216eaae4 media_resource: id: a31d2153-7c65-4d4d-a230-9c3cc5351750 file_name: Test.csv mime_type: application/vnd.ms-excel created_at: '0001-01-01T00:00:00Z' status: Success structure: - ID - UPN - Email - Matricule - Nom - Prenom - Fonction - Service - Telephone - GUID Entite - Nom Entite - Type de contrat - Libellé emploi - Aptitude - Dernière date de visite médicale - Interne - Source - Modifié le - EtatEnr - Emploi Foederis - Restriction - Nom du contact/Num Téléphone created_at: '2024-01-10T10:15:20.573Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-03-05T10:07:55.721Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a deleted_at: '2024-03-05T10:07:55.721Z' deleted_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a continuous_token: dHV0dQ== count: 2 limit: 50 '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: referentialCreateDataReferential summary: Create data referential description: "Create a new referential.\n\n Details \n\n organization_id \n id of your organization \n\n body mandatory\ \ params \n Details \n\n media_id \n Id the a previously uploaded media file \n\n name \n name of the referential" tags: - Referential 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: media_id: name: responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: cba7b13c-7e01-4d0b-9396-f758d982ca31 name: Test Employés organization_id: 2421734c-f191-4237-acd8-becf216eaae4 media_resource: id: b7427db4-5874-4c47-8a36-771683dd0cb3 file_name: MDD-Employes -v2023.v2.ms-excel mime_type: application/octet-stream created_at: '0001-01-01T00:00:00Z' status: InProgress created_at: '2024-03-05T12:55:45.1947895Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-03-05T12:55:45.364755Z' 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' /organizations/{organization_id}/datareferentials/{referentialId}: get: operationId: referentialGetDataReferential summary: Get data referential description: "Get the list of all data referentials for your organization.\n\n Details \n\n organization_id \n id of\ \ your organization \n\n referential_id \n id of the referential" tags: - Referential parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: referentialId in: path required: true schema: type: string description: Path variable `referentialId` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 56f2caea-9f65-402f-8b80-0dcac4815a3e name: Employés organization_id: 2421734c-f191-4237-acd8-becf216eaae4 media_resource: id: 9ddf1fcf-7067-4ad6-a8fb-7a1883af71b1 file_name: MDD-Employes.csv mime_type: text/csv created_at: '0001-01-01T00:00:00Z' status: Success structure: - ID - UPN - Email - Matricule - Nom - Prenom - Fonction - Service - Telephone - GUID Entite - Nom Entite - Type de contrat - Libellé emploi - Aptitude - Dernière date de visite médicale - Interne - Source - Modifié le - EtatEnr - Emploi Foederis - Restriction - Nom du contact/Num Téléphone - Habilitation(s) created_at: '2024-01-19T13:08:07.992Z' created_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a updated_at: '2024-01-19T13:08:22.831Z' updated_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a '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: referentialDeleteDataReferential summary: Delete data referential description: "Delete a referential.\n\n Endpoint mandatory parameters \n Details \n\n organization_id \n id of your\ \ organization \n\n referential_id \n id of the referential" tags: - Referential parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: referentialId in: path required: true schema: type: string description: Path variable `referentialId` 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' /organizations/{organization_id}/datareferentials/{referentialId}/set-name: put: operationId: referentialRenameDataReferential summary: Rename data referential description: "Rename a referential.\n\n Details \n\n organization_id \n id of your organization \n\n referential_id\ \ \n if of the referential \n\n body mandatory params \n Details \n\n name \n name of the referential" tags: - Referential parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: referentialId in: path required: true schema: type: string description: Path variable `referentialId` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: name: the new name responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 3b014303-d9ff-4713-bf09-95e4a0257e7f name: the new name organization_id: 2421734c-f191-4237-acd8-becf216eaae4 media_resource: id: b0a6e99e-8eeb-4010-b095-b60e34d63f15 file_name: MDD-Employes -v2023.v2.ms-excel mime_type: application/octet-stream created_at: '0001-01-01T00:00:00Z' status: Success structure: - ID - UPN - Email - Matricule - Nom - Prenom - Fonction - Service - Telephone - GUID Entite - Nom Entite - Type de contrat - Libellé emploi - Aptitude - Dernière date de visite médicale - Interne - Source - Modifié le - EtatEnr - Emploi Foederis - Restriction - Nom du contact/Num Téléphone created_at: '2024-01-09T10:42:18.292Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-03-05T12:57:08.449295Z' 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' /organizations/{organization_id}/datareferentials/{referentialId}/set-referential: put: operationId: referentialUpdateDataReferential summary: Update data referential description: "Replace a new referential's content.\n\n It is your responsibility to verify that the file structure is\ \ the same as the previous one. \n\n Endpoint mandatory parameters \n Details \n\n organization_id \n id of your organization\ \ \n\n referential_id \n id of the referential \n\n body mandatory params \n Details \n\n media_id \n Id the a previously\ \ uploaded media file" tags: - Referential parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: referentialId in: path required: true schema: type: string description: Path variable `referentialId` 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: 3b014303-d9ff-4713-bf09-95e4a0257e7f name: test organization_id: 2421734c-f191-4237-acd8-becf216eaae4 media_resource: id: b0a6e99e-8eeb-4010-b095-b60e34d63f15 file_name: MDD-Employes -v2023.v2.ms-excel mime_type: application/octet-stream created_at: '0001-01-01T00:00:00Z' status: Updating structure: - ID - UPN - Email - Matricule - Nom - Prenom - Fonction - Service - Telephone - GUID Entite - Nom Entite - Type de contrat - Libellé emploi - Aptitude - Dernière date de visite médicale - Interne - Source - Modifié le - EtatEnr - Emploi Foederis - Restriction - Nom du contact/Num Téléphone created_at: '2024-01-09T10:42:18.292Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2024-03-05T12:56:12.4538467Z' 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' /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' /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' /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' /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: 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' /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' /organizations/{organization_id}/members: post: operationId: membersGetMembers summary: Get members description: "Before adding members to your project, you might want to have an overview of the current organization\ \ users and their roles.\n\n Endpoint mandatory infos \n Details \n\n organization_id \n the id of the organization\ \ to be checked \n\n Query params optionals \n\n see Commmon behaviors / differential \n\n Body optional infos \n\ \ Details \n\n search_term \n search term for the email user field \n\n roles \n list of organization roles to filter\ \ the users list \nthis filed is ignored if the search_term is used \n\n with_processing_members \n include or not\ \ the processing users" tags: - Members 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: with_processing_members: true responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: organization_members: - id: 427380db-f465-48bd-a2d7-6788a4b07adc membership_type: Member user_id: 674ddb3e-6ce0fe28-6e85-4d0b-9efc-666f8c7fe7e6 legacy_id: 500001965 email: person.redacted@example.com first_name: Damien last_name: IROUVA organization_role: id: 932c489a-06dc-427b-912c-ca2d9709ac8e name: Organization member names: translation_fallback: Organization member translations: - language: nl translation: Lid organisatie - language: ja translation: 組織メンバー - language: pt translation: Membro da organização - language: it translation: Membro organizzazione - language: fr translation: Membre de l'organisation - language: vi translation: Thành viên của tổ chức - language: ca translation: Membre de l'organització - language: de translation: Mitglied der Organisation - language: zh translation: 组织成员 - language: th translation: สมาชิกองค์กร - language: en translation: Organization member - language: es translation: Miembro de la organización is_default: true is_default_invitation_role: false user_count: 14 position: 0 authorization_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e higher_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7 is_lower_role: false is_pending: false is_processing: false created_at: '2023-06-21T13:04:10.052724Z' updated_at: '2023-06-21T13:04:18.272385Z' - id: 966112b7-c1ab-4d43-895c-0dac53f13b41 membership_type: Member user_id: 4b9382b5-e2d6a638-5011-4a9a-b3ac-9f87db62800b legacy_id: 500004270 email: person.redacted+sandbox@example.com first_name: Eivyda last_name: JANKUNAITE media_resource: id: 024afa60-36f5-4db4-99c9-306d10f7e1b9 file_name: images.jpeg mime_type: image/jpeg created_at: '2023-03-20T08:57:51.725998Z' organization_role: id: 932c489a-06dc-427b-912c-ca2d9709ac8e name: Organization member names: translation_fallback: Organization member translations: - language: nl translation: Lid organisatie - language: ja translation: 組織メンバー - language: pt translation: Membro da organização - language: it translation: Membro organizzazione - language: fr translation: Membre de l'organisation - language: vi translation: Thành viên của tổ chức - language: ca translation: Membre de l'organització - language: de translation: Mitglied der Organisation - language: zh translation: 组织成员 - language: th translation: สมาชิกองค์กร - language: en translation: Organization member - language: es translation: Miembro de la organización is_default: true is_default_invitation_role: false user_count: 14 position: 0 authorization_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e higher_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7 is_lower_role: false is_pending: false is_processing: false created_at: '2023-03-02T13:16:29.80972Z' updated_at: '2023-03-02T13:16:29.809737Z' - id: 2b478519-c316-4026-9d3a-4293fe3fe110 membership_type: Member user_id: b7a277a7-fadc0b1f-26b5-4800-97a1-33d935552c53 legacy_id: 500004484 email: person.redacted@example.com first_name: Jade last_name: ab media_resource: id: f775f8db-74f2-4bc6-a160-d34be8220f81 file_name: immeuble-de-bureaux-de-plan-52367600.jpeg mime_type: image/jpeg created_at: '2022-12-13T16:04:16.474872Z' organization_role: id: 932c489a-06dc-427b-912c-ca2d9709ac8e name: Organization member names: translation_fallback: Organization member translations: - language: nl translation: Lid organisatie - language: ja translation: 組織メンバー - language: pt translation: Membro da organização - language: it translation: Membro organizzazione - language: fr translation: Membre de l'organisation - language: vi translation: Thành viên của tổ chức - language: ca translation: Membre de l'organització - language: de translation: Mitglied der Organisation - language: zh translation: 组织成员 - language: th translation: สมาชิกองค์กร - language: en translation: Organization member - language: es translation: Miembro de la organización is_default: true is_default_invitation_role: false user_count: 14 position: 0 authorization_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e higher_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7 is_lower_role: false is_pending: false is_processing: false created_at: '2022-12-08T09:15:10.413826Z' updated_at: '2022-12-08T09:15:10.413848Z' - id: cd404d0f-ce28-4d42-bea7-969b8283ac20 membership_type: Member user_id: 8b05d23b-b521f61b-de1c-46d1-9f81-c5b2621fe740 legacy_id: 500004839 email: person.redacted+plan@example.com first_name: Jade last_name: Abr organization_role: id: 932c489a-06dc-427b-912c-ca2d9709ac8e name: Organization member names: translation_fallback: Organization member translations: - language: nl translation: Lid organisatie - language: ja translation: 組織メンバー - language: pt translation: Membro da organização - language: it translation: Membro organizzazione - language: fr translation: Membre de l'organisation - language: vi translation: Thành viên của tổ chức - language: ca translation: Membre de l'organització - language: de translation: Mitglied der Organisation - language: zh translation: 组织成员 - language: th translation: สมาชิกองค์กร - language: en translation: Organization member - language: es translation: Miembro de la organización is_default: true is_default_invitation_role: false user_count: 14 position: 0 authorization_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e higher_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7 is_lower_role: false is_pending: false is_processing: false created_at: '2023-02-08T14:09:43.698678Z' updated_at: '2023-02-08T15:01:08.940749Z' - id: 798ca3db-bcb0-4b98-bbe9-8959c3b071b6 membership_type: Member user_id: fdab2bfe-87196ebb-56c0-46ed-83c6-4bf803d86cf9 legacy_id: 500004723 email: person.redacted+test@example.com organization_role: id: 932c489a-06dc-427b-912c-ca2d9709ac8e name: Organization member names: translation_fallback: Organization member translations: - language: nl translation: Lid organisatie - language: ja translation: 組織メンバー - language: pt translation: Membro da organização - language: it translation: Membro organizzazione - language: fr translation: Membre de l'organisation - language: vi translation: Thành viên của tổ chức - language: ca translation: Membre de l'organització - language: de translation: Mitglied der Organisation - language: zh translation: 组织成员 - language: th translation: สมาชิกองค์กร - language: en translation: Organization member - language: es translation: Miembro de la organización is_default: true is_default_invitation_role: false user_count: 14 position: 0 authorization_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e higher_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7 is_lower_role: false is_pending: true is_processing: false created_at: '2023-01-11T13:02:05.713988Z' updated_at: '2023-01-11T13:02:05.714Z' - id: f7172dae-fde8-42a2-8930-957e8d344666 membership_type: Member user_id: 6996b70d-8fa9ce3a-dcf9-4bdd-a690-86d76294ec60 legacy_id: 500004724 email: person.redacted+test2@example.com organization_role: id: 932c489a-06dc-427b-912c-ca2d9709ac8e name: Organization member names: translation_fallback: Organization member translations: - language: nl translation: Lid organisatie - language: ja translation: 組織メンバー - language: pt translation: Membro da organização - language: it translation: Membro organizzazione - language: fr translation: Membre de l'organisation - language: vi translation: Thành viên của tổ chức - language: ca translation: Membre de l'organització - language: de translation: Mitglied der Organisation - language: zh translation: 组织成员 - language: th translation: สมาชิกองค์กร - language: en translation: Organization member - language: es translation: Miembro de la organización is_default: true is_default_invitation_role: false user_count: 14 position: 0 authorization_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e higher_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7 is_lower_role: false is_pending: true is_processing: false created_at: '2023-01-11T13:07:46.741989Z' updated_at: '2023-01-11T13:07:46.741991Z' - id: 8f128201-35cf-4872-a928-d203eec7afd4 membership_type: Member user_id: 5cf12ec0-fa67d814-befe-4055-a480-3bbbb34f6c01 legacy_id: 500003043 email: person.redacted@example.com first_name: Josh last_name: Josh media_resource: id: 28ceea7d-7741-4506-9191-cfbd5aa4bde2 file_name: josh.jpg mime_type: image/jpeg created_at: '2021-01-11T14:38:45.921Z' organization_role: id: 932c489a-06dc-427b-912c-ca2d9709ac8e name: Organization member names: translation_fallback: Organization member translations: - language: nl translation: Lid organisatie - language: ja translation: 組織メンバー - language: pt translation: Membro da organização - language: it translation: Membro organizzazione - language: fr translation: Membre de l'organisation - language: vi translation: Thành viên của tổ chức - language: ca translation: Membre de l'organització - language: de translation: Mitglied der Organisation - language: zh translation: 组织成员 - language: th translation: สมาชิกองค์กร - language: en translation: Organization member - language: es translation: Miembro de la organización is_default: true is_default_invitation_role: false user_count: 14 position: 0 authorization_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e higher_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7 is_lower_role: false is_pending: false is_processing: false created_at: '2023-01-10T08:44:18.619122Z' updated_at: '2023-01-10T08:44:18.619122Z' - id: 5733cec1-5c27-492c-bf1d-c9feb90b6577 membership_type: Member user_id: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a legacy_id: 500004439 email: person.redacted+sandbox@example.com first_name: Luc last_name: Vallot organization_role: id: e735e603-225a-47d1-bd39-72a1afae7c9f name: Organization admin names: translation_fallback: Organization admin translations: - language: es translation: Administrador de la organización - language: ja translation: 組織管理者 - language: zh translation: 组织管理员 - language: vi translation: Quản trị viên của tổ chức - language: fr translation: Administrateur de l'organisation - language: ca translation: Administrador de l'organització - language: nl translation: Beheer organisatie - language: th translation: ผู้ดูแลองค์กร - language: de translation: Administrator der Organisation - language: it translation: Amministratore organizzazione - language: pt translation: Admin da organização - language: en translation: Organization admin is_default: false is_default_invitation_role: false user_count: 3 position: 0 authorization_role_id: e735e603-225a-47d1-bd39-72a1afae7c9f is_lower_role: false is_pending: false is_processing: false created_at: '2022-06-30T08:35:05.940464Z' updated_at: '2022-06-30T08:35:06.862619Z' - id: 164dee2f-46db-47c1-80bf-db10c078504f membership_type: Member user_id: 8f0eebde-0fa7f000-f573-4054-b1a6-b92b002a513e legacy_id: 5493 email: person-c@example.com first_name: Mathieu last_name: Bourgois job_title: dev organization_role: id: e735e603-225a-47d1-bd39-72a1afae7c9f name: Organization admin names: translation_fallback: Organization admin translations: - language: es translation: Administrador de la organización - language: ja translation: 組織管理者 - language: zh translation: 组织管理员 - language: vi translation: Quản trị viên của tổ chức - language: fr translation: Administrateur de l'organisation - language: ca translation: Administrador de l'organització - language: nl translation: Beheer organisatie - language: th translation: ผู้ดูแลองค์กร - language: de translation: Administrator der Organisation - language: it translation: Amministratore organizzazione - language: pt translation: Admin da organização - language: en translation: Organization admin is_default: false is_default_invitation_role: false user_count: 3 position: 0 authorization_role_id: e735e603-225a-47d1-bd39-72a1afae7c9f is_lower_role: false is_pending: false is_processing: false created_at: '2023-02-08T11:04:12.152411Z' updated_at: '2023-02-08T11:04:21.424427Z' - id: 73001071-62a5-4be3-bcc6-aadba62c54ec membership_type: Member user_id: dc157afc-84607076-50ba-4e6a-8bf6-18a6676554a3 legacy_id: 500004722 email: person.redacted+d@example.com first_name: ugazf last_name: aozifh organization_role: id: 932c489a-06dc-427b-912c-ca2d9709ac8e name: Organization member names: translation_fallback: Organization member translations: - language: nl translation: Lid organisatie - language: ja translation: 組織メンバー - language: pt translation: Membro da organização - language: it translation: Membro organizzazione - language: fr translation: Membre de l'organisation - language: vi translation: Thành viên của tổ chức - language: ca translation: Membre de l'organització - language: de translation: Mitglied der Organisation - language: zh translation: 组织成员 - language: th translation: สมาชิกองค์กร - language: en translation: Organization member - language: es translation: Miembro de la organización is_default: true is_default_invitation_role: false user_count: 14 position: 0 authorization_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e higher_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7 is_lower_role: false is_pending: false is_processing: false created_at: '2023-01-10T16:10:07.389358Z' updated_at: '2023-01-10T16:10:46.783037Z' - id: bbbefa4f-36a8-425f-b8b4-c7d73bb6ec9b membership_type: Member user_id: 19727e12-e5b6df02-625b-47f2-be7a-69622f45e73f legacy_id: 500004518 email: person.redacted+sandbox@example.com organization_role: id: 932c489a-06dc-427b-912c-ca2d9709ac8e name: Organization member names: translation_fallback: Organization member translations: - language: nl translation: Lid organisatie - language: ja translation: 組織メンバー - language: pt translation: Membro da organização - language: it translation: Membro organizzazione - language: fr translation: Membre de l'organisation - language: vi translation: Thành viên của tổ chức - language: ca translation: Membre de l'organització - language: de translation: Mitglied der Organisation - language: zh translation: 组织成员 - language: th translation: สมาชิกองค์กร - language: en translation: Organization member - language: es translation: Miembro de la organización is_default: true is_default_invitation_role: false user_count: 14 position: 0 authorization_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e higher_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7 is_lower_role: false is_pending: true is_processing: false created_at: '2022-08-25T07:03:15.415763Z' updated_at: '2022-08-25T07:03:15.415763Z' - id: df41b4ca-a485-4eb3-9af1-d224d435968d membership_type: Member user_id: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a legacy_id: 500003141 email: person.redacted+test@example.com first_name: Mathieu last_name: Bourgois media_resource: id: 46579746-ec37-4465-a0ff-5993d1e7d7ab file_name: cat.png mime_type: image/png created_at: '2022-02-28T09:28:41.196255Z' organization_role: id: e735e603-225a-47d1-bd39-72a1afae7c9f name: Organization admin names: translation_fallback: Organization admin translations: - language: es translation: Administrador de la organización - language: ja translation: 組織管理者 - language: zh translation: 组织管理员 - language: vi translation: Quản trị viên của tổ chức - language: fr translation: Administrateur de l'organisation - language: ca translation: Administrador de l'organització - language: nl translation: Beheer organisatie - language: th translation: ผู้ดูแลองค์กร - language: de translation: Administrator der Organisation - language: it translation: Amministratore organizzazione - language: pt translation: Admin da organização - language: en translation: Organization admin is_default: false is_default_invitation_role: false user_count: 3 position: 0 authorization_role_id: e735e603-225a-47d1-bd39-72a1afae7c9f is_lower_role: false is_pending: false is_processing: false created_at: '2022-05-24T08:23:51.560536Z' updated_at: '2022-06-30T08:36:07.204122Z' - id: 27b0a0a5-7867-4c81-be03-6c98e8218134 membership_type: Member user_id: 44b76c1c-0466376f-46cd-46bc-8685-261abb613a71 legacy_id: 500004721 email: person.redacted+test2@example.com organization_role: id: fbaed956-2c60-42b5-8763-8f62d6dd74a7 name: Workspace Manager names: translation_fallback: Workspace Manager translations: - language: th translation: ผู้จัดการพื้นที่ทำงาน - language: de translation: Workspace Manager - language: nl translation: Werkruimtebeheer - language: en translation: Workspace Manager - language: vi translation: Quản lý không gian làm việc - language: es translation: Gestor de espacio de trabajo - language: fr translation: Manager d'espace de travail - language: it translation: Responsabile dello spazio di lavoro - language: zh translation: 工作空间管理者 - language: ja translation: ワークスペース・マネージャー - language: pt translation: Gestor do espaço de trabalho - language: ca translation: Gestor de l'entorn de treball is_default: false is_default_invitation_role: false user_count: 1 position: 0 authorization_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7 higher_role_id: e735e603-225a-47d1-bd39-72a1afae7c9f is_lower_role: false is_pending: true is_processing: false created_at: '2023-01-10T16:07:02.708705Z' updated_at: '2023-01-10T16:07:26.826521Z' - id: 7a26919a-24f5-4ec3-bbcd-5ca496d81cd5 membership_type: Member user_id: 5a9367a0-607e9b7d-de7b-4eef-9ece-9bc612d0f584 legacy_id: 500004408 email: person-b@example.com first_name: Francis last_name: Maccio media_resource: id: d6537681-e710-47fa-8ad4-9c395c14779f file_name: 20200731_174858.jpg mime_type: image/jpeg created_at: '2022-08-01T14:26:49.071228Z' organization_role: id: 932c489a-06dc-427b-912c-ca2d9709ac8e name: Organization member names: translation_fallback: Organization member translations: - language: nl translation: Lid organisatie - language: ja translation: 組織メンバー - language: pt translation: Membro da organização - language: it translation: Membro organizzazione - language: fr translation: Membre de l'organisation - language: vi translation: Thành viên của tổ chức - language: ca translation: Membre de l'organització - language: de translation: Mitglied der Organisation - language: zh translation: 组织成员 - language: th translation: สมาชิกองค์กร - language: en translation: Organization member - language: es translation: Miembro de la organización is_default: true is_default_invitation_role: false user_count: 14 position: 0 authorization_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e higher_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7 is_lower_role: false is_pending: false is_processing: false created_at: '2022-11-04T10:48:08.440584Z' updated_at: '2022-11-04T10:48:08.440585Z' - id: 4a0a62fb-746c-4e79-8f7b-1155b63ddf84 membership_type: Member user_id: a9f0b291-ec293feb-d04e-4b6c-a8ad-244b028178bd legacy_id: 500004855 email: person-a@example.com first_name: Nicolas last_name: PIRON media_resource: id: 1ac91ad8-8508-4441-b807-cc4a9536e825 file_name: image-20230222-175024.png mime_type: image/png created_at: '2023-05-16T13:53:56.543243Z' organization_role: id: 932c489a-06dc-427b-912c-ca2d9709ac8e name: Organization member names: translation_fallback: Organization member translations: - language: nl translation: Lid organisatie - language: ja translation: 組織メンバー - language: pt translation: Membro da organização - language: it translation: Membro organizzazione - language: fr translation: Membre de l'organisation - language: vi translation: Thành viên của tổ chức - language: ca translation: Membre de l'organització - language: de translation: Mitglied der Organisation - language: zh translation: 组织成员 - language: th translation: สมาชิกองค์กร - language: en translation: Organization member - language: es translation: Miembro de la organización is_default: true is_default_invitation_role: false user_count: 14 position: 0 authorization_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e higher_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7 is_lower_role: false is_pending: false is_processing: false created_at: '2023-05-04T11:56:53.692901Z' updated_at: '2023-05-04T11:56:54.618782Z' - id: b54395a5-69a1-4c5c-bcfd-ba6fda349816 membership_type: Member user_id: 90c081fc-e12b5c38-06f3-4776-9c48-69584d51d7b1 legacy_id: 55938 email: person.redacted@example.com first_name: Quentin last_name: MACE media_resource: id: 0fc8ab8b-c02e-47b6-8212-4234d3272b87 file_name: 3648586.png mime_type: image/png created_at: '2023-01-30T16:02:32.436688Z' organization_role: id: 932c489a-06dc-427b-912c-ca2d9709ac8e name: Organization member names: translation_fallback: Organization member translations: - language: nl translation: Lid organisatie - language: ja translation: 組織メンバー - language: pt translation: Membro da organização - language: it translation: Membro organizzazione - language: fr translation: Membre de l'organisation - language: vi translation: Thành viên của tổ chức - language: ca translation: Membre de l'organització - language: de translation: Mitglied der Organisation - language: zh translation: 组织成员 - language: th translation: สมาชิกองค์กร - language: en translation: Organization member - language: es translation: Miembro de la organización is_default: true is_default_invitation_role: false user_count: 14 position: 0 authorization_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e higher_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7 is_lower_role: false is_pending: false is_processing: false created_at: '2022-12-08T09:15:10.413814Z' updated_at: '2022-12-08T09:15:10.413857Z' - id: e0bd7484-df8e-41b1-ab92-cc4644800059 membership_type: Member user_id: bad53f66-330e4741-66cc-4489-ab69-f05911fdfb06 legacy_id: 55959 email: person.redacted@example.com first_name: Raluca25 last_name: Baluta25 job_title: Managerrr media_resource: id: ab324a02-859d-48af-9e63-25a1f1af6971 file_name: images (6).jfif mime_type: image/jpeg created_at: '2021-10-20T07:18:14.73765Z' organization_role: id: 932c489a-06dc-427b-912c-ca2d9709ac8e name: Organization member names: translation_fallback: Organization member translations: - language: nl translation: Lid organisatie - language: ja translation: 組織メンバー - language: pt translation: Membro da organização - language: it translation: Membro organizzazione - language: fr translation: Membre de l'organisation - language: vi translation: Thành viên của tổ chức - language: ca translation: Membre de l'organització - language: de translation: Mitglied der Organisation - language: zh translation: 组织成员 - language: th translation: สมาชิกองค์กร - language: en translation: Organization member - language: es translation: Miembro de la organización is_default: true is_default_invitation_role: false user_count: 14 position: 0 authorization_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e higher_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7 is_lower_role: false is_pending: false is_processing: false created_at: '2022-12-14T11:45:25.620227Z' updated_at: '2022-12-14T11:45:25.620228Z' - id: 8a2bc9ac-084d-4346-a35c-62d461abfc8a membership_type: Member user_id: 23c0968f-4b9d3ab1-368d-47dc-bc6e-4afbe6c144cc legacy_id: 57261 email: person.redacted@example.com first_name: Vincent last_name: CHHIM media_resource: id: bb1a0b12-a06c-453c-a1d0-af664b1e406d file_name: bluepng.png mime_type: image/png created_at: '2023-06-27T12:09:20.890192Z' organization_role: id: 932c489a-06dc-427b-912c-ca2d9709ac8e name: Organization member names: translation_fallback: Organization member translations: - language: nl translation: Lid organisatie - language: ja translation: 組織メンバー - language: pt translation: Membro da organização - language: it translation: Membro organizzazione - language: fr translation: Membre de l'organisation - language: vi translation: Thành viên của tổ chức - language: ca translation: Membre de l'organització - language: de translation: Mitglied der Organisation - language: zh translation: 组织成员 - language: th translation: สมาชิกองค์กร - language: en translation: Organization member - language: es translation: Miembro de la organización is_default: true is_default_invitation_role: false user_count: 14 position: 0 authorization_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e higher_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7 is_lower_role: false is_pending: false is_processing: false created_at: '2022-12-12T13:15:33.093531Z' updated_at: '2022-12-12T13:15:33.093531Z' count: 18 total_count: 18 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' /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: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - form_id: dd51ccda-0f53-444d-b9f5-45252c37ca37 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - form_id: 0f5d26f7-523e-4453-b61c-0fd8d59f008a container_id: 4c80463a-d4d7-4c27-8692-fa36cda65130 container_type: Workspace - form_id: 40accad9-12c5-46da-aa2c-ad6c59972d81 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - form_id: 869701f4-9ebb-4640-bffe-a676361350f7 container_id: 4c80463a-d4d7-4c27-8692-fa36cda65130 container_type: Workspace - form_id: cf9d18bd-d473-400a-909a-e48ea0eb1404 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization module_content: - id: 594f4f7c-6f7a-410b-bb5e-5aa6ef488a9c name: Categ Form 1 content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization children: - id: 1c1318ff-07c2-4489-94d5-d32b4a1b4eff name: Categ Form 1.1 parent_id: 594f4f7c-6f7a-410b-bb5e-5aa6ef488a9c content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization children: - id: 9b2de0df-6504-48db-a923-b71d6553e48b parent_id: 1c1318ff-07c2-4489-94d5-d32b4a1b4eff content_type: Form container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: 1aa8afc4-3106-446b-a471-55fc413d9867 parent_id: 594f4f7c-6f7a-410b-bb5e-5aa6ef488a9c content_type: Form container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: dd51ccda-0f53-444d-b9f5-45252c37ca37 parent_id: 594f4f7c-6f7a-410b-bb5e-5aa6ef488a9c content_type: Form container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: 0f5d26f7-523e-4453-b61c-0fd8d59f008a parent_id: 594f4f7c-6f7a-410b-bb5e-5aa6ef488a9c content_type: Form container_id: 4c80463a-d4d7-4c27-8692-fa36cda65130 container_type: Workspace - id: 593647a7-8647-49ba-9552-739125b12486 name: Categ Form 2 content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization children: - id: e7b13254-7bcf-4558-a221-3e15be270c3f name: Categ form 2.1 parent_id: 593647a7-8647-49ba-9552-739125b12486 content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: 40accad9-12c5-46da-aa2c-ad6c59972d81 parent_id: 593647a7-8647-49ba-9552-739125b12486 content_type: Form container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: 1aa8afc4-3106-446b-a471-55fc413d9867 content_type: Form container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: 40accad9-12c5-46da-aa2c-ad6c59972d81 content_type: Form container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: 869701f4-9ebb-4640-bffe-a676361350f7 content_type: Form container_id: 4c80463a-d4d7-4c27-8692-fa36cda65130 container_type: Workspace - id: cf9d18bd-d473-400a-909a-e48ea0eb1404 content_type: Form container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization created_at: '2023-06-30T15:16:42.168073Z' updated_at: '2023-07-14T11:40:48.382866Z' - id: a41a8c18-b754-4b65-be6c-22c63987c995 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: New Forms icon: typePin color: '#E94F3D' type: Forms visibility: Available module_forms: - form_id: ed7c6fd4-a3d9-4d28-b02f-9a33d8e61e5c container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - form_id: 8f256be7-99e2-43ce-a427-628bddf65d78 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization module_content: - id: 89bea999-7e06-42b0-900b-8d3a2fd0b362 name: test cad pour data content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: ed7c6fd4-a3d9-4d28-b02f-9a33d8e61e5c content_type: Form container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: 8f256be7-99e2-43ce-a427-628bddf65d78 content_type: Form container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization created_at: '2023-09-13T09:25:41.084751Z' updated_at: '2023-09-13T09:29:41.773268Z' - id: 4d9fbb6f-5060-45ae-9b27-cc806c4b1487 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: Essai new module icon: typePin color: '#E94F3D' type: Forms visibility: NotAvailable module_content: - id: 505d5a67-4acc-4a22-98ed-3f715fb0c8ef name: Categorie aaa content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: 1cbe1164-ebcd-468a-b05d-69a8f4874e4c name: Categorie bbb content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: efb034ba-24ca-42f2-a7c3-36f666612d99 name: Categorie ccc content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization created_at: '2023-09-22T06:54:55.589216Z' updated_at: '2023-09-22T06:54:55.589216Z' - id: 67a8aed1-56f8-437e-91d9-0385c24c9aea container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: api test form answers icon: alertTriangle color: '#C0DF43' type: Forms visibility: Available created_at: '2023-11-30T08:25:00.24386Z' updated_at: '2023-11-30T08:25:15.235666Z' - id: 15606d9b-c9f5-4726-bc0a-8590a3dc9dc6 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: test create new form --- icon: alert color: '#E94F3D' type: Forms visibility: Available module_forms: - form_id: dd51ccda-0f53-444d-b9f5-45252c37ca37 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization module_content: - id: 37eca3a3-aeaa-4730-9c69-afeb0e49a933 name: Aze content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization children: - id: 9c150a71-be7c-4f0b-8669-507dcfbfa674 name: Aze 2.1 parent_id: 37eca3a3-aeaa-4730-9c69-afeb0e49a933 content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: f81b8786-935c-4413-af30-faf159c13f2b name: cat 2 content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: dd51ccda-0f53-444d-b9f5-45252c37ca37 content_type: Form container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization created_at: '2024-02-15T09:50:14.619561Z' updated_at: '2024-02-16T08:48:08.782081Z' - id: 85e32ecc-955e-4f44-831e-93adca197625 container_id: 4c80463a-d4d7-4c27-8692-fa36cda65130 container_type: Workspace name: qsdfgh icon: alert color: '#E94F3D' type: Forms visibility: Available module_forms: - form_id: dd51ccda-0f53-444d-b9f5-45252c37ca37 container_id: 4c80463a-d4d7-4c27-8692-fa36cda65130 container_type: Workspace module_content: - id: a734170b-6e57-4758-a507-6961e0166b48 name: cat ws content_type: Category container_id: 4c80463a-d4d7-4c27-8692-fa36cda65130 container_type: Workspace - id: 09dc3d33-4799-418f-a3f2-766cfb55b715 name: cat ws 22 content_type: Category container_id: 4c80463a-d4d7-4c27-8692-fa36cda65130 container_type: Workspace children: - id: dd51ccda-0f53-444d-b9f5-45252c37ca37 parent_id: 09dc3d33-4799-418f-a3f2-766cfb55b715 content_type: Form container_id: 4c80463a-d4d7-4c27-8692-fa36cda65130 container_type: Workspace - id: c5c2809c-061b-4d81-93d9-392df121e315 name: ess act 2 content_type: Category container_id: 4c80463a-d4d7-4c27-8692-fa36cda65130 container_type: Workspace - id: dd51ccda-0f53-444d-b9f5-45252c37ca37 content_type: Form container_id: 4c80463a-d4d7-4c27-8692-fa36cda65130 container_type: Workspace created_at: '2024-02-15T13:29:22.180989Z' updated_at: '2024-02-16T09:23:25.638848Z' - id: f5d33e97-6f40-478f-87bf-1fa04a0843ff container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: ngu postman 20230703 1420 icon: icon color: '#FFFFFF' type: Forms visibility: Available module_content: - id: 99bb4d5a-51e3-4a65-b5c0-dec520a7a6b9 name: Aze 2.1 content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization children: - id: a8bc3515-7e92-4050-be84-64812e982f01 name: Aze 2.1 parent_id: 99bb4d5a-51e3-4a65-b5c0-dec520a7a6b9 content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization created_at: '2024-03-07T14:17:09.952617Z' updated_at: '2024-03-07T14:17:09.952617Z' - id: 8cf9151c-0a0b-4675-befe-64d868b466ec container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: test create new form Available icon: alert color: '#E94F3D' type: Forms visibility: Available module_content: - id: 7d385066-8686-4357-940d-90524f03be97 name: cat 3----1 content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: 04bf1a6d-ce26-484f-93f5-d489eb71452b name: cat 3----2 content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization created_at: '2024-04-11T14:01:12.937062Z' updated_at: '2024-04-11T14:02:20.7693Z' count: 8 total_count: 8 limit: 100 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' post: operationId: librariesModulesFormModuleTypeCreateModule summary: Create module description: "You can create a custom form module in a specific workspace.\n\n Endpoint mandatory infos \n Details \n\ \n organization_Id \n the id of the organization to be modified \n\n workspace_id \n id of your workspace \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 visibility \n visibiity of the\ \ module in the module suggestion s list in the project creation \nDefault=>checked by default \nAvailable => unchecked\ \ by default \nNotAvailable => not 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. requestBody: required: true content: application/json: schema: type: object example: name: azerty in ws icon: color: visibility: Default responses: '200': description: OK content: application/json: schema: type: object examples: Create_Module: value: id: 8cf9151c-0a0b-4675-befe-64d868b466ec container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: new form test create 2 icon: alert color: '#E94F3D' type: Forms visibility: Default created_at: '2024-04-11T14:01:12.9370622Z' updated_at: '2024-04-11T14:01:12.9370622Z' '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}/modules/delete: post: operationId: librariesModulesFormModuleTypeDeleteModule summary: Delete module description: "You can delete a specific module in a specific workspace.\n\n Endpoint mandatory infos \n Details \n\n\ \ organization_Id \n the id of the project to be modified \n\n workspace_id \n id of your workspace \n\n body mandatory\ \ infos \n Details \n\n module_ids \n ist of modules ids" tags: - Libraries 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: module_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' /organizations/{organization_id}/modules/suggestions: get: operationId: librariesModulesGetModulesSuggestions summary: Get modules suggestions description: "Get all the predefined module suggestions for project creation if the project should be created in a workspace\ \ or an organization.\n\n Endpoint mandatory info \n Details \n\n organization_id \n The ID of your organization \n\ \n Endpoint Query optionals info \n Details \n\n workspace_id \n id of your workspace" 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: suggestions: - is_default: true 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: 表单 id: 117f1c84-e69d-4429-baf9-74e052f5e0bc container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Forms icon: clipboard color: '#F7CE46' type: Forms created_at: '2023-06-30T15:16:42.168073Z' updated_at: '2023-07-14T11:40:48.382866Z' - is_default: false names: - language: en translation: Quality - language: ar translation: جودة - language: ca translation: Qualitat - language: cs translation: Kvalitní - language: da translation: Kvalitet - language: de-DE translation: Qualität - language: el translation: Ποιότητα - language: es translation: Calidad - language: fi translation: Laatu - language: fr translation: Qualité - language: he translation: איכות - language: hu translation: Minőség - language: id translation: Kualitas - language: it translation: Qualità - language: ja translation: 品質 - language: ko-KR translation: 품질 - language: nb - language: nl-NL translation: Kwaliteit - language: pl translation: Jakość - language: pt translation: Qualidade - language: ro translation: Calitate - language: ru translation: Качество - language: sl-SI translation: Kakovost - language: sv translation: Kvalitet - language: th translation: คุณภาพ - language: tr translation: Kalite - language: vi translation: Chất lượng - language: zf - language: zh-Hans translation: 质量 id: 125ae973-3e43-4862-9af4-3cb13dcac81c container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Qualité icon: star color: '#01D194' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Environment - language: ar translation: بيئة - language: ca translation: Entorn - language: cs translation: životní prostředí - language: da translation: Miljø - language: de-DE translation: Umgebung - language: el translation: περιβάλλον - language: es translation: Medio ambiente - language: fi translation: ympäristö - language: fr translation: Environnement - language: he translation: סביבה - language: hu translation: Környezet - language: id translation: Lingkungan - language: it translation: Ambiente - language: ja translation: 環境 - language: ko-KR translation: 환경 - language: nb - language: nl-NL translation: Omgeving - language: pl translation: Środowisko - language: pt translation: Ambiente - language: ro translation: Mediu inconjurator - language: ru translation: Окружающая среда - language: sl-SI translation: Okolje - language: sv translation: Miljö - language: th translation: สิ่งแวดล้อม - language: tr translation: çevre - language: vi translation: Môi trường - language: zf - language: zh-Hans translation: 环境 id: 1d0ae170-f499-4649-b17d-d44008220600 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Environnemment icon: environment color: '#7FCE1A' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Site Diary - language: ar translation: يوميات الموقع - language: ca translation: Agenda de l'obra - language: cs translation: Deník webu - language: da translation: Site dagbog - language: de-DE translation: Standort-Tagebuch - language: el translation: Ημερολόγιο τοποθεσίας - language: es translation: Diario del sitio - language: fi translation: Sivuston päiväkirja - language: fr translation: Journal de chantier - language: he translation: יומן האתר - language: hu translation: Helyi napló - language: id translation: Buku harian situs - language: it translation: Diario del sito - language: ja translation: サイトダイアリー - language: ko-KR translation: 현장 일지 - language: nb - language: nl-NL translation: Bouwplaats logboek - language: pl translation: Dziennik witryny - language: pt translation: Livro de obra - language: ro translation: Jurnal de site - language: ru translation: Дневник сайта - language: sl-SI translation: Opažanja - language: sv translation: Webbplats dagbok - language: th translation: บันทึกประจำวันไซต์ - language: tr translation: Site günlüğü - language: vi translation: Nhật ký công trường - language: zf - language: zh-Hans translation: 工地工程日志 id: 391ede05-46a9-4676-99d7-cfe0d07f8a75 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Journal de chantier icon: bookOpen color: '#4CABF2' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Safety - language: ar translation: سلامة - language: ca translation: Seguretat - language: cs translation: Bezpečnost - language: da translation: Sikkerhed - language: de-DE translation: Sicherheit - language: el translation: Ασφάλεια - language: es translation: Seguridad - language: fi translation: Turvallisuus - language: fr translation: Sécurité - language: he translation: בטיחות - language: hu translation: Biztonság - language: id translation: Keamanan - language: it translation: Sicurezza - language: ja translation: 安全性 - language: ko-KR translation: 안전 - language: nb - language: nl-NL translation: Veiligheid - language: pl translation: Bezpieczeństwo - language: pt translation: Segurança - language: ro translation: Siguranță - language: ru translation: Безопасность - language: sl-SI translation: Varnost - language: sv translation: Säkerhet - language: th translation: ความปลอดภัย - language: tr translation: Emniyet - language: vi translation: An toàn - language: zf - language: zh-Hans translation: 安全 id: 3fd4f4af-089b-4e06-a924-32ee4f600f02 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Sécurité icon: helmet color: '#FF8029' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: true names: - language: en translation: Observations - language: ar translation: ملاحظات - language: ca translation: Observacions - language: cs translation: Pozorování - language: da translation: Bemærkninger - language: de-DE translation: Beobachtungen - language: el translation: Παρατηρήσεις - language: es translation: Observaciones - language: fi translation: Havaintoja - language: fr translation: Observations - language: he translation: תצפיות - language: hu translation: Észrevételek - language: id translation: Pengamatan - language: it translation: Osservazioni - language: ja translation: 指摘事項 - language: ko-KR translation: 관찰 사항 - language: nb - language: nl-NL translation: Opmerkingen - language: pl translation: Obserwacje - language: pt translation: Observações - language: ro translation: Observatii - language: ru translation: наблюдения - language: sl-SI translation: Opažanja - language: sv translation: observationer - language: th translation: ข้อสังเกต - language: tr translation: gözlemler - language: vi translation: Những theo dõi - language: zf - language: zh-Hans translation: 观察报告 id: 44d459d4-fa20-4484-b4bf-fd520c459566 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Observations icon: alert color: '#E94F3D' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Estimation - language: ar translation: تقدير - language: ca translation: Estimació - language: cs translation: Odhad - language: da translation: Skøn - language: de-DE translation: Einschätzung - language: el translation: Εκτίμηση - language: es translation: Estimación - language: fi translation: Arvio - language: fr translation: Estimation - language: he translation: אוּמדָן - language: hu translation: Becslés - language: id translation: Perkiraan - language: it translation: Stima - language: ja translation: 推定 - language: ko-KR translation: 견적 - language: nb - language: nl-NL translation: Schätzung - language: pl translation: Oszacowanie - language: pt translation: Estimativa - language: ro translation: Estimare - language: ru translation: Предварительный расчет - language: sl-SI translation: Ocena - language: sv translation: Uppskattning - language: th translation: การประมาณ - language: tr translation: Tahmin - language: vi translation: Dự báo - language: zf - language: zh-Hans translation: 估算 id: 478eb22c-30ee-4691-b27e-f2539f644794 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: 'Chiffrage ' icon: euro color: '#7783FF' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Materials - language: ar translation: المواد - language: ca translation: Materials - language: cs translation: Materiály - language: da translation: Materialer - language: de-DE translation: Materialien - language: el translation: Υλικά - language: es translation: Materiales - language: fi translation: tarvikkeet - language: fr translation: Matériaux - language: he translation: חומרים - language: hu translation: anyagok - language: id translation: Bahan - language: it translation: Materiali - language: ja translation: 素材 - language: ko-KR translation: 기재 - language: nb - language: nl-NL translation: Materialen - language: pl translation: Materiały - language: pt translation: Materiais - language: ro translation: Materiale - language: ru translation: материалы - language: sl-SI translation: Obrazci - language: sv translation: Material - language: th translation: วัสดุ - language: tr translation: Malzemeler - language: vi translation: Vật liệu - language: zf - language: zh-Hans translation: 材料 id: 70df7ea5-7ef6-4b71-9b52-848ec968a680 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Matériaux icon: bricks color: '#FF8029' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Tasks - language: ar translation: المهام - language: ca translation: Tasques - language: cs translation: Úkoly - language: da translation: Opgaver - language: de-DE translation: Tasks - language: el translation: Καθήκοντα - language: es translation: Tareas - language: fi translation: Tehtävät - language: fr translation: Tâches - language: he translation: משימות - language: hu translation: Feladatok - language: id translation: Rapat - language: it translation: Riunioni - language: ja translation: ミーティング - language: ko-KR translation: 회의 - language: nb - language: nl-NL translation: Vergaderingen - language: pl translation: Spotkania - language: pt translation: Encontros - language: ro translation: Întâlniri - language: ru translation: Встречи - language: sl-SI translation: Srečanja - language: sv translation: Möten - language: th translation: การประชุม - language: tr translation: Toplantılar - language: vi translation: Cuộc họp - language: zf - language: zh-Hans translation: 会议 id: 7fe77495-2ae5-4345-b647-f455be6a19d4 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Tâches icon: checkCircle color: '#3B7CDE' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Hygiene - language: ar translation: صحة - language: ca translation: Higiene - language: cs translation: Hygiena - language: da translation: Hygiejne - language: de-DE translation: Hygiene - language: el translation: Υγιεινή - language: es translation: Higiene - language: fi translation: Hygienia - language: fr translation: Hygiène - language: he translation: בריאות - language: hu translation: Higiénia - language: id translation: Kebersihan - language: it translation: Igiene - language: ja translation: 衛生 - language: ko-KR translation: 위생 - language: nb - language: nl-NL translation: Hygiëne - language: pl translation: Higiena - language: pt translation: Higiene - language: ro translation: Igienă - language: ru translation: Гигиена - language: sl-SI translation: Higiena - language: sv translation: Hygien - language: th translation: สุขอนามัย - language: tr translation: Hijyen - language: vi translation: Vệ sinh - language: zf - language: zh-Hans translation: 卫生 id: eab12a4a-7b44-46c1-abbb-9a6624369335 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Hygiène icon: clean color: '#92D8FF' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Extra Work - language: ar translation: عمل اضافي - language: ca translation: Treball extra - language: cs translation: Práce navíc - language: da translation: Ekstra arbejde - language: de-DE translation: Extra Arbeit - language: el translation: Επιπλέον δουλειά - language: es translation: Trabajo extra - language: fi translation: Lisätyö - language: fr translation: Extra Work - language: he translation: עבודה נוספת - language: hu translation: Extra munka - language: id translation: Pekerjaan Tambahan - language: it translation: Lavoro aggiuntivo - language: ja translation: エクストラ・ワーク - language: ko-KR translation: 추가 업무 - language: nb - language: nl-NL translation: Extra werk - language: pl translation: Dodatkowa praca - language: pt translation: Trabalho extra - language: ro translation: Muncă în plus - language: ru translation: Дополнительная работа - language: sl-SI translation: Dodatno delo - language: sv translation: Extraarbete - language: th translation: งานเพิ่มเติม - language: tr translation: ekstra iş - language: vi translation: Công việc thêm - language: zf - language: zh-Hans translation: 额外工作 id: be73ba88-1584-4d87-98a2-fee38da1b467 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Travaux supplémentaires icon: brush color: '#FFC267' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: true names: - language: en translation: Meetings - language: ar translation: الاجتماعات - language: ca translation: Reunions - language: cs translation: Setkání - language: da translation: Møder - language: de-DE translation: Meetings - language: el translation: Συναντήσεις - language: es translation: Reunións - language: fi translation: Kokoukset - language: fr translation: Réunions - language: he translation: פגישות - language: hu translation: Találkozók - language: id translation: Rapat - language: it translation: Riunioni - language: ja translation: ミーティング - language: ko-KR translation: 회의 - language: nb - language: nl-NL translation: Vergaderingen - language: pl translation: Spotkania - language: pt translation: Encontros - language: ro translation: Întâlniri - language: ru translation: Встречи - language: sl-SI translation: Srečanja - language: sv translation: Möten - language: th translation: การประชุม - language: tr translation: Toplantılar - language: vi translation: Cuộc họp - language: zf - language: zh-Hans translation: 会议 id: dfb800a2-cfa7-444c-ae30-5369f8535e17 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: 'Réunions ' icon: meetings color: '#4CABF2' type: Meetings created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Equipment - language: ar translation: ادوات - language: ca translation: Equipament - language: cs translation: Zařízení - language: da translation: Udstyr - language: de-DE translation: Ausrüstung - language: el translation: Εξοπλισμός - language: es translation: Equipo - language: fi translation: Laitteet - language: fr translation: Matériel - language: he translation: צִיוּד - language: hu translation: Felszerelés - language: id translation: Kerja tambahan - language: it translation: Lavoro extra - language: ja translation: エクストラ・ワーク - language: ko-KR translation: 추가 업무 - language: nb - language: nl-NL translation: Extra werk - language: pl translation: Sprzęt - language: pt translation: Equipamento - language: ro translation: echipament - language: ru translation: Оборудование - language: sl-SI translation: Oprema - language: sv translation: Utrustning - language: th translation: อุปกรณ์ - language: tr translation: ekipman - language: vi translation: Thiết bị - language: zf - language: zh-Hans translation: 设备 id: e53cc00d-4980-409e-9a52-40706fd77b5f container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: 'Equipement ' icon: hammer color: '#01D194' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Personnel - language: ar translation: شؤون الموظفين - language: ca translation: Personal - language: cs translation: Personál - language: da translation: Personale - language: de-DE translation: Personal - language: el translation: Προσωπικό - language: es translation: Personal - language: fi translation: Henkilöstö - language: fr translation: Personnel - language: he translation: שפחה - language: hu translation: Személyzet - language: id translation: Personal - language: it translation: Personale - language: ja translation: 人事 - language: ko-KR translation: 인원 - language: nb - language: nl-NL translation: Personeel - language: pl translation: Personel - language: pt translation: Pessoal - language: ro translation: Personal - language: ru translation: Персонал - language: sl-SI translation: Osebje - language: sv translation: Personal - language: th translation: บุคลากร - language: tr translation: personel - language: vi translation: Nhân viên - language: zf - language: zh-Hans translation: 人员 id: bbb01e29-efb0-4a11-9ab7-63849c58fd48 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: 'Personnel ' icon: people color: '#ED75A0' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false id: a41a8c18-b754-4b65-be6c-22c63987c995 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: New Forms icon: typePin color: '#E94F3D' type: Forms created_at: '2023-09-13T09:25:41.084751Z' updated_at: '2023-09-13T09:29:41.773268Z' - is_default: true id: 99e78c6b-2095-4500-9e42-ae97ea0ab63f container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: ddddd icon: typePin color: '#E94F3D' type: Forms created_at: '2023-09-20T11:32:50.554512Z' updated_at: '2023-09-20T11:32:56.254258Z' - is_default: false id: 5d4a8319-8c77-440a-94fe-afa0b09620a1 container_id: 8eebf534-35d6-4b2e-be4d-06d5428d896e container_type: Workspace name: azertyuiop icon: filesAndFolders color: '#01D194' type: Forms created_at: '2023-09-21T09:31:44.02647Z' updated_at: '2023-09-21T09:49:42.995462Z' count: 17 total_count: 17 limit: 50 offset: 0 Success_with_filter: value: suggestions: - is_default: true 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: 表单 id: 117f1c84-e69d-4429-baf9-74e052f5e0bc container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Formulaires icon: clipboard color: '#F7CE46' type: Forms created_at: '2023-06-30T15:16:42.168073Z' updated_at: '2024-10-31T15:57:26.726308Z' - is_default: false names: - language: en translation: Quality - language: ar translation: جودة - language: ca translation: Qualitat - language: cs translation: Kvalitní - language: da translation: Kvalitet - language: de-DE translation: Qualität - language: el translation: Ποιότητα - language: es translation: Calidad - language: fi translation: Laatu - language: fr translation: Qualité - language: he translation: איכות - language: hu translation: Minőség - language: id translation: Kualitas - language: it translation: Qualità - language: ja translation: 品質 - language: ko-KR translation: 품질 - language: nb - language: nl-NL translation: Kwaliteit - language: pl translation: Jakość - language: pt translation: Qualidade - language: ro translation: Calitate - language: ru translation: Качество - language: sl-SI translation: Kakovost - language: sv translation: Kvalitet - language: th translation: คุณภาพ - language: tr translation: Kalite - language: vi translation: Chất lượng - language: zf - language: zh-Hans translation: 质量 id: 125ae973-3e43-4862-9af4-3cb13dcac81c container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Qualité icon: star color: '#01D194' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Equipment - language: ar translation: ادوات - language: ca translation: Equipament - language: cs translation: Zařízení - language: da translation: Udstyr - language: de-DE translation: Ausrüstung - language: el translation: Εξοπλισμός - language: es translation: Equipo - language: fi translation: Laitteet - language: fr translation: Matériel - language: he translation: צִיוּד - language: hu translation: Felszerelés - language: id translation: Kerja tambahan - language: it translation: Lavoro extra - language: ja translation: エクストラ・ワーク - language: ko-KR translation: 추가 업무 - language: nb - language: nl-NL translation: Extra werk - language: pl translation: Sprzęt - language: pt translation: Equipamento - language: ro translation: echipament - language: ru translation: Оборудование - language: sl-SI translation: Oprema - language: sv translation: Utrustning - language: th translation: อุปกรณ์ - language: tr translation: ekipman - language: vi translation: Thiết bị - language: zf - language: zh-Hans translation: 设备 id: e53cc00d-4980-409e-9a52-40706fd77b5f container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Matériel icon: hammer color: '#01D194' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2024-09-27T06:52:10.465014Z' - is_default: false names: - language: en translation: Safety - language: ar translation: سلامة - language: ca translation: Seguretat - language: cs translation: Bezpečnost - language: da translation: Sikkerhed - language: de-DE translation: Sicherheit - language: el translation: Ασφάλεια - language: es translation: Seguridad - language: fi translation: Turvallisuus - language: fr translation: Sécurité - language: he translation: בטיחות - language: hu translation: Biztonság - language: id translation: Keamanan - language: it translation: Sicurezza - language: ja translation: 安全性 - language: ko-KR translation: 안전 - language: nb - language: nl-NL translation: Veiligheid - language: pl translation: Bezpieczeństwo - language: pt translation: Segurança - language: ro translation: Siguranță - language: ru translation: Безопасность - language: sl-SI translation: Varnost - language: sv translation: Säkerhet - language: th translation: ความปลอดภัย - language: tr translation: Emniyet - language: vi translation: An toàn - language: zf - language: zh-Hans translation: 安全 id: 3fd4f4af-089b-4e06-a924-32ee4f600f02 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Sécurité icon: helmet color: '#FF8029' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: true names: - language: en translation: Observations - language: ar translation: ملاحظات - language: ca translation: Observacions - language: cs translation: Pozorování - language: da translation: Bemærkninger - language: de-DE translation: Beobachtungen - language: el translation: Παρατηρήσεις - language: es translation: Observaciones - language: fi translation: Havaintoja - language: fr translation: Observations - language: he translation: תצפיות - language: hu translation: Észrevételek - language: id translation: Pengamatan - language: it translation: Osservazioni - language: ja translation: 指摘事項 - language: ko-KR translation: 관찰 사항 - language: nb - language: nl-NL translation: Opmerkingen - language: pl translation: Obserwacje - language: pt translation: Observações - language: ro translation: Observatii - language: ru translation: наблюдения - language: sl-SI translation: Opažanja - language: sv translation: observationer - language: th translation: ข้อสังเกต - language: tr translation: gözlemler - language: vi translation: Những theo dõi - language: zf - language: zh-Hans translation: 观察报告 id: 44d459d4-fa20-4484-b4bf-fd520c459566 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Observations icon: alert color: '#E94F3D' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Estimation - language: ar translation: تقدير - language: ca translation: Estimació - language: cs translation: Odhad - language: da translation: Skøn - language: de-DE translation: Einschätzung - language: el translation: Εκτίμηση - language: es translation: Estimación - language: fi translation: Arvio - language: fr translation: Estimation - language: he translation: אוּמדָן - language: hu translation: Becslés - language: id translation: Perkiraan - language: it translation: Stima - language: ja translation: 推定 - language: ko-KR translation: 견적 - language: nb - language: nl-NL translation: Schätzung - language: pl translation: Oszacowanie - language: pt translation: Estimativa - language: ro translation: Estimare - language: ru translation: Предварительный расчет - language: sl-SI translation: Ocena - language: sv translation: Uppskattning - language: th translation: การประมาณ - language: tr translation: Tahmin - language: vi translation: Dự báo - language: zf - language: zh-Hans translation: 估算 id: 478eb22c-30ee-4691-b27e-f2539f644794 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Estimation icon: euro color: '#7783FF' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2024-09-27T06:52:10.465014Z' - is_default: false names: - language: en translation: Materials - language: ar translation: المواد - language: ca translation: Materials - language: cs translation: Materiály - language: da translation: Materialer - language: de-DE translation: Materialien - language: el translation: Υλικά - language: es translation: Materiales - language: fi translation: tarvikkeet - language: fr translation: Matériaux - language: he translation: חומרים - language: hu translation: anyagok - language: id translation: Bahan - language: it translation: Materiali - language: ja translation: 素材 - language: ko-KR translation: 기재 - language: nb - language: nl-NL translation: Materialen - language: pl translation: Materiały - language: pt translation: Materiais - language: ro translation: Materiale - language: ru translation: материалы - language: sl-SI translation: Obrazci - language: sv translation: Material - language: th translation: วัสดุ - language: tr translation: Malzemeler - language: vi translation: Vật liệu - language: zf - language: zh-Hans translation: 材料 id: 70df7ea5-7ef6-4b71-9b52-848ec968a680 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Matériaux icon: bricks color: '#FF8029' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Tasks - language: ar translation: المهام - language: ca translation: Tasques - language: cs translation: Úkoly - language: da translation: Opgaver - language: de-DE translation: Tasks - language: el translation: Καθήκοντα - language: es translation: Tareas - language: fi translation: Tehtävät - language: fr translation: Tâches - language: he translation: משימות - language: hu translation: Feladatok - language: id translation: Rapat - language: it translation: Riunioni - language: ja translation: ミーティング - language: ko-KR translation: 회의 - language: nb - language: nl-NL translation: Vergaderingen - language: pl translation: Spotkania - language: pt translation: Encontros - language: ro translation: Întâlniri - language: ru translation: Встречи - language: sl-SI translation: Srečanja - language: sv translation: Möten - language: th translation: การประชุม - language: tr translation: Toplantılar - language: vi translation: Cuộc họp - language: zf - language: zh-Hans translation: 会议 id: 7fe77495-2ae5-4345-b647-f455be6a19d4 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Tâches icon: checkCircle color: '#3B7CDE' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Hygiene - language: ar translation: صحة - language: ca translation: Higiene - language: cs translation: Hygiena - language: da translation: Hygiejne - language: de-DE translation: Hygiene - language: el translation: Υγιεινή - language: es translation: Higiene - language: fi translation: Hygienia - language: fr translation: Hygiène - language: he translation: בריאות - language: hu translation: Higiénia - language: id translation: Kebersihan - language: it translation: Igiene - language: ja translation: 衛生 - language: ko-KR translation: 위생 - language: nb - language: nl-NL translation: Hygiëne - language: pl translation: Higiena - language: pt translation: Higiene - language: ro translation: Igienă - language: ru translation: Гигиена - language: sl-SI translation: Higiena - language: sv translation: Hygien - language: th translation: สุขอนามัย - language: tr translation: Hijyen - language: vi translation: Vệ sinh - language: zf - language: zh-Hans translation: 卫生 id: eab12a4a-7b44-46c1-abbb-9a6624369335 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Hygiène icon: clean color: '#92D8FF' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Personnel - language: ar translation: شؤون الموظفين - language: ca translation: Personal - language: cs translation: Personál - language: da translation: Personale - language: de-DE translation: Personal - language: el translation: Προσωπικό - language: es translation: Personal - language: fi translation: Henkilöstö - language: fr translation: Personnel - language: he translation: שפחה - language: hu translation: Személyzet - language: id translation: Personal - language: it translation: Personale - language: ja translation: 人事 - language: ko-KR translation: 인원 - language: nb - language: nl-NL translation: Personeel - language: pl translation: Personel - language: pt translation: Pessoal - language: ro translation: Personal - language: ru translation: Персонал - language: sl-SI translation: Osebje - language: sv translation: Personal - language: th translation: บุคลากร - language: tr translation: personel - language: vi translation: Nhân viên - language: zf - language: zh-Hans translation: 人员 id: bbb01e29-efb0-4a11-9ab7-63849c58fd48 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: 'Personnel ' icon: people color: '#ED75A0' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Extra Work - language: ar translation: عمل اضافي - language: ca translation: Treball extra - language: cs translation: Práce navíc - language: da translation: Ekstra arbejde - language: de-DE translation: Extra Arbeit - language: el translation: Επιπλέον δουλειά - language: es translation: Trabajo extra - language: fi translation: Lisätyö - language: fr translation: Travaux supplémentaires - language: he translation: עבודה נוספת - language: hu translation: Extra munka - language: id translation: Pekerjaan Tambahan - language: it translation: Lavoro aggiuntivo - language: ja translation: エクストラ・ワーク - language: ko-KR translation: 추가 업무 - language: nb - language: nl-NL translation: Extra werk - language: pl translation: Dodatkowa praca - language: pt translation: Trabalho extra - language: ro translation: Muncă în plus - language: ru translation: Дополнительная работа - language: sl-SI translation: Dodatno delo - language: sv translation: Extraarbete - language: th translation: งานเพิ่มเติม - language: tr translation: ekstra iş - language: vi translation: Công việc thêm - language: zf - language: zh-Hans translation: 额外工作 id: be73ba88-1584-4d87-98a2-fee38da1b467 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Travaux supplémentaires icon: brush color: '#FFC267' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2024-09-27T06:52:10.465014Z' - is_default: true names: - language: en translation: Meetings - language: ar translation: الاجتماعات - language: ca translation: Reunions - language: cs translation: Setkání - language: da translation: Møder - language: de-DE translation: Meetings - language: el translation: Συναντήσεις - language: es translation: Reunións - language: fi translation: Kokoukset - language: fr translation: Réunions - language: he translation: פגישות - language: hu translation: Találkozók - language: id translation: Rapat - language: it translation: Riunioni - language: ja translation: ミーティング - language: ko-KR translation: 회의 - language: nb - language: nl-NL translation: Vergaderingen - language: pl translation: Spotkania - language: pt translation: Encontros - language: ro translation: Întâlniri - language: ru translation: Встречи - language: sl-SI translation: Srečanja - language: sv translation: Möten - language: th translation: การประชุม - language: tr translation: Toplantılar - language: vi translation: Cuộc họp - language: zf - language: zh-Hans translation: 会议 id: dfb800a2-cfa7-444c-ae30-5369f8535e17 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: 'Réunions ' icon: meetings color: '#4CABF2' type: Meetings created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Environment - language: ar translation: بيئة - language: ca translation: Entorn - language: cs translation: životní prostředí - language: da translation: Miljø - language: de-DE translation: Umgebung - language: el translation: περιβάλλον - language: es translation: Medio ambiente - language: fi translation: ympäristö - language: fr translation: Environnement - language: he translation: סביבה - language: hu translation: Környezet - language: id translation: Lingkungan - language: it translation: Ambiente - language: ja translation: 環境 - language: ko-KR translation: 환경 - language: nb - language: nl-NL translation: Omgeving - language: pl translation: Środowisko - language: pt translation: Ambiente - language: ro translation: Mediu inconjurator - language: ru translation: Окружающая среда - language: sl-SI translation: Okolje - language: sv translation: Miljö - language: th translation: สิ่งแวดล้อม - language: tr translation: çevre - language: vi translation: Môi trường - language: zf - language: zh-Hans translation: 环境 id: 1d0ae170-f499-4649-b17d-d44008220600 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Environnemment icon: environment color: '#7FCE1A' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Site Diary - language: ar translation: يوميات الموقع - language: ca translation: Agenda de l'obra - language: cs translation: Deník webu - language: da translation: Site dagbog - language: de-DE translation: Standort-Tagebuch - language: el translation: Ημερολόγιο τοποθεσίας - language: es translation: Diario del sitio - language: fi translation: Sivuston päiväkirja - language: fr translation: Journal de chantier - language: he translation: יומן האתר - language: hu translation: Helyi napló - language: id translation: Buku harian situs - language: it translation: Diario del sito - language: ja translation: サイトダイアリー - language: ko-KR translation: 현장 일지 - language: nb - language: nl-NL translation: Bouwplaats logboek - language: pl translation: Dziennik witryny - language: pt translation: Livro de obra - language: ro translation: Jurnal de site - language: ru translation: Дневник сайта - language: sl-SI translation: Opažanja - language: sv translation: Webbplats dagbok - language: th translation: บันทึกประจำวันไซต์ - language: tr translation: Site günlüğü - language: vi translation: Nhật ký công trường - language: zf - language: zh-Hans translation: 工地工程日志 id: 391ede05-46a9-4676-99d7-cfe0d07f8a75 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Journal de chantier icon: bookOpen color: '#4CABF2' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false id: a41a8c18-b754-4b65-be6c-22c63987c995 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: New Forms icon: typePin color: '#E94F3D' type: Forms created_at: '2023-09-13T09:25:41.084751Z' updated_at: '2023-09-13T09:29:41.773268Z' - is_default: false id: 5d4a8319-8c77-440a-94fe-afa0b09620a1 container_id: 8eebf534-35d6-4b2e-be4d-06d5428d896e container_type: Workspace name: azertyuiop icon: filesAndFolders color: '#01D194' type: Forms created_at: '2023-09-21T09:31:44.02647Z' updated_at: '2023-09-21T09:49:42.995462Z' - is_default: false id: 67a8aed1-56f8-437e-91d9-0385c24c9aea container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: api test form answers icon: alertTriangle color: '#C0DF43' type: Forms created_at: '2023-11-30T08:25:00.24386Z' updated_at: '2025-04-18T07:49:46.231564Z' - is_default: false id: 15606d9b-c9f5-4726-bc0a-8590a3dc9dc6 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: test create new form aze icon: alert color: '#E94F3D' type: Forms created_at: '2024-02-15T09:50:14.619561Z' updated_at: '2024-09-09T13:53:20.009955Z' - is_default: false id: f5d33e97-6f40-478f-87bf-1fa04a0843ff container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: ngu postman 20230703 1420 icon: icon color: '#FFFFFF' type: Forms created_at: '2024-03-07T14:17:09.952617Z' updated_at: '2024-03-07T14:17:09.952617Z' - is_default: false id: 8cf9151c-0a0b-4675-befe-64d868b466ec container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: test update module name icon: alert color: '#E94F3D' type: Forms created_at: '2024-04-11T14:01:12.937062Z' updated_at: '2024-12-18T09:15:30.830208Z' - is_default: true id: da8571ab-c2ca-4ae1-afde-bd29dfcfb1d9 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: test obs icon: alertTriangle color: '#E94F3D' type: Forms created_at: '2024-06-04T12:12:50.000356Z' updated_at: '2024-08-23T11:55:54.19339Z' - is_default: true id: 0cefda90-84bb-4e8b-8c71-dd8945d377c4 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: test obs aze icon: alertTriangle color: '#E94F3D' type: Forms created_at: '2024-06-04T12:12:52.16862Z' updated_at: '2024-09-09T13:53:28.424634Z' - is_default: true id: 82f9a841-818e-459e-a5dd-7374ec43788d container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: module luc en orga icon: alert color: '#E94F3D' type: Forms created_at: '2024-10-30T15:43:49.867Z' updated_at: '2024-10-30T15:43:49.867Z' - is_default: false id: f75d9515-ccf7-48ea-8340-de581e9c780d container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: Test new module icon: key color: '#3B7CDE' type: Forms created_at: '2024-12-18T09:15:00.635804Z' updated_at: '2024-12-18T09:15:07.989271Z' - is_default: false id: 7d973d98-f542-4b81-ae0b-53f082e4fca0 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: Simon icon: key color: '#01D194' type: Forms created_at: '2024-12-18T09:48:49.416373Z' updated_at: '2024-12-18T09:49:14.845621Z' - is_default: true id: 973f6f39-3df5-47fc-a1b7-1162a9cc19db container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: 2025-01-27-answers icon: clipboard color: '#F7CE46' type: Forms created_at: '2025-01-27T10:21:32.853823Z' updated_at: '2025-01-27T10:22:23.79912Z' - is_default: false id: 22fed8ff-5507-4bf2-b1af-eec4fa42aa99 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: test luc icon: typePin color: '#E94F3D' type: Forms created_at: '2025-04-03T08:56:16.551642Z' updated_at: '2025-04-03T08:56:28.267866Z' count: 27 total_count: 27 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' /organizations/{organization_id}/modules/{module_id}: put: operationId: librariesModulesFormModuleTypeUpdateModule summary: Update module description: "You can modify a specific form module in a specific workspace.\n\n Endpoint mandatory infos \n Details\ \ \n\n organization_Id \n the id of the organization to be modified \n\n workspace_id \n id of your workspace \n\n\ \ module_id \n id of the module to be modified \n\n body options 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 visibility \n visibiity of the module in the module suggestion s list in project creation \nDefault=>checked\ \ by default \nAvailable => unchecked by default \nNotAvailable => not 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. - 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: qsdfgh visibility: Available responses: '200': description: OK content: application/json: schema: type: object examples: Modify_Module: value: id: 8cf9151c-0a0b-4675-befe-64d868b466ec container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: test create new form Available icon: alert color: '#E94F3D' type: Forms visibility: Available created_at: '2024-04-11T14:01:12.937062Z' updated_at: '2024-04-11T14:02:20.7693002Z' '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}/modules/{module_id}/categories: post: operationId: librariesModulesFormModuleTypeCreateCategory summary: Create category description: "You can create a new category in your module in your organization.\n\n Endpoint mandatory info \n Details\ \ \n\n organization_id \n The ID of your organization \n\n module_id \n id of your module \n\n Body params mandatory\ \ \n\n name \n name of the category \n\n Body params optionals \n\n parent_id \n parent category id if any" tags: - Libraries parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_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: cat 3----3 parent_id: 04bf1a6d-ce26-484f-93f5-d489eb71452b responses: '200': description: OK content: application/json: schema: type: object examples: Create_Category: value: id: 2a9558c9-de86-4d6d-8b82-93f9896870d9 container_id: 2421734c-f191-4237-acd8-becf216eaae4 parent_id: 04bf1a6d-ce26-484f-93f5-d489eb71452b name: cat 3----3 created_at: '2024-04-11T14:06:21.9798477Z' updated_at: '2024-04-11T14:06:21.9798477Z' 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' /organizations/{organization_id}/modules/{module_id}/categories/{category_id}: put: operationId: librariesModulesFormModuleTypeUpdateCategory summary: Update category description: "You can rename a category in your module at the organization level.\n\n Endpoint mandatory info \n Details\ \ \n\n organization_id \n The ID of your organization \n\n module_id \n id of your module \n\n category_id \n id of\ \ the category \n\n Body params mandatory \n\n name \n new name of the category" tags: - Libraries parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_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. - name: category_id in: path required: true schema: type: string description: Path variable `category_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: name: cat 3--====----3 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' delete: operationId: librariesModulesFormModuleTypeDeleteCategory summary: Delete category description: "You can delete a category in your module at the organization level.\n\n Endpoint mandatory info \n Details\ \ \n\n organization_id \n The ID of your organization \n\n module_id \n id of your module \n\n category_id \n id of\ \ the category" tags: - Libraries parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_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. - name: category_id in: path required: true schema: type: string description: Path variable `category_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' /organizations/{organization_id}/modules/{module_id}/link-forms: post: operationId: librariesModulesFormModuleTypeAddFormLink summary: Add form link description: "You can link form templates to a module in a workspace.\n\n Endpoint mandatory infos \n Details \n\n organization_id\ \ \n id of your organization \n\n workspace_id \n id of your workspace \n\n module_id \n id of the module \n\n body\ \ mandatory infos \n Details \n\n form_ids \n list of ids of the forms" tags: - Libraries parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_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: form_ids: - category_id: '{{category_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' /organizations/{organization_id}/modules/{module_id}/unlink-forms: post: operationId: librariesModulesFormModuleTypeRemoveFormLink summary: Remove form link description: "You can remove the link of form templates to a module in a workspace.\n\n Endpoint mandatory infos \n\ \ Details \n\n organization_id \n id of your organization \n\n workspace_id \n id of your workspace \n\n module_id\ \ \n id of the module \n\n body mandatory infos \n Details \n\n form_ids \n list of ids of the forms" tags: - Libraries parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_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: form_ids: - category_id: '{{category_id}}' responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 99e78c6b-2095-4500-9e42-ae97ea0ab63f container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: ddddd icon: typePin color: '#E94F3D' type: Forms visibility: Default created_at: '2023-09-20T11:32:50.554512Z' updated_at: '2023-09-20T11:32:56.254258Z' '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}/organization-roles: get: operationId: membersGetRoles summary: Get roles description: "You can get organization roles here that you will associate with new members.\n\n Organization admin :\ \ Manages the organization and sees all projects\n\n Workspace manager : Can manage the workspace and can create and\ \ manage their projects\n\n Organization member : Can create and manage their projects\n\n Organization guest : Can\ \ see their projects" tags: - Members 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: organization_roles: - id: e735e603-225a-47d1-bd39-72a1afae7c9f name: Organization admin description: Manage organization names: translation_fallback: Organization admin translations: - language: es translation: Administrador de la organización - language: ja translation: 組織管理者 - language: zh translation: 组织管理员 - language: vi translation: Quản trị viên của tổ chức - language: fr translation: Administrateur de l'organisation - language: ca translation: Administrador de l'organització - language: nl translation: Beheer organisatie - language: th translation: ผู้ดูแลองค์กร - language: de translation: Administrator der Organisation - language: it translation: Amministratore organizzazione - language: pt translation: Admin da organização - language: en translation: Organization admin descriptions: translation_fallback: Manage organization translations: - language: it translation: Gestisci l'organizzazione - language: ca translation: Gestionar l'organització - language: zh translation: 管理组织 - language: de translation: 'Organisation verwalten ' - language: vi translation: Quản lý tổ chức - language: en translation: Manage organization - language: th translation: จัดการองค์กร - language: es translation: Gestiona la organización - language: pt translation: Gerir a organização - language: ja translation: 組織を管理する - language: nl translation: Organisatie beheren - language: fr translation: Gérer l'organisation is_default: false is_default_invitation_role: false user_count: 3 position: 0 authorization_role_id: e735e603-225a-47d1-bd39-72a1afae7c9f is_lower_role: false - id: fbaed956-2c60-42b5-8763-8f62d6dd74a7 name: Workspace Manager description: Create & edit workspaces names: translation_fallback: Workspace Manager translations: - language: th translation: ผู้จัดการพื้นที่ทำงาน - language: de translation: Workspace Manager - language: nl translation: Werkruimtebeheer - language: en translation: Workspace Manager - language: vi translation: Quản lý không gian làm việc - language: es translation: Gestor de espacio de trabajo - language: fr translation: Manager d'espace de travail - language: it translation: Responsabile dello spazio di lavoro - language: zh translation: 工作空间管理者 - language: ja translation: ワークスペース・マネージャー - language: pt translation: Gestor do espaço de trabalho - language: ca translation: Gestor de l'entorn de treball descriptions: translation_fallback: Create & edit workspaces translations: - language: de translation: Arbeitsbereiche anlegen und bearbeiten - language: fr translation: Créer et modifier des espaces de travail - language: zh translation: 创建并和编辑工作空间 - language: vi translation: Tạo và chỉnh sửa không gian làm việc - language: it translation: Creare e modificare gli spazi di lavoro - language: en translation: Create & edit workspaces - language: th translation: สร้างและแก้ไขพื้นที่ทำงาน - language: ja translation: ワークスペースを作成・編集します - language: es translation: Crear y editar espacios de trabajo - language: nl translation: Werkruimtes aanmaken en bewerken - language: ca translation: Crea i edita espais de treball - language: pt translation: Criar e editar áreas de trabalho is_default: false is_default_invitation_role: false user_count: 1 position: 1 authorization_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7 higher_role_id: e735e603-225a-47d1-bd39-72a1afae7c9f is_lower_role: false - id: 932c489a-06dc-427b-912c-ca2d9709ac8e name: Organization member description: Create and manage my projects names: translation_fallback: Organization member translations: - language: nl translation: Lid organisatie - language: ja translation: 組織メンバー - language: pt translation: Membro da organização - language: it translation: Membro organizzazione - language: fr translation: Membre de l'organisation - language: vi translation: Thành viên của tổ chức - language: ca translation: Membre de l'organització - language: de translation: Mitglied der Organisation - language: zh translation: 组织成员 - language: th translation: สมาชิกองค์กร - language: en translation: Organization member - language: es translation: Miembro de la organización descriptions: translation_fallback: Create and manage my projects translations: - language: de translation: Meine Projekte erstellen und verwalten - language: es translation: Crea y gestiona mis proyectos - language: pt translation: Criar e gerir os meus projetos - language: en translation: Create and manage my projects - language: nl translation: Mijn projecten creëren en beheren - language: th translation: สร้างและจัดการโครงการของฉัน - language: vi translation: Tạo và quản lý các dự án của tôi - language: ja translation: プロジェクトを作成・更新できます - language: zh translation: 创建和管理我的项目 - language: it translation: Crea e gestisci i miei progetti - language: ca translation: Crear i gestionar els meus projectes - language: fr translation: Créer et gérer mes projets is_default: true is_default_invitation_role: false user_count: 14 position: 2 authorization_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e higher_role_id: fbaed956-2c60-42b5-8763-8f62d6dd74a7 is_lower_role: false - id: b2fc2d17-c18f-4ee6-9e9b-1d4b4c872a88 name: Organization guest description: See my projects names: translation_fallback: Organization guest translations: - language: de translation: Gast der Organisation - language: ca translation: Convidat de l'organització - language: en translation: Organization guest - language: es translation: Invitado de la organización - language: th translation: แขกขององค์กร - language: it translation: Ospite organizzazione - language: nl translation: Gast organisatie - language: pt translation: Convidado da organização - language: vi translation: Khách của tổ chức - language: fr translation: Invité de l'organisation - language: ja translation: 組織ゲスト - language: zh translation: 组织访客 descriptions: translation_fallback: See my projects translations: - language: it translation: Vedi i miei progetti - language: fr translation: Voir mes projets - language: es translation: Ve mis proyectos - language: en translation: See my projects - language: de translation: Meine Projekte anzeigen - language: ca translation: Veure els meus projectes - language: nl translation: Mijn projecten bekijken - language: zh translation: 查看我的项目 - language: pt translation: Ver os meus projetos - language: th translation: ดูโครงการของฉัน - language: vi translation: Xem các dự án của tôi - language: ja translation: 登録されたプロジェクトの閲覧のみ is_default: false is_default_invitation_role: false user_count: 0 position: 3 authorization_role_id: b2fc2d17-c18f-4ee6-9e9b-1d4b4c872a88 higher_role_id: 932c489a-06dc-427b-912c-ca2d9709ac8e is_lower_role: 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' /organizations/{organization_id}/priorities: get: operationId: librariesPriorityLibraryGetOrganizationPrioritiesLibrary summary: Get organization priorities library description: "Before updating your priorities, you might want to have an overview of the ones deployed in your organization.\n\ \n This helps you manage your organization based on the current context.\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 \n\n Quary mandatory params \n détail \n\n module_type\ \ \n Observations or Forms" 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: module_type: Observation priorities: - id: 09d6b06b-731e-452f-9a87-de2c0761d5fc name: LowLow position: 0 color: '#49cb0c' icon: ChevronDown is_default: true names: - language: ca translation: LowLow - language: cs translation: LowLow - language: da translation: LowLow - language: de translation: LowLow - language: en translation: LowLow - language: es translation: LowLow - language: fi translation: LowLow - language: fr translation: Bas - language: he translation: LowLow - language: hu translation: LowLow - language: it translation: LowLow - language: ja translation: LowLow - language: ko translation: LowLow - language: nl translation: LowLow - language: 'no' translation: LowLow - language: pl translation: LowLow - language: pt translation: LowLow - language: ru translation: LowLow - language: sl translation: LowLow - language: sv translation: LowLow - language: th translation: LowLow - language: vi translation: LowLow - language: zf translation: LowLow - language: zh translation: LowLow enabled: true created_at: '2023-07-18T09:45:39.537116Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:42:28.426842Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 4a477dfe-6dc5-48ec-9f20-3654cb6d493d name: Medium position: 1 color: '#ff8029' icon: ChevronUp is_default: false names: - language: ca translation: Medium - language: cs translation: Medium - language: da translation: Medium - language: de translation: Medium - language: en translation: Medium - language: es translation: Medium - language: fi translation: Medium - language: fr translation: Medium - language: he translation: Medium - language: hu translation: Medium - language: it translation: Medium - language: ja translation: Medium - language: ko translation: Medium - language: nl translation: Medium - language: 'no' translation: Medium - language: pl translation: Medium - language: pt translation: Medium - language: ru translation: Medium - language: sl translation: Medium - language: sv translation: Medium - language: th translation: Medium - language: vi translation: Medium - language: zf translation: Medium - language: zh translation: Medium enabled: true created_at: '2023-07-18T09:45:39.537919Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:42:28.427451Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 40f7de2d-a7ec-43d2-bf22-2a9ae827cebe name: High position: 2 color: '#e94f3d' icon: AlertTriangle is_default: false names: - language: ca translation: High - language: cs translation: High - language: da translation: High - language: de translation: High - language: en translation: High - language: es translation: High - language: fi translation: High - language: fr translation: High - language: he translation: High - language: hu translation: High - language: it translation: High - language: ja translation: High - language: ko translation: High - language: nl translation: High - language: 'no' translation: High - language: pl translation: High - language: pt translation: High - language: ru translation: High - language: sl translation: High - language: sv translation: High - language: th translation: High - language: vi translation: High - language: zf translation: High - language: zh translation: High enabled: true created_at: '2023-07-18T09:45:39.540018Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:42:28.427528Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: aeef7f07-7005-439f-ad72-c6a92c3f88c9 name: xxxx position: 3 color: '#E94F3D' icon: EmojiSad is_default: false names: - language: ca translation: xxxx - language: cs translation: xxxx - language: da translation: xxxx - language: de translation: xxxx - language: en translation: xxxx - language: es translation: xxxx - language: fi translation: xxxx - language: fr translation: xxxx - language: he translation: xxxx - language: hu translation: xxxx - language: it translation: xxxx - language: ja translation: xxxx - language: ko translation: xxxx - language: nl translation: xxxx - language: 'no' translation: xxxx - language: pl translation: xxxx - language: pt translation: xxxx - language: ru translation: xxxx - language: sl translation: xxxx - language: sv translation: xxxx - language: th translation: xxxx - language: vi translation: xxxx - language: zf translation: xxxx - language: zh translation: xxxx enabled: true created_at: '2024-05-27T12:37:12.10673Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2025-01-30T13:42:28.427569Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a 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' put: operationId: librariesPriorityLibraryUpdateOrganizationPrioritiesLibrary summary: Update organization priorities library description: "Update your list of priorities.\n\n This cannot be done one by one. you need to manage your entire list\ \ of observation or form priorities to preserve all existing priorities. So, in case you want to...\n\n add new priorities\ \ to your list, you need to get the existing list, add the new ones to this list, and then send your request\n\n remove\ \ priorities from your list, you need to get the existing list, remove the targeted ones, and then send the request\n\ \n update some priorities, you need to get the existing list, change the targeted field values, and then send the\ \ request\n\n Endpoint mandatory parameters \n Details \n\n organization_id \n id of your organization \n\n Body parameters\ \ \n détail \n\n module_type \n observation or form \n\n and a list of \n\n position \n order in the list \n\n color\ \ \n rgb code of the color \n\n icon \n icon name \n\n is_default \n true for the default one \nfalse else \n\n names\ \ \n list of names and langages" tags: - Libraries 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: module_type: Forms priorities: - id: 71f4617d-b5a7-4aa5-9ef5-7adfd38c30a6 position: 0 color: '#49CB0C' icon: ChevronDown is_default: true names: - language: ca translation: Low - language: de translation: Low - language: en translation: Low - language: es translation: Low - language: fr translation: Faible - language: it translation: Low - language: ja translation: Low - language: ko translation: Low - language: nl translation: Low - language: pt translation: Low - language: th translation: Low - language: vi translation: Low - language: zh translation: Low enabled: false created_at: '2022-11-09T08:24:47.119241Z' created_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a updated_at: '2022-11-09T08:24:58.346447Z' updated_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a - id: 564bf1e4-8790-459f-b20f-d363b32f6eaf position: 1 color: '#FF8029' icon: ChevronUp is_default: false names: - language: ca translation: Medium - language: de translation: Medium - language: en translation: Medium - language: es translation: Medium - language: fr translation: Moyenne - language: it translation: Medium - language: ja translation: Medium - language: ko translation: Medium - language: nl translation: Medium - language: pt translation: Medium - language: th translation: Medium - language: vi translation: Medium - language: zh translation: Medium enabled: false created_at: '2022-11-09T08:24:47.290752Z' created_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a updated_at: '2022-11-09T08:24:58.346947Z' updated_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a - id: be3896af-b748-46c3-b3e7-eb40205ff0b9 position: 2 color: '#E94F3D' icon: ChevronsUp is_default: false names: - language: ca translation: High - language: de translation: High - language: en translation: High - language: es translation: High - language: fr translation: Haute - language: it translation: High - language: ja translation: High - language: ko translation: High - language: nl translation: High - language: pt translation: High - language: th translation: High - language: vi translation: High - language: zh translation: High enabled: false created_at: '2022-11-09T08:24:47.291942Z' created_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a updated_at: '2022-11-09T08:24:58.347773Z' updated_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a - id: 5eb73550-c90a-4c72-916e-a8a573e302bb position: 3 color: '#E94F3D' icon: AlertTriangle is_default: false names: - language: ca translation: Critical - language: de translation: Critical - language: en translation: Critical - language: es translation: Critical - language: fr translation: Critique - language: it translation: Critical - language: ja translation: Critical - language: ko translation: Critical - language: nl translation: Critical - language: pt translation: Critical - language: th translation: Critical - language: vi translation: Critical - language: zh translation: Critical enabled: false created_at: '2022-11-09T08:24:47.292419Z' created_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a updated_at: '2022-11-09T08:24:58.347811Z' updated_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a responses: '200': description: OK content: application/json: schema: type: object examples: Success_observation: value: module_type: Observation priorities: - id: e00ab780-f6b9-437e-a743-713a7e21fa14 position: 1 color: '#AABBF0' icon: RoundOne is_default: false names: - language: fr translation: Faible - language: en translation: Low - id: 90eb2de7-0d27-4df8-8ebe-e7a7442e99f7 position: 2 color: '#DD33BC' icon: RoundTwo is_default: false names: - language: fr translation: Moyenne - language: en translation: Medium - id: fb148b88-ac9d-403f-b16f-e2a3650268fd position: 3 color: '#6633BC' icon: RoundThree is_default: true names: - language: fr translation: Haute - language: en translation: High Success_forms: value: module_type: Forms priorities: - id: 5d162b0d-f058-4973-a33a-586baf03b10a position: 0 color: '#49CB0C' icon: ChevronDown is_default: true names: - language: ca translation: Low - language: de translation: Low - language: en translation: Low - language: es translation: Low - language: fr translation: Faible - language: it translation: Low - language: ja translation: Low - language: ko translation: Low - language: nl translation: Low - language: pt translation: Low - language: th translation: Low - language: vi translation: Low - language: zh translation: Low enabled: false created_at: '2023-09-28T09:13:55.6365524Z' created_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a updated_at: '2023-09-28T09:13:55.6365524Z' updated_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a - id: be3c15f4-3315-461e-a8c5-e0acae396fa6 position: 1 color: '#FF8029' icon: ChevronUp is_default: false names: - language: ca translation: Medium - language: de translation: Medium - language: en translation: Medium - language: es translation: Medium - language: fr translation: Moyenne - language: it translation: Medium - language: ja translation: Medium - language: ko translation: Medium - language: nl translation: Medium - language: pt translation: Medium - language: th translation: Medium - language: vi translation: Medium - language: zh translation: Medium enabled: false created_at: '2023-09-28T09:13:55.6379854Z' created_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a updated_at: '2023-09-28T09:13:55.6379854Z' updated_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a - id: d48db10a-71a9-4bfe-a1f1-5bfcd326eb87 position: 2 color: '#E94F3D' icon: ChevronsUp is_default: false names: - language: ca translation: High - language: de translation: High - language: en translation: High - language: es translation: High - language: fr translation: Haute - language: it translation: High - language: ja translation: High - language: ko translation: High - language: nl translation: High - language: pt translation: High - language: th translation: High - language: vi translation: High - language: zh translation: High enabled: false created_at: '2023-09-28T09:13:55.6385018Z' created_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a updated_at: '2023-09-28T09:13:55.6385018Z' updated_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a - id: fa21b08c-7f6b-424b-845c-b1fa9e34ce7d position: 3 color: '#E94F3D' icon: AlertTriangle is_default: false names: - language: ca translation: Critical - language: de translation: Critical - language: en translation: Critical - language: es translation: Critical - language: fr translation: Critique - language: it translation: Critical - language: ja translation: Critical - language: ko translation: Critical - language: nl translation: Critical - language: pt translation: Critical - language: th translation: Critical - language: vi translation: Critical - language: zh translation: Critical enabled: false created_at: '2023-09-28T09:13:55.6390825Z' created_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a updated_at: '2023-09-28T09:13:55.6390825Z' updated_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a '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}/remove-members: post: operationId: membersRemoveMembers summary: Remove members description: "You can remove users from an organization.\n\n Endpoint mandatory infos \n Details \n\n organisation_id\ \ \n the id of the organizationto be modified \n\n body mandatory infos \n Details \n\n user_ids \n List of ids to\ \ be removed \n This is not the User_id but the Id field returned by Get members" tags: - Members 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: user_ids: - the_user_id - another_user_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' /organizations/{organization_id}/statuses: get: operationId: librariesObservationStatusLibraryGetOrganizationObservationStatusLibrary summary: Get organization observation status library description: "Before updating your observation statuses, you might want to have an overview of the ones deployed in\ \ your organization. This helps you manage your organization based on the current context.\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: statuses: - id: 97828643-9fd6-4fb6-a0c9-c4823914059b position: 0 color: '#898989' is_default: true names: - language: ko translation: New - language: nl translation: New - language: zh translation: New - language: it translation: New - language: de translation: New - language: ja translation: New - language: th translation: New - language: pt translation: New - language: fr translation: New - language: en translation: New - language: ca translation: New - language: es translation: New - language: vi translation: New to_statuses: - id: 852f4900-d10c-4f71-a6c9-da5233e78aa4 is_deleted: false project_role_ids: - a5403a10-6cf2-4a1f-84d1-c772f63594c7 - 041391c6-cb0a-4157-bb5e-fc3469ea9c69 - id: 04790ae6-4352-410b-9829-e007fd3c86b9 is_deleted: false project_role_ids: - 041391c6-cb0a-4157-bb5e-fc3469ea9c69 - a5403a10-6cf2-4a1f-84d1-c772f63594c7 - 7fd408b4-4919-4ede-8e1d-0fb0e10102e9 - 941471e4-a7f2-490c-a217-c9dc8ef8d55f - id: bd4aa121-f33b-4f95-aae9-5633d5fddad7 is_deleted: false project_role_ids: - a5403a10-6cf2-4a1f-84d1-c772f63594c7 - 941471e4-a7f2-490c-a217-c9dc8ef8d55f - 041391c6-cb0a-4157-bb5e-fc3469ea9c69 - 7fd408b4-4919-4ede-8e1d-0fb0e10102e9 created_at: '2023-01-23T14:47:08.812452Z' created_by: b60128af-cfc2b362-73cb-47ca-ba49-5bc481fbfdbb updated_at: '2023-01-24T14:13:07.604152Z' updated_by: b60128af-cfc2b362-73cb-47ca-ba49-5bc481fbfdbb - id: bd4aa121-f33b-4f95-aae9-5633d5fddad7 position: 1 color: '#4CABF2' is_default: false names: - language: ja translation: To do - language: it translation: To do - language: fr translation: To do - language: nl translation: To do - language: es translation: To do - language: pt translation: To do - language: de translation: To do - language: zh translation: To do - language: en translation: To do - language: ca translation: To do - language: ko translation: To do - language: th translation: To do - language: vi translation: To do to_statuses: - id: 04790ae6-4352-410b-9829-e007fd3c86b9 is_deleted: false project_role_ids: - a5403a10-6cf2-4a1f-84d1-c772f63594c7 - 7fd408b4-4919-4ede-8e1d-0fb0e10102e9 - 041391c6-cb0a-4157-bb5e-fc3469ea9c69 - 941471e4-a7f2-490c-a217-c9dc8ef8d55f - id: 97828643-9fd6-4fb6-a0c9-c4823914059b is_deleted: false project_role_ids: - 7fd408b4-4919-4ede-8e1d-0fb0e10102e9 - a5403a10-6cf2-4a1f-84d1-c772f63594c7 - id: 852f4900-d10c-4f71-a6c9-da5233e78aa4 is_deleted: false project_role_ids: - 941471e4-a7f2-490c-a217-c9dc8ef8d55f - 041391c6-cb0a-4157-bb5e-fc3469ea9c69 - 7fd408b4-4919-4ede-8e1d-0fb0e10102e9 - a5403a10-6cf2-4a1f-84d1-c772f63594c7 created_at: '2023-01-23T14:47:08.914897Z' created_by: b60128af-cfc2b362-73cb-47ca-ba49-5bc481fbfdbb updated_at: '2023-01-24T14:13:07.605375Z' updated_by: b60128af-cfc2b362-73cb-47ca-ba49-5bc481fbfdbb - id: 852f4900-d10c-4f71-a6c9-da5233e78aa4 position: 2 color: '#FF8029' is_default: false names: - language: th translation: In Progress - language: en translation: In Progress - language: ca translation: In Progress - language: de translation: In Progress - language: vi translation: In Progress - language: pt translation: In Progress - language: ko translation: In Progress - language: fr translation: In Progress - language: es translation: In Progress - language: nl translation: In Progress - language: ja translation: In Progress - language: zh translation: In Progress - language: it translation: In Progress to_statuses: - id: 97828643-9fd6-4fb6-a0c9-c4823914059b is_deleted: false project_role_ids: - a5403a10-6cf2-4a1f-84d1-c772f63594c7 - 041391c6-cb0a-4157-bb5e-fc3469ea9c69 - id: bd4aa121-f33b-4f95-aae9-5633d5fddad7 is_deleted: false project_role_ids: - 041391c6-cb0a-4157-bb5e-fc3469ea9c69 - a5403a10-6cf2-4a1f-84d1-c772f63594c7 - 7fd408b4-4919-4ede-8e1d-0fb0e10102e9 - id: 04790ae6-4352-410b-9829-e007fd3c86b9 is_deleted: false project_role_ids: - 941471e4-a7f2-490c-a217-c9dc8ef8d55f - 041391c6-cb0a-4157-bb5e-fc3469ea9c69 - a5403a10-6cf2-4a1f-84d1-c772f63594c7 - 7fd408b4-4919-4ede-8e1d-0fb0e10102e9 created_at: '2023-01-23T14:47:08.916331Z' created_by: b60128af-cfc2b362-73cb-47ca-ba49-5bc481fbfdbb updated_at: '2023-01-24T14:13:07.606225Z' updated_by: b60128af-cfc2b362-73cb-47ca-ba49-5bc481fbfdbb - id: 04790ae6-4352-410b-9829-e007fd3c86b9 position: 3 color: '#E94F3D' is_default: false names: - language: vi translation: test - language: ca translation: test - language: ja translation: test - language: it translation: test - language: zh translation: test - language: th translation: test - language: fr translation: test - language: nl translation: test - language: es translation: test - language: en translation: test - language: ko translation: test - language: pt translation: test - language: de translation: test to_statuses: - id: 852f4900-d10c-4f71-a6c9-da5233e78aa4 is_deleted: false - id: 97828643-9fd6-4fb6-a0c9-c4823914059b is_deleted: false - id: bd4aa121-f33b-4f95-aae9-5633d5fddad7 is_deleted: false created_at: '2023-01-23T15:24:18.407299Z' created_by: b60128af-cfc2b362-73cb-47ca-ba49-5bc481fbfdbb updated_at: '2023-01-24T14:13:07.606404Z' updated_by: b60128af-cfc2b362-73cb-47ca-ba49-5bc481fbfdbb 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' put: operationId: librariesObservationStatusLibraryUpdateOrganizationObservationStatusLibrary summary: Update organization observation status library description: "Update your list of observation statuses. This cannot be done one by one; you need to manage the entire\ \ list. The behavior is aligned with the update of organization priorities.\n\n Endpoint mandatory parameters \n Details\ \ \n\n organization_id \n id of your organization \n\n Body parameters \n Details \n\n projects_ids \n observation\ \ or formlist of projects ids to be modified \nnull for modifiing the organization itself \n\n and a list of \n\n\ \ id \n id of the status if exist \n\n position \n order in the list \n\n color \n rgb code of the color \n\n icon\ \ \n icon name \n\n is_default \n true for the default one \nfalse else \n\n names \n list of names and langages \n\ \n to_statuses \n list of next statuses in the workflow \n\n id \n id of the status \n\n project_role_ids \n usable\ \ in this roles" tags: - Libraries 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 responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: statuses: - id: 97828643-9fd6-4fb6-a0c9-c4823914059b position: 0 color: '#898989' is_default: true names: - language: it translation: New - language: zh translation: New - language: th translation: New - language: ja translation: New - language: fr translation: New - language: pt translation: New - language: de translation: New - language: ko translation: New - language: vi translation: New - language: nl translation: New - language: ca translation: New - language: en translation: New - language: es translation: New to_statuses: - id: 852f4900-d10c-4f71-a6c9-da5233e78aa4 is_deleted: false project_role_ids: - a5403a10-6cf2-4a1f-84d1-c772f63594c7 - 041391c6-cb0a-4157-bb5e-fc3469ea9c69 - id: bd4aa121-f33b-4f95-aae9-5633d5fddad7 is_deleted: false project_role_ids: - 7fd408b4-4919-4ede-8e1d-0fb0e10102e9 - 041391c6-cb0a-4157-bb5e-fc3469ea9c69 - a5403a10-6cf2-4a1f-84d1-c772f63594c7 - 941471e4-a7f2-490c-a217-c9dc8ef8d55f - id: 29cf3a19-0f8c-430c-b2b6-8f7555ec31d5 is_deleted: false project_role_ids: - 941471e4-a7f2-490c-a217-c9dc8ef8d55f - a5403a10-6cf2-4a1f-84d1-c772f63594c7 - 7fd408b4-4919-4ede-8e1d-0fb0e10102e9 - 041391c6-cb0a-4157-bb5e-fc3469ea9c69 created_at: '2023-02-09T10:12:13.532531Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-02-14T09:40:59.0856322Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: bd4aa121-f33b-4f95-aae9-5633d5fddad7 position: 1 color: '#4CABF2' is_default: false names: - language: ko translation: To do - language: fr translation: To do - language: en translation: To do - language: ja translation: To do - language: vi translation: To do - language: it translation: To do - language: pt translation: To do - language: nl translation: To do - language: de translation: To do - language: zh translation: To do - language: ca translation: To do - language: th translation: To do - language: es translation: To do to_statuses: - id: 97828643-9fd6-4fb6-a0c9-c4823914059b is_deleted: false project_role_ids: - a5403a10-6cf2-4a1f-84d1-c772f63594c7 - 7fd408b4-4919-4ede-8e1d-0fb0e10102e9 - id: 29cf3a19-0f8c-430c-b2b6-8f7555ec31d5 is_deleted: false project_role_ids: - a5403a10-6cf2-4a1f-84d1-c772f63594c7 - 041391c6-cb0a-4157-bb5e-fc3469ea9c69 - 941471e4-a7f2-490c-a217-c9dc8ef8d55f - 7fd408b4-4919-4ede-8e1d-0fb0e10102e9 - id: 852f4900-d10c-4f71-a6c9-da5233e78aa4 is_deleted: false project_role_ids: - a5403a10-6cf2-4a1f-84d1-c772f63594c7 - 041391c6-cb0a-4157-bb5e-fc3469ea9c69 - 7fd408b4-4919-4ede-8e1d-0fb0e10102e9 - 941471e4-a7f2-490c-a217-c9dc8ef8d55f created_at: '2023-02-09T10:12:13.733318Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-02-14T09:40:59.0856779Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 852f4900-d10c-4f71-a6c9-da5233e78aa4 position: 2 color: '#FF8029' is_default: false names: - language: de translation: In Progress - language: it translation: In Progress - language: th translation: In Progress - language: vi translation: In Progress - language: pt translation: In Progress - language: zh translation: In Progress - language: es translation: In Progress - language: ja translation: In Progress - language: fr translation: In Progress - language: ca translation: In Progress - language: nl translation: In Progress - language: ko translation: In Progress - language: en translation: In Progress to_statuses: - id: bd4aa121-f33b-4f95-aae9-5633d5fddad7 is_deleted: false project_role_ids: - 7fd408b4-4919-4ede-8e1d-0fb0e10102e9 - 041391c6-cb0a-4157-bb5e-fc3469ea9c69 - a5403a10-6cf2-4a1f-84d1-c772f63594c7 - id: 97828643-9fd6-4fb6-a0c9-c4823914059b is_deleted: false project_role_ids: - 041391c6-cb0a-4157-bb5e-fc3469ea9c69 - a5403a10-6cf2-4a1f-84d1-c772f63594c7 - id: 29cf3a19-0f8c-430c-b2b6-8f7555ec31d5 is_deleted: false project_role_ids: - 7fd408b4-4919-4ede-8e1d-0fb0e10102e9 - 941471e4-a7f2-490c-a217-c9dc8ef8d55f - 041391c6-cb0a-4157-bb5e-fc3469ea9c69 - a5403a10-6cf2-4a1f-84d1-c772f63594c7 created_at: '2023-02-09T10:12:13.734669Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-02-14T09:40:59.0856959Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 29cf3a19-0f8c-430c-b2b6-8f7555ec31d5 position: 3 color: '#E94F3D' is_default: false names: - language: en translation: testLucPut - language: fr translation: testLucPut to_statuses: - id: 97828643-9fd6-4fb6-a0c9-c4823914059b is_deleted: false - id: bd4aa121-f33b-4f95-aae9-5633d5fddad7 is_deleted: false - id: 852f4900-d10c-4f71-a6c9-da5233e78aa4 is_deleted: false created_at: '2023-02-14T09:23:34.10768Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-02-14T09:40:59.0857043Z' 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' /organizations/{organization_id}/trades: get: operationId: librariesObservationLibraryGetOrganizationTradesAndCommonObservations summary: Get organization trades and common observations description: "Before updating your observation library, you might want to have an overview of the ones deployed in your\ \ organization. This helps you manage your organization based on the current context.\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: trades: - common_observations: - id: d9a09b42-f1bb-4f4e-a60b-be0b1dd5ad7b names: - language: en translation: Fix_222 id: 91a7637f-3e9a-49d8-8bdc-56b8e06181b7 names: - language: en translation: primary - language: fr translation: primary - id: 9adcae91-2db4-4a7f-840c-aaf00c980d7c names: - language: en translation: plumber - language: fr translation: plombier count: 2 total_count: 2 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' put: operationId: librariesObservationLibraryAddOrUpdateOrganizationTrades summary: Add or update organization trades description: "You can add categories to your library. For each, you can define translations. You can update existing\ \ categories.\n\n Compared to category creation, you need to specify the ID of the category 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 id \n id of the category \n\n names \n list of names and langages" tags: - Libraries 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: trades: - names: - language: en translation: driver id: responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: trades: - id: 6198a574-7b61-44b7-8142-903349d7c7ef names: - language: en translation: electrician - language: fr translation: electricien - id: 9adcae91-2db4-4a7f-840c-aaf00c980d7c names: - language: en translation: plumber - language: fr translation: plombier '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: librariesObservationLibraryDeleteOrganizationTrades summary: Delete organization trades description: "You can provide the list of category IDs 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 ids" tags: - Libraries 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: trade_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' /organizations/{organization_id}/workspaces: get: operationId: workspacesGetWorkspaces summary: Get workspaces description: "Before creating or updating a project, you might want to have a clear view of your organization's workspaces\ \ and have their IDs.\n\n Endpoint mandatory parameters \n Details \n\n organization_id \n id of your organization\ \ \n\n Endpoint optional query parameters \n Details \n\n parent_id \n filter the workspaces from their parent id\ \ \n\n with_children \n if false, to not return the children" tags: - Workspaces 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_Workspaces: value: workspaces: - workspace_id: 4e7716b4-6c35-413a-9472-fcbb3c70f4c0 name: My workspace client_reference: My workspace client reference media_resource: id: 2b4a90c2-4307-4e9a-ad55-c732c7272b2c file_name: 2b4a90c2-4307-4e9a-ad55-c732c7272b2c.png mime_type: image/png created_at: '2022-08-23T07:41:06.493491Z' created_at: '2023-05-03T08:53:02.1887772Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-05-03T08:53:02.1888022Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a Success_with_filter: value: workspaces: - workspace_id: c33d36b6-bed9-47b5-b735-7054b716fe5f name: My workspace 1 parent_id: 8eebf534-35d6-4b2e-be4d-06d5428d896e client_reference: d6b64763-e4ec-410b-9776-bd9ccef86478 created_at: '2022-06-16T14:15:20.207782Z' created_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a updated_at: '2024-06-25T08:52:20.094754Z' updated_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a - workspace_id: 82d745bd-de5f-41e4-8fe4-9b2ae6f954c6 name: My workspace 2 parent_id: 8eebf534-35d6-4b2e-be4d-06d5428d896e created_at: '2022-06-16T14:15:25.962777Z' created_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a updated_at: '2022-06-16T14:15:25.962778Z' updated_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a - workspace_id: 06edf5eb-1586-4a0d-855f-0cd8fa03a358 name: My sub workspace 1 parent_id: 8eebf534-35d6-4b2e-be4d-06d5428d896e client_reference: My sub workspace 1 created_at: '2023-05-02T15:18:47.381909Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-05-02T15:18:47.381934Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - workspace_id: eed7068c-7119-44a8-9e9f-8f1697b0031e name: My sub workspace 2 parent_id: c33d36b6-bed9-47b5-b735-7054b716fe5f created_at: '2022-06-16T14:15:33.32474Z' created_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a updated_at: '2022-06-16T14:15:33.324741Z' updated_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a '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: workspacesCreateWorkspace summary: Create workspace description: "You can create workspaces.\n\n Endpoint mandatory parameters \n Details \n\n organization_id \n id of\ \ your organization \n\n body mandatory parameters \n Details \n\n name \n iname of the workspace \n\n body optional\ \ parameters \n Details \n\n client_reference \n workspace reference at a client point of view \n\n parent_id \n id\ \ of the parent workpace in the hierarchy" tags: - Workspaces 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: new WS test client_reference: mon new ws client responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: workspace_id: 4e7716b4-6c35-413a-9472-fcbb3c70f4c0 name: My sub workspace 1 client_reference: My sub workspace 1 media_resource: id: 2b4a90c2-4307-4e9a-ad55-c732c7272b2c file_name: 2b4a90c2-4307-4e9a-ad55-c732c7272b2c.png mime_type: image/png created_at: '2022-08-23T07:41:06.493491Z' created_at: '2023-05-03T08:53:02.1887772Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-05-03T08:53:02.1888022Z' 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' /organizations/{organization_id}/workspaces/{workspace_id}: get: operationId: workspacesGetWorkspace summary: Get workspace description: "Before creating or updating a project, you might want to have a clear view of your organisation workspaces\ \ and have their iDs.\n\n Endpoint mandatory parameters \n Details \n\n organization_id \n id of your organization\ \ \n\n workspace_id \n id of the workspace" tags: - Workspaces parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: workspace_id in: path required: true schema: type: string description: Path variable `workspace_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: workspace_id: 4e7716b4-6c35-413a-9472-fcbb3c70f4c0 name: My workspace 1 client_reference: My workspace 1 media_resource: id: 2b4a90c2-4307-4e9a-ad55-c732c7272b2c file_name: 2b4a90c2-4307-4e9a-ad55-c732c7272b2c.png mime_type: image/png created_at: '2022-08-23T07:41:06.493491Z' created_at: '2023-05-03T08:53:02.1887772Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-05-03T08:53:02.1888022Z' 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: workspacesUpdateWorkspace summary: Update workspace description: "You can update a workspace.\n\n Endpoint mandatory parameters \n Details \n\n organization_id \n id of\ \ your organization \n\n workspace_id \n id of the workspace \n\n body mandatory parameters \n Details \n\n client_reference\ \ \n workspace refernce at a client point of view \n\n name \n name of the workspace" tags: - Workspaces parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: workspace_id in: path required: true schema: type: string description: Path variable `workspace_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: client_reference: mon new ws client ------------ responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: workspace_id: c33d36b6-bed9-47b5-b735-7054b716fe5f name: My workspace 1 parent_id: 8eebf534-35d6-4b2e-be4d-06d5428d896e client_reference: My updated client ref created_at: '2022-06-16T14:15:20.207782Z' created_by: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a updated_at: '2023-05-04T07:49:23.5012666Z' 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' /organizations/{organization_id}/workspaces/{workspace_id}/add-member: post: operationId: workspacesAddMembers summary: Add members description: "You can add a user to a workspace.\n\n The user can be a Finalcad user or not. In this case, provide only\ \ their email to create them.\n\n Endpoint mandatory parameters \n Details \n\n organization_id \n id of your organization\ \ \n\n workspace_id \n id of the workspace \n\n body mandatory parameters \n Details \n\n sould be one of \n\n user_email\ \ \n email of the user if not exsting in the Finalcad datas \n\n user_id \n user_id of a Finalcad user" tags: - Workspaces parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: workspace_id in: path required: true schema: type: string description: Path variable `workspace_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: user_email: example@finalcad.com 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' /organizations/{organization_id}/workspaces/{workspace_id}/forms: get: operationId: workspacesFormTemplatesGetWorkspaceFormTemplates summary: Get workspace form templates description: "Get the list of form templates in a workspace.\n\n Endpoint mandatory parameters \n Details \n\n organization_id\ \ \n id of your organization \n\n workspace_id \n id of the workspace \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: - Workspaces parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: workspace_id in: path required: true schema: type: string description: Path variable `workspace_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' /organizations/{organization_id}/workspaces/{workspace_id}/forms/{form_id}/custom/set: post: operationId: workspacesFormTemplatesSetWorkspaceFormTemplateCustomReportAssociation summary: Set workspace form template custom report association description: "Set the association between a form template and a custom report template previously uploaded.\n\n The\ \ form template must have been created at this level (i.e., not inherited from an upper hierarchical level).\n\n Endpoint\ \ mandatory parameters \n Details \n\n organization_id \n id of your organization \n\n workspace_id \n id of the workspace\ \ \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: - Workspaces parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: workspace_id in: path required: true schema: type: string description: Path variable `workspace_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: 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}/workspaces/{workspace_id}/members: get: operationId: workspacesGetMembers summary: Get members description: "You can get the list of all members of a workspace.\n\n Endpoint mandatory parameters \n Details \n\n\ \ organization_id \n id of your organization \n\n workspace_id \n id of the workspace \n\n Endpoint optional parameters\ \ \n Details \n\n limit \n number max of elemnts to be get \n\n offset \n index of the first elemnt to be get" tags: - Workspaces parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: workspace_id in: path required: true schema: type: string description: Path variable `workspace_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: workspace_members: - user_id: dc157afc-84607076-50ba-4e6a-8bf6-18a6676554a3 email: person.redacted+d@example.com first_name: ugazf last_name: aozifh is_admin: false is_pending: false - user_id: 3a93b7d2-6cdbc225-1324-44ca-ba13-67e865d3620a email: person.redacted+test@example.com first_name: Mathieu last_name: Bourgois is_admin: true is_pending: false media_resource: id: 46579746-ec37-4465-a0ff-5993d1e7d7ab file_name: cat.png mime_type: image/png created_at: '2022-02-28T09:28:41.196255Z' - user_id: 44b76c1c-0466376f-46cd-46bc-8685-261abb613a71 email: person.redacted+test2@example.com is_admin: false is_pending: true 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' /organizations/{organization_id}/workspaces/{workspace_id}/modules: get: operationId: workspacesModulesFormModuleTypeGetModules 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: - Workspaces parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: workspace_id in: path required: true schema: type: string description: Path variable `workspace_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: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - form_id: dd51ccda-0f53-444d-b9f5-45252c37ca37 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - form_id: 0f5d26f7-523e-4453-b61c-0fd8d59f008a container_id: 4c80463a-d4d7-4c27-8692-fa36cda65130 container_type: Workspace - form_id: 40accad9-12c5-46da-aa2c-ad6c59972d81 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - form_id: 869701f4-9ebb-4640-bffe-a676361350f7 container_id: 4c80463a-d4d7-4c27-8692-fa36cda65130 container_type: Workspace - form_id: cf9d18bd-d473-400a-909a-e48ea0eb1404 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization module_content: - id: 594f4f7c-6f7a-410b-bb5e-5aa6ef488a9c name: Categ Form 1 content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization children: - id: 1c1318ff-07c2-4489-94d5-d32b4a1b4eff name: Categ Form 1.1 parent_id: 594f4f7c-6f7a-410b-bb5e-5aa6ef488a9c content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization children: - id: 9b2de0df-6504-48db-a923-b71d6553e48b parent_id: 1c1318ff-07c2-4489-94d5-d32b4a1b4eff content_type: Form container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: 1aa8afc4-3106-446b-a471-55fc413d9867 parent_id: 594f4f7c-6f7a-410b-bb5e-5aa6ef488a9c content_type: Form container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: dd51ccda-0f53-444d-b9f5-45252c37ca37 parent_id: 594f4f7c-6f7a-410b-bb5e-5aa6ef488a9c content_type: Form container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: 0f5d26f7-523e-4453-b61c-0fd8d59f008a parent_id: 594f4f7c-6f7a-410b-bb5e-5aa6ef488a9c content_type: Form container_id: 4c80463a-d4d7-4c27-8692-fa36cda65130 container_type: Workspace - id: 593647a7-8647-49ba-9552-739125b12486 name: Categ Form 2 content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization children: - id: e7b13254-7bcf-4558-a221-3e15be270c3f name: Categ form 2.1 parent_id: 593647a7-8647-49ba-9552-739125b12486 content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: 40accad9-12c5-46da-aa2c-ad6c59972d81 parent_id: 593647a7-8647-49ba-9552-739125b12486 content_type: Form container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: 1aa8afc4-3106-446b-a471-55fc413d9867 content_type: Form container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: 40accad9-12c5-46da-aa2c-ad6c59972d81 content_type: Form container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: 869701f4-9ebb-4640-bffe-a676361350f7 content_type: Form container_id: 4c80463a-d4d7-4c27-8692-fa36cda65130 container_type: Workspace - id: cf9d18bd-d473-400a-909a-e48ea0eb1404 content_type: Form container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization created_at: '2023-06-30T15:16:42.168073Z' updated_at: '2023-07-14T11:40:48.382866Z' - id: a41a8c18-b754-4b65-be6c-22c63987c995 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: New Forms icon: typePin color: '#E94F3D' type: Forms visibility: Available module_forms: - form_id: ed7c6fd4-a3d9-4d28-b02f-9a33d8e61e5c container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - form_id: 8f256be7-99e2-43ce-a427-628bddf65d78 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization module_content: - id: 89bea999-7e06-42b0-900b-8d3a2fd0b362 name: test cad pour data content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: ed7c6fd4-a3d9-4d28-b02f-9a33d8e61e5c content_type: Form container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: 8f256be7-99e2-43ce-a427-628bddf65d78 content_type: Form container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization created_at: '2023-09-13T09:25:41.084751Z' updated_at: '2023-09-13T09:29:41.773268Z' - id: 4d9fbb6f-5060-45ae-9b27-cc806c4b1487 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: Essai new module icon: typePin color: '#E94F3D' type: Forms visibility: NotAvailable module_content: - id: 505d5a67-4acc-4a22-98ed-3f715fb0c8ef name: Categorie aaa content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: 1cbe1164-ebcd-468a-b05d-69a8f4874e4c name: Categorie bbb content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: efb034ba-24ca-42f2-a7c3-36f666612d99 name: Categorie ccc content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization created_at: '2023-09-22T06:54:55.589216Z' updated_at: '2023-09-22T06:54:55.589216Z' - id: 67a8aed1-56f8-437e-91d9-0385c24c9aea container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: api test form answers icon: alertTriangle color: '#C0DF43' type: Forms visibility: Available created_at: '2023-11-30T08:25:00.24386Z' updated_at: '2023-11-30T08:25:15.235666Z' - id: 15606d9b-c9f5-4726-bc0a-8590a3dc9dc6 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: test create new form --- icon: alert color: '#E94F3D' type: Forms visibility: Available module_forms: - form_id: dd51ccda-0f53-444d-b9f5-45252c37ca37 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization module_content: - id: 37eca3a3-aeaa-4730-9c69-afeb0e49a933 name: Aze content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization children: - id: 9c150a71-be7c-4f0b-8669-507dcfbfa674 name: Aze 2.1 parent_id: 37eca3a3-aeaa-4730-9c69-afeb0e49a933 content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: f81b8786-935c-4413-af30-faf159c13f2b name: cat 2 content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: dd51ccda-0f53-444d-b9f5-45252c37ca37 content_type: Form container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization created_at: '2024-02-15T09:50:14.619561Z' updated_at: '2024-02-16T08:48:08.782081Z' - id: 85e32ecc-955e-4f44-831e-93adca197625 container_id: 4c80463a-d4d7-4c27-8692-fa36cda65130 container_type: Workspace name: qsdfgh icon: alert color: '#E94F3D' type: Forms visibility: Available module_forms: - form_id: dd51ccda-0f53-444d-b9f5-45252c37ca37 container_id: 4c80463a-d4d7-4c27-8692-fa36cda65130 container_type: Workspace module_content: - id: a734170b-6e57-4758-a507-6961e0166b48 name: cat ws content_type: Category container_id: 4c80463a-d4d7-4c27-8692-fa36cda65130 container_type: Workspace - id: 09dc3d33-4799-418f-a3f2-766cfb55b715 name: cat ws 22 content_type: Category container_id: 4c80463a-d4d7-4c27-8692-fa36cda65130 container_type: Workspace children: - id: dd51ccda-0f53-444d-b9f5-45252c37ca37 parent_id: 09dc3d33-4799-418f-a3f2-766cfb55b715 content_type: Form container_id: 4c80463a-d4d7-4c27-8692-fa36cda65130 container_type: Workspace - id: c5c2809c-061b-4d81-93d9-392df121e315 name: ess act 2 content_type: Category container_id: 4c80463a-d4d7-4c27-8692-fa36cda65130 container_type: Workspace - id: dd51ccda-0f53-444d-b9f5-45252c37ca37 content_type: Form container_id: 4c80463a-d4d7-4c27-8692-fa36cda65130 container_type: Workspace created_at: '2024-02-15T13:29:22.180989Z' updated_at: '2024-02-16T09:23:25.638848Z' - id: f5d33e97-6f40-478f-87bf-1fa04a0843ff container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: ngu postman 20230703 1420 icon: icon color: '#FFFFFF' type: Forms visibility: Available module_content: - id: 99bb4d5a-51e3-4a65-b5c0-dec520a7a6b9 name: Aze 2.1 content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization children: - id: a8bc3515-7e92-4050-be84-64812e982f01 name: Aze 2.1 parent_id: 99bb4d5a-51e3-4a65-b5c0-dec520a7a6b9 content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization created_at: '2024-03-07T14:17:09.952617Z' updated_at: '2024-03-07T14:17:09.952617Z' - id: 8cf9151c-0a0b-4675-befe-64d868b466ec container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: test create new form Available icon: alert color: '#E94F3D' type: Forms visibility: Available module_forms: - form_id: cf9d18bd-d473-400a-909a-e48ea0eb1404 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization module_content: - id: 7d385066-8686-4357-940d-90524f03be97 name: cat 3----1 content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: 04bf1a6d-ce26-484f-93f5-d489eb71452b name: cat 3----2 content_type: Category container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization - id: cf9d18bd-d473-400a-909a-e48ea0eb1404 content_type: Form container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization created_at: '2024-04-11T14:01:12.937062Z' updated_at: '2024-04-11T14:02:20.7693Z' count: 8 total_count: 8 limit: 100 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' post: operationId: workspacesModulesFormModuleTypeCreateModule summary: Create module description: "You can create a custom form module in a specific workspace.\n\n Endpoint mandatory infos \n Details \n\ \n organization_Id \n the id of the organization to be modified \n\n workspace_id \n id of your workspace \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 visibility \n visibiity of the\ \ module in the module suggestion s list in the project creation \nDefault=>checked by default \nAvailable => unchecked\ \ by default \nNotAvailable => not in the list" tags: - Workspaces parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: workspace_id in: path required: true schema: type: string description: Path variable `workspace_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: name: azerty in ws icon: color: visibility: Default responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 34b11f09-0879-40a7-9d13-4b95dcc24d5a container_id: 8eebf534-35d6-4b2e-be4d-06d5428d896e container_type: Workspace name: azerty in ws icon: alert color: '#E94F3D' type: Forms visibility: Default created_at: '2023-09-21T08:54:17.2095497Z' updated_at: '2023-09-21T08:54:17.2095497Z' '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}/workspaces/{workspace_id}/modules/delete: post: operationId: workspacesModulesFormModuleTypeDeleteModule summary: Delete module description: "You can delete a specific module in a specific workspace.\n\n Endpoint mandatory infos \n Details \n\n\ \ organization_Id \n the id of the project to be modified \n\n workspace_id \n id of your workspace \n\n body mandatory\ \ infos \n Details \n\n module_ids \n ist of modules ids" tags: - Workspaces parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: workspace_id in: path required: true schema: type: string description: Path variable `workspace_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: module_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' /organizations/{organization_id}/workspaces/{workspace_id}/modules/suggestions: get: operationId: workspacesModulesGetModuleSuggestions summary: Get module suggestions description: "Get all the predefined module suggestions for project creation if the project should be created in 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" tags: - Workspaces parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: workspace_id in: path required: true schema: type: string description: Path variable `workspace_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: suggestions: - is_default: true 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: 表单 id: 117f1c84-e69d-4429-baf9-74e052f5e0bc container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Forms icon: clipboard color: '#F7CE46' type: Forms created_at: '2023-06-30T15:16:42.168073Z' updated_at: '2023-07-14T11:40:48.382866Z' - is_default: false names: - language: en translation: Quality - language: ar translation: جودة - language: ca translation: Qualitat - language: cs translation: Kvalitní - language: da translation: Kvalitet - language: de-DE translation: Qualität - language: el translation: Ποιότητα - language: es translation: Calidad - language: fi translation: Laatu - language: fr translation: Qualité - language: he translation: איכות - language: hu translation: Minőség - language: id translation: Kualitas - language: it translation: Qualità - language: ja translation: 品質 - language: ko-KR translation: 품질 - language: nb - language: nl-NL translation: Kwaliteit - language: pl translation: Jakość - language: pt translation: Qualidade - language: ro translation: Calitate - language: ru translation: Качество - language: sl-SI translation: Kakovost - language: sv translation: Kvalitet - language: th translation: คุณภาพ - language: tr translation: Kalite - language: vi translation: Chất lượng - language: zf - language: zh-Hans translation: 质量 id: 125ae973-3e43-4862-9af4-3cb13dcac81c container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Qualité icon: star color: '#01D194' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Environment - language: ar translation: بيئة - language: ca translation: Entorn - language: cs translation: životní prostředí - language: da translation: Miljø - language: de-DE translation: Umgebung - language: el translation: περιβάλλον - language: es translation: Medio ambiente - language: fi translation: ympäristö - language: fr translation: Environnement - language: he translation: סביבה - language: hu translation: Környezet - language: id translation: Lingkungan - language: it translation: Ambiente - language: ja translation: 環境 - language: ko-KR translation: 환경 - language: nb - language: nl-NL translation: Omgeving - language: pl translation: Środowisko - language: pt translation: Ambiente - language: ro translation: Mediu inconjurator - language: ru translation: Окружающая среда - language: sl-SI translation: Okolje - language: sv translation: Miljö - language: th translation: สิ่งแวดล้อม - language: tr translation: çevre - language: vi translation: Môi trường - language: zf - language: zh-Hans translation: 环境 id: 1d0ae170-f499-4649-b17d-d44008220600 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Environnemment icon: environment color: '#7FCE1A' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Site Diary - language: ar translation: يوميات الموقع - language: ca translation: Agenda de l'obra - language: cs translation: Deník webu - language: da translation: Site dagbog - language: de-DE translation: Standort-Tagebuch - language: el translation: Ημερολόγιο τοποθεσίας - language: es translation: Diario del sitio - language: fi translation: Sivuston päiväkirja - language: fr translation: Journal de chantier - language: he translation: יומן האתר - language: hu translation: Helyi napló - language: id translation: Buku harian situs - language: it translation: Diario del sito - language: ja translation: サイトダイアリー - language: ko-KR translation: 현장 일지 - language: nb - language: nl-NL translation: Bouwplaats logboek - language: pl translation: Dziennik witryny - language: pt translation: Livro de obra - language: ro translation: Jurnal de site - language: ru translation: Дневник сайта - language: sl-SI translation: Opažanja - language: sv translation: Webbplats dagbok - language: th translation: บันทึกประจำวันไซต์ - language: tr translation: Site günlüğü - language: vi translation: Nhật ký công trường - language: zf - language: zh-Hans translation: 工地工程日志 id: 391ede05-46a9-4676-99d7-cfe0d07f8a75 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Journal de chantier icon: bookOpen color: '#4CABF2' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Safety - language: ar translation: سلامة - language: ca translation: Seguretat - language: cs translation: Bezpečnost - language: da translation: Sikkerhed - language: de-DE translation: Sicherheit - language: el translation: Ασφάλεια - language: es translation: Seguridad - language: fi translation: Turvallisuus - language: fr translation: Sécurité - language: he translation: בטיחות - language: hu translation: Biztonság - language: id translation: Keamanan - language: it translation: Sicurezza - language: ja translation: 安全性 - language: ko-KR translation: 안전 - language: nb - language: nl-NL translation: Veiligheid - language: pl translation: Bezpieczeństwo - language: pt translation: Segurança - language: ro translation: Siguranță - language: ru translation: Безопасность - language: sl-SI translation: Varnost - language: sv translation: Säkerhet - language: th translation: ความปลอดภัย - language: tr translation: Emniyet - language: vi translation: An toàn - language: zf - language: zh-Hans translation: 安全 id: 3fd4f4af-089b-4e06-a924-32ee4f600f02 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Sécurité icon: helmet color: '#FF8029' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: true names: - language: en translation: Observations - language: ar translation: ملاحظات - language: ca translation: Observacions - language: cs translation: Pozorování - language: da translation: Bemærkninger - language: de-DE translation: Beobachtungen - language: el translation: Παρατηρήσεις - language: es translation: Observaciones - language: fi translation: Havaintoja - language: fr translation: Observations - language: he translation: תצפיות - language: hu translation: Észrevételek - language: id translation: Pengamatan - language: it translation: Osservazioni - language: ja translation: 指摘事項 - language: ko-KR translation: 관찰 사항 - language: nb - language: nl-NL translation: Opmerkingen - language: pl translation: Obserwacje - language: pt translation: Observações - language: ro translation: Observatii - language: ru translation: наблюдения - language: sl-SI translation: Opažanja - language: sv translation: observationer - language: th translation: ข้อสังเกต - language: tr translation: gözlemler - language: vi translation: Những theo dõi - language: zf - language: zh-Hans translation: 观察报告 id: 44d459d4-fa20-4484-b4bf-fd520c459566 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Observations icon: alert color: '#E94F3D' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Estimation - language: ar translation: تقدير - language: ca translation: Estimació - language: cs translation: Odhad - language: da translation: Skøn - language: de-DE translation: Einschätzung - language: el translation: Εκτίμηση - language: es translation: Estimación - language: fi translation: Arvio - language: fr translation: Estimation - language: he translation: אוּמדָן - language: hu translation: Becslés - language: id translation: Perkiraan - language: it translation: Stima - language: ja translation: 推定 - language: ko-KR translation: 견적 - language: nb - language: nl-NL translation: Schätzung - language: pl translation: Oszacowanie - language: pt translation: Estimativa - language: ro translation: Estimare - language: ru translation: Предварительный расчет - language: sl-SI translation: Ocena - language: sv translation: Uppskattning - language: th translation: การประมาณ - language: tr translation: Tahmin - language: vi translation: Dự báo - language: zf - language: zh-Hans translation: 估算 id: 478eb22c-30ee-4691-b27e-f2539f644794 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: 'Chiffrage ' icon: euro color: '#7783FF' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Materials - language: ar translation: المواد - language: ca translation: Materials - language: cs translation: Materiály - language: da translation: Materialer - language: de-DE translation: Materialien - language: el translation: Υλικά - language: es translation: Materiales - language: fi translation: tarvikkeet - language: fr translation: Matériaux - language: he translation: חומרים - language: hu translation: anyagok - language: id translation: Bahan - language: it translation: Materiali - language: ja translation: 素材 - language: ko-KR translation: 기재 - language: nb - language: nl-NL translation: Materialen - language: pl translation: Materiały - language: pt translation: Materiais - language: ro translation: Materiale - language: ru translation: материалы - language: sl-SI translation: Obrazci - language: sv translation: Material - language: th translation: วัสดุ - language: tr translation: Malzemeler - language: vi translation: Vật liệu - language: zf - language: zh-Hans translation: 材料 id: 70df7ea5-7ef6-4b71-9b52-848ec968a680 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Matériaux icon: bricks color: '#FF8029' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Tasks - language: ar translation: المهام - language: ca translation: Tasques - language: cs translation: Úkoly - language: da translation: Opgaver - language: de-DE translation: Tasks - language: el translation: Καθήκοντα - language: es translation: Tareas - language: fi translation: Tehtävät - language: fr translation: Tâches - language: he translation: משימות - language: hu translation: Feladatok - language: id translation: Rapat - language: it translation: Riunioni - language: ja translation: ミーティング - language: ko-KR translation: 회의 - language: nb - language: nl-NL translation: Vergaderingen - language: pl translation: Spotkania - language: pt translation: Encontros - language: ro translation: Întâlniri - language: ru translation: Встречи - language: sl-SI translation: Srečanja - language: sv translation: Möten - language: th translation: การประชุม - language: tr translation: Toplantılar - language: vi translation: Cuộc họp - language: zf - language: zh-Hans translation: 会议 id: 7fe77495-2ae5-4345-b647-f455be6a19d4 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Tâches icon: checkCircle color: '#3B7CDE' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Hygiene - language: ar translation: صحة - language: ca translation: Higiene - language: cs translation: Hygiena - language: da translation: Hygiejne - language: de-DE translation: Hygiene - language: el translation: Υγιεινή - language: es translation: Higiene - language: fi translation: Hygienia - language: fr translation: Hygiène - language: he translation: בריאות - language: hu translation: Higiénia - language: id translation: Kebersihan - language: it translation: Igiene - language: ja translation: 衛生 - language: ko-KR translation: 위생 - language: nb - language: nl-NL translation: Hygiëne - language: pl translation: Higiena - language: pt translation: Higiene - language: ro translation: Igienă - language: ru translation: Гигиена - language: sl-SI translation: Higiena - language: sv translation: Hygien - language: th translation: สุขอนามัย - language: tr translation: Hijyen - language: vi translation: Vệ sinh - language: zf - language: zh-Hans translation: 卫生 id: eab12a4a-7b44-46c1-abbb-9a6624369335 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Hygiène icon: clean color: '#92D8FF' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Extra Work - language: ar translation: عمل اضافي - language: ca translation: Treball extra - language: cs translation: Práce navíc - language: da translation: Ekstra arbejde - language: de-DE translation: Extra Arbeit - language: el translation: Επιπλέον δουλειά - language: es translation: Trabajo extra - language: fi translation: Lisätyö - language: fr translation: Extra Work - language: he translation: עבודה נוספת - language: hu translation: Extra munka - language: id translation: Pekerjaan Tambahan - language: it translation: Lavoro aggiuntivo - language: ja translation: エクストラ・ワーク - language: ko-KR translation: 추가 업무 - language: nb - language: nl-NL translation: Extra werk - language: pl translation: Dodatkowa praca - language: pt translation: Trabalho extra - language: ro translation: Muncă în plus - language: ru translation: Дополнительная работа - language: sl-SI translation: Dodatno delo - language: sv translation: Extraarbete - language: th translation: งานเพิ่มเติม - language: tr translation: ekstra iş - language: vi translation: Công việc thêm - language: zf - language: zh-Hans translation: 额外工作 id: be73ba88-1584-4d87-98a2-fee38da1b467 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: Travaux supplémentaires icon: brush color: '#FFC267' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: true names: - language: en translation: Meetings - language: ar translation: الاجتماعات - language: ca translation: Reunions - language: cs translation: Setkání - language: da translation: Møder - language: de-DE translation: Meetings - language: el translation: Συναντήσεις - language: es translation: Reunións - language: fi translation: Kokoukset - language: fr translation: Réunions - language: he translation: פגישות - language: hu translation: Találkozók - language: id translation: Rapat - language: it translation: Riunioni - language: ja translation: ミーティング - language: ko-KR translation: 회의 - language: nb - language: nl-NL translation: Vergaderingen - language: pl translation: Spotkania - language: pt translation: Encontros - language: ro translation: Întâlniri - language: ru translation: Встречи - language: sl-SI translation: Srečanja - language: sv translation: Möten - language: th translation: การประชุม - language: tr translation: Toplantılar - language: vi translation: Cuộc họp - language: zf - language: zh-Hans translation: 会议 id: dfb800a2-cfa7-444c-ae30-5369f8535e17 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: 'Réunions ' icon: meetings color: '#4CABF2' type: Meetings created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Equipment - language: ar translation: ادوات - language: ca translation: Equipament - language: cs translation: Zařízení - language: da translation: Udstyr - language: de-DE translation: Ausrüstung - language: el translation: Εξοπλισμός - language: es translation: Equipo - language: fi translation: Laitteet - language: fr translation: Matériel - language: he translation: צִיוּד - language: hu translation: Felszerelés - language: id translation: Kerja tambahan - language: it translation: Lavoro extra - language: ja translation: エクストラ・ワーク - language: ko-KR translation: 추가 업무 - language: nb - language: nl-NL translation: Extra werk - language: pl translation: Sprzęt - language: pt translation: Equipamento - language: ro translation: echipament - language: ru translation: Оборудование - language: sl-SI translation: Oprema - language: sv translation: Utrustning - language: th translation: อุปกรณ์ - language: tr translation: ekipman - language: vi translation: Thiết bị - language: zf - language: zh-Hans translation: 设备 id: e53cc00d-4980-409e-9a52-40706fd77b5f container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: 'Equipement ' icon: hammer color: '#01D194' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false names: - language: en translation: Personnel - language: ar translation: شؤون الموظفين - language: ca translation: Personal - language: cs translation: Personál - language: da translation: Personale - language: de-DE translation: Personal - language: el translation: Προσωπικό - language: es translation: Personal - language: fi translation: Henkilöstö - language: fr translation: Personnel - language: he translation: שפחה - language: hu translation: Személyzet - language: id translation: Personal - language: it translation: Personale - language: ja translation: 人事 - language: ko-KR translation: 인원 - language: nb - language: nl-NL translation: Personeel - language: pl translation: Personel - language: pt translation: Pessoal - language: ro translation: Personal - language: ru translation: Персонал - language: sl-SI translation: Osebje - language: sv translation: Personal - language: th translation: บุคลากร - language: tr translation: personel - language: vi translation: Nhân viên - language: zf - language: zh-Hans translation: 人员 id: bbb01e29-efb0-4a11-9ab7-63849c58fd48 container_id: e8688ddb-3aa5-4a68-90f7-a6c414b7d323 container_type: Finalcad name: 'Personnel ' icon: people color: '#ED75A0' type: Observations created_at: '2023-07-11T07:31:23.626854Z' updated_at: '2023-07-11T07:31:23.626854Z' - is_default: false id: a41a8c18-b754-4b65-be6c-22c63987c995 container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: PinForms icon: typePin color: '#E94F3D' type: Forms created_at: '2023-09-13T09:25:41.084751Z' updated_at: '2023-09-13T09:29:41.773268Z' - is_default: true id: 99e78c6b-2095-4500-9e42-ae97ea0ab63f container_id: 2421734c-f191-4237-acd8-becf216eaae4 container_type: Organization name: PinForms2 icon: typePin color: '#E94F3D' type: Forms created_at: '2023-09-20T11:32:50.554512Z' updated_at: '2023-09-20T11:32:56.254258Z' - is_default: false id: 5d4a8319-8c77-440a-94fe-afa0b09620a1 container_id: 8eebf534-35d6-4b2e-be4d-06d5428d896e container_type: Workspace name: DocumentForms icon: filesAndFolders color: '#01D194' type: Forms created_at: '2023-09-21T09:31:44.02647Z' updated_at: '2023-09-21T09:49:42.995462Z' count: 17 total_count: 17 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' /organizations/{organization_id}/workspaces/{workspace_id}/modules/{module_id}: put: operationId: workspacesModulesFormModuleTypeUpdateModule summary: Update module description: "You can modify a specific form module in a specific workspace.\n\n Endpoint mandatory infos \n Details\ \ \n\n organization_Id \n the id of the organization to be modified \n\n workspace_id \n id of your workspace \n\n\ \ module_id \n id of the module to be modified \n\n body options 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 visibility \n visibiity of the module in the module suggestion s list in project creation \nDefault=>checked\ \ by default \nAvailable => unchecked by default \nNotAvailable => not in the list" tags: - Workspaces parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: workspace_id in: path required: true schema: type: string description: Path variable `workspace_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: qsdfgh visibility: Available responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 34b11f09-0879-40a7-9d13-4b95dcc24d5a container_id: 8eebf534-35d6-4b2e-be4d-06d5428d896e container_type: Workspace name: qsdfgh icon: alert color: '#E94F3D' type: Forms visibility: Available created_at: '2023-09-21T08:54:17.209549Z' updated_at: '2023-09-21T09:09:39.2748765Z' '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}/workspaces/{workspace_id}/modules/{module_id}/categories: post: operationId: workspacesModulesFormModuleTypeCreateCategory summary: Create category description: "You can create a new category in your module in your 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 module_id \n\ \ id of your module \n\n Body params mandatory \n\n name \n name of the category \n\n Body params optionals \n\n parent_id\ \ \n parent category id if any" tags: - Workspaces parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: workspace_id in: path required: true schema: type: string description: Path variable `workspace_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: cat 3.1 parent_id: '{{category_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' /organizations/{organization_id}/workspaces/{workspace_id}/modules/{module_id}/categories/{category_id}: put: operationId: workspacesModulesFormModuleTypeUpdateCategory summary: Update category description: "You can rename a category in your module in your 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 module_id \n id of\ \ your module \n\n category_id \n id of the category \n\n Body params mandatory \n\n name \n new name of the category" tags: - Workspaces parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: workspace_id in: path required: true schema: type: string description: Path variable `workspace_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. - name: category_id in: path required: true schema: type: string description: Path variable `category_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: name: cat 3-1 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' delete: operationId: workspacesModulesFormModuleTypeDeleteCategory summary: Delete category description: "You can delete a category in your module in your 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 module_id \n id of\ \ your module \n\n category_id \n id of the category" tags: - Workspaces parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: workspace_id in: path required: true schema: type: string description: Path variable `workspace_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. - name: category_id in: path required: true schema: type: string description: Path variable `category_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}/workspaces/{workspace_id}/modules/{module_id}/link-forms: post: operationId: workspacesModulesFormModuleTypeAddFormLink summary: Add form link description: "You can link form templates to a module in a workspace.\n\n Endpoint mandatory infos \n Details \n\n organization_id\ \ \n id of your organization \n\n workspace_id \n id of your workspace \n\n module_id \n id of the module \n\n body\ \ mandatory infos \n Details \n\n form_ids \n list of ids of the forms" tags: - Workspaces parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: workspace_id in: path required: true schema: type: string description: Path variable `workspace_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: form_ids: - category_id: '{{category_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' /organizations/{organization_id}/workspaces/{workspace_id}/modules/{module_id}/unlink-forms: post: operationId: workspacesModulesFormModuleTypeRemoveFormLink summary: Remove form link description: "You can remove the link of form templates to a module in a workspace.\n\n Endpoint mandatory infos \n\ \ Details \n\n organization_id \n id of your organization \n\n workspace_id \n id of your workspace \n\n module_id\ \ \n id of the module \n\n body mandatory infos \n Details \n\n form_ids \n list of ids of the forms" tags: - Workspaces parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: workspace_id in: path required: true schema: type: string description: Path variable `workspace_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: form_ids: - category_id: '{{category_id}}' responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: id: 99e78c6b-2095-4500-9e42-ae97ea0ab63f container_id: 2421734c-f191-4237-acd8-becf216eaae4 name: ddddd icon: typePin color: '#E94F3D' type: Forms visibility: Default created_at: '2023-09-20T11:32:50.554512Z' updated_at: '2023-09-20T11:32:56.254258Z' '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}/workspaces/{workspace_id}/priorities: get: operationId: workspacesPriorityLibraryGetWorkspacePrioritiesLibrary summary: Get workspace priorities library description: "Before updating your priorities, you might want to have an overview of the ones deployed in your workspace.\ \ This helps you manage your workspace based on the current context.\n\n Endpoint mandatory parameters \n Details\ \ \n\n organization_id \n id of your organization \n\n workspace_id \n id of the workspace \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 \n\n Quary mandatory\ \ params \n Details \n\n module_type \n Observations or Forms" tags: - Workspaces parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: workspace_id in: path required: true schema: type: string description: Path variable `workspace_id` as published in the collection. responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: module_type: Forms priorities: - id: 36e4b9de-a22d-4db9-b916-3f284629edcc position: 4 color: '#E94F3D' icon: EmojiSad is_default: false names: - language: cs translation: Ultra critique - language: zh translation: Ultra critique - language: zf translation: Ultra critique - language: vi translation: Ultra critique - language: th translation: Ultra critique - language: sv translation: Ultra critique - language: sl translation: Ultra critique - language: ru translation: Ultra critique - language: pt translation: Ultra critique - language: pl translation: Ultra critique - language: 'no' translation: Ultra critique - language: nl translation: Ultra critique - language: ko translation: Ultra critique - language: ja translation: Ultra critique - language: it translation: Ultra critique - language: hu translation: Ultra critique - language: he translation: Ultra critique - language: fr translation: Ultra critique - language: fi translation: Ultra critique - language: es translation: Ultra critique - language: en translation: Ultra critique - language: de translation: Ultra critique - language: ca translation: Ultra critique - language: da translation: Ultra critique enabled: false created_at: '2023-09-21T08:24:45.825636Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-09-21T08:24:45.825636Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 37c61a0d-aa90-4aa1-aff6-9a6bd3408acb position: 0 color: '#49CB0C' icon: ChevronDown is_default: true names: - language: ca translation: Low - language: cs translation: Low - language: da translation: Low - language: de translation: Low - language: en translation: Low - language: es translation: Low - language: fi translation: Low - language: fr translation: Faible - language: he translation: Low - language: hu translation: Low - language: it translation: Low - language: ja translation: Low - language: ko translation: Low - language: nl translation: Low - language: 'no' translation: Low - language: pl translation: Low - language: pt translation: Low - language: ru translation: Low - language: sl translation: Low - language: sv translation: Low - language: th translation: Low - language: vi translation: Low - language: zf translation: Low - language: zh translation: Low enabled: false created_at: '2023-09-21T08:24:44.327245Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-09-21T08:24:44.327245Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: b8572ea8-44dc-40c7-8246-f19b8aa074bd position: 3 color: '#E94F3D' icon: AlertTriangle is_default: false names: - language: vi translation: Critical - language: ca translation: Critical - language: cs translation: Critical - language: da translation: Critical - language: de translation: Critical - language: en translation: Critical - language: es translation: Critical - language: fi translation: Critical - language: fr translation: Critique - language: he translation: Critical - language: hu translation: Critical - language: it translation: Critical - language: ja translation: Critical - language: ko translation: Critical - language: nl translation: Critical - language: 'no' translation: Critical - language: pl translation: Critical - language: pt translation: Critical - language: ru translation: Critical - language: sl translation: Critical - language: sv translation: Critical - language: th translation: Critical - language: zf translation: Critical - language: zh translation: Critical enabled: false created_at: '2023-09-21T08:24:45.816623Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-09-21T08:24:45.816623Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: d560f114-4f55-46e4-8fc7-49ba90637f82 position: 2 color: '#E94F3D' icon: ChevronsUp is_default: false names: - language: ca translation: High - language: cs translation: High - language: da translation: High - language: de translation: High - language: en translation: High - language: es translation: High - language: fi translation: High - language: fr translation: Haute - language: he translation: High - language: hu translation: High - language: it translation: High - language: ja translation: High - language: ko translation: High - language: nl translation: High - language: 'no' translation: High - language: pl translation: High - language: pt translation: High - language: ru translation: High - language: sl translation: High - language: sv translation: High - language: th translation: High - language: vi translation: High - language: zf translation: High - language: zh translation: High enabled: false created_at: '2023-09-21T08:24:45.764113Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-09-21T08:24:45.764113Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: de2dc11f-abc9-4761-bc42-5747ed6af1e7 position: 1 color: '#FF8029' icon: ChevronUp is_default: false names: - language: ca translation: Medium - language: zh translation: Medium - language: zf translation: Medium - language: vi translation: Medium - language: th translation: Medium - language: sv translation: Medium - language: sl translation: Medium - language: ru translation: Medium - language: pt translation: Medium - language: pl translation: Medium - language: 'no' translation: Medium - language: nl translation: Medium - language: ko translation: Medium - language: ja translation: Medium - language: it translation: Medium - language: hu translation: Medium - language: he translation: Medium - language: fr translation: Moyenne - language: fi translation: Medium - language: es translation: Medium - language: en translation: Medium - language: de translation: Medium - language: da translation: Medium - language: cs translation: Medium enabled: false created_at: '2023-09-21T08:24:45.742237Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-09-21T08:24:45.742237Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a count: 5 total_count: 5 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' put: operationId: workspacesPriorityLibraryUpdateWorkspacePrioritiesLibrary summary: Update workspace priorities library description: "Update your list of priorities.\n\n This cannot be done one by one. You need to manage your entire list\ \ of observation or form priorities to preserve all existing priorities. So in case you want to...\n\n add new priorities\ \ to your list, you need to get the existing list, add the new ones to this list, and then send your request.\n\n\ \ remove priorities from your list, you need to get the existing list, remove the targeted ones, and then send the\ \ request.\n\n update some priorities, you need to get the existing list, change the targeted field values, and then\ \ send the request.\n\n Endpoint mandatory parameters \n Details \n\n organization_id \n id of your organization \n\ \n workspace_id \n id of the workspace \n\n Body parameters \n Details \n\n module_type \n observation or form \n\n\ \ and a list of \n\n position \n order in the list \n\n color \n rgb code of the color \n\n icon \n icon name \n\n\ \ is_default \n true for the default one \nfalse else \n\n names \n list of names and langages" tags: - Workspaces parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: workspace_id in: path required: true schema: type: string description: Path variable `workspace_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: module_type: Forms priorities: - id: 36e4b9de-a22d-4db9-b916-3f284629edcc position: 4 color: '#E94F3D' icon: EmojiSad is_default: false names: - language: fr translation: Ultra critique - language: en translation: Ultra critique - id: 37c61a0d-aa90-4aa1-aff6-9a6bd3408acb position: 0 color: '#49CB0C' icon: ChevronDown is_default: true names: - language: en translation: Low - language: fr translation: Faible - id: b8572ea8-44dc-40c7-8246-f19b8aa074bd position: 3 color: '#E94F3D' icon: AlertTriangle is_default: false names: - language: en translation: Critical - language: fr translation: Critique - id: d560f114-4f55-46e4-8fc7-49ba90637f82 position: 2 color: '#E94F3D' icon: ChevronsUp is_default: false names: - language: en translation: High - language: fr translation: Haute - id: de2dc11f-abc9-4761-bc42-5747ed6af1e7 position: 1 color: '#FF8029' icon: ChevronUp is_default: false names: - language: fr translation: Moyenne - language: en translation: Medium responses: '200': description: OK content: application/json: schema: type: object examples: Success: value: module_type: Forms priorities: - id: 7a69ab06-41ed-4344-b071-182b136d5f10 position: 4 color: '#E94F3D' icon: EmojiSad is_default: false names: - language: fr translation: Ultra critique - language: en translation: Ultra critique enabled: false created_at: '2023-09-21T12:30:32.6975562Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-09-21T12:30:32.6975562Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 21912992-023a-40ee-981c-4780d0cd7d69 position: 0 color: '#49CB0C' icon: ChevronDown is_default: true names: - language: en translation: Low - language: fr translation: Faible enabled: false created_at: '2023-09-21T12:30:32.6982384Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-09-21T12:30:32.6982384Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: 5b75421b-e62d-47db-b6e4-b8362163be83 position: 3 color: '#E94F3D' icon: AlertTriangle is_default: false names: - language: en translation: Critical - language: fr translation: Critique enabled: false created_at: '2023-09-21T12:30:32.698653Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-09-21T12:30:32.698653Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: e117f469-6b3c-4912-b8f6-d6449d829f96 position: 2 color: '#E94F3D' icon: ChevronsUp is_default: false names: - language: en translation: High - language: fr translation: Haute enabled: false created_at: '2023-09-21T12:30:32.6990383Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-09-21T12:30:32.6990383Z' updated_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a - id: aa148793-d650-4b71-9768-899f7ad478e4 position: 1 color: '#FF8029' icon: ChevronUp is_default: false names: - language: fr translation: Moyenne - language: en translation: Medium enabled: false created_at: '2023-09-21T12:30:32.69976Z' created_by: 25ff0593-dd4c64d0-1579-4354-8a2b-260b34025b6a updated_at: '2023-09-21T12:30:32.69976Z' 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' /organizations/{organization_id}/workspaces/{workspace_id}/remove-member: delete: operationId: workspacesRemoveMembers summary: Remove members description: "You can remove a user from a workspace\n\n Endpoint mandatory parameters \n Details \n\n organization_id\ \ \n id of your organization \n\n workspace_id \n id of the workspace \n\n body mandatory parameters \n Details \n\ \n user_id \n the user_id of the user" tags: - Workspaces parameters: - name: organization_id in: path required: true schema: type: string description: Path variable `organization_id` as published in the collection. - name: workspace_id in: path required: true schema: type: string description: Path variable `workspace_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: user_id: bbe9c259-daa3af5a-746d-4120-9f25-b7bd09c0dfa7 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' /organizations/{organizationid}/forms: delete: operationId: librariesFormTemplatesDeleteOrganizationFormTemplate summary: Delete organization form template description: "You can provide the list of form template IDs you want to remove from your library. The templates will\ \ still be usable in existing projects.\n\n Deletion cannot be undone.\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 ids" 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: form_template_ids: - ed7c6fd4-a3d9-4d28-b02f-9a33d8e61e5c 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' /organizations/{organizationid}/workspaces/{workspace_id}/forms: delete: operationId: workspacesFormTemplatesDeleteWorkspaceFormTemplate summary: Delete workspace form template description: "You can provide the list of form template IDs you want to remove from your library. Templates will still\ \ be usable in existing projects.\n\n Deletion cannot be undone.\n\n Endpoint mandatory parameters \n Details \n\n\ \ organization_id \n id of your organization \n\n workspace_id \n id of your workspace \n\n Body parameters \n Details\ \ \n\n a list of ids" tags: - Workspaces parameters: - name: organizationid in: path required: true schema: type: string description: Path variable `organizationid` as published in the collection. - name: workspace_id in: path required: true schema: type: string description: Path variable `workspace_id` as published in the collection. requestBody: required: true content: application/json: schema: type: object example: form_template_ids: - 68cf2910-1044-4e6c-a11b-a4b319f8da98 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' 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).