Organization-level administration of a Finalcad One Enterprise tenant — workspaces, members and roles, the observation status, trade, common-observation, priority and form-template libraries, form and observation module types, data referentials, and daily Parquet dataset configuration for BI. 65 operations.
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: <my_user_id>
first_name: <my_first_name>
last_name: <my_name>
email: <my_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: <uuid>
id: <uuid>
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
examples:
Success:
value:
common_observations:
- trade_id: 6198a574-7b61-44b7-8142-903349d7c7ef
id: e7f3607b-be5a-4556-82e7-dc90e6f7db8a
names:
- language: fr
translation: Prises
- language: en
translation: Outlets
- trade_id: 9adcae91-2db4-4a7f-840c-aaf00c980d7c
id: c2394c8d-47c5-4c14-96e7-0b805d550bb7
names:
- language: fr
translation: Evacuations
- language: en
translation: Draining
'400':
description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized — the API key or user token is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
delete:
operationId: librariesObservationLibraryDeleteOrganizationCommonObservations
summary: Delete organization common observations
description: "You can provide the list of model IDs and their corresponding category IDs that you want to remove from\
\ your library. Those values won't be used as default project values, but they will still be usable in existing projects.\n\
\n Endpoint mandatory parameters \n Details \n\n organization_id \n id of your organization \n\n Body parameters \n\
\ Details \n\n a list of \n\n id \n id of the model \n\n trade_id \n id of the category"
tags:
- Libraries
parameters:
- name: organizationId
in: path
required: true
schema:
type: string
description: Path variable `organizationId` as published in the collection.
requestBody:
required: true
content:
application/json:
schema:
type: object
example:
common_observations:
- id: <uuid>
trade_id: <uuid>
responses:
'204':
description: No Content
'400':
description: Bad Request — an `api_code` static error code and message envelope. See errors/finalcad-problem-types.yml.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'401':
description: Unauthorized — the API key or user token is missing or invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
'500':
description: Server error — a constructed `{ProcessCode}_ERR{n}` api_code envelope.
content:
application/json:
schema:
$ref: '#/components/schemas/ApiError'
/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: <uuid>
name: <string>
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 construct
# --- truncated at 32 KB (446 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/finalcad/refs/heads/main/openapi/finalcad-organizations-openapi.yml