Finalcad One Connect 4.0 (Preview)
Finalcad One is a construction management platform designed to improve collaboration, track progress, and streamline field operations. With this connector, you can integrate Finalcad One with hundreds of other applications to simplify project tracking, automate repetitive tasks, and enhance overall efficiency.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Finalcad |
| URL | https://www.finalcad.com/contact |
| support@finalcad.com |
| Connector Metadata | |
|---|---|
| Publisher | FINALCAD |
| Website | https://developer.finalcad.com/ |
| Privacy policy | https://www.finalcad.com/apps-privacy-policy |
| Categories | Productivity |
Fc1 Connector
Prerequisites
To use this connector, you need a Finalcad API key.
Triggers
When a form is created or updated
When an observation is created or updated
When a document is created
Actions
Read form details
Read observation details
Read project information
Read current user information
Creating a connection
The connector supports the following authentication types:
| Default | Parameters for creating connection. | All regions | Not shareable |
Default
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
| Name | Type | Description | Required |
|---|---|---|---|
| API Key | securestring | The API Key for this api | True |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 100 | 60 seconds |
Actions
| Get languages |
Get all the available languages for libraries and items |
| Get time zones list |
Get the list of available time zones |
| Media - Abort chunk upload |
Cancel the current chunk upload process and discard any received parts. |
| Media - Append chunk part |
Append an individual chunk to the ongoing media upload session. |
| Media - Get media resource URL |
Retrieve the URL for accessing a media resource |
| Media - Start chunk upload |
Initiate the process for uploading a media file in chunks. |
| Media - Validate chunk upload |
Confirm and finalize the upload by verifying that all chunks have been correctly received. |
| Organization - Add members |
Add members to an organization |
| Organization - Create a project |
Create a project |
| Organization - Get connected user |
Get your user informations |
| Organization - Get forms status |
Get the forms status in a template |
| Organization - Get organizations list |
Get the list of all the organizations where you are a member |
| Organization - Get projects list |
Get the list of all your projects in a given organization |
| Organization - Get roles |
Get organization roles |
| Organization - Get suggested modules |
Get suggested modules related to your organization |
| Organization - Get workspaces |
Get workspaces related to your organization |
| Project - Add users |
Add users in your project |
| Project - Create a document |
Project - Create a document |
| Project - Create a form |
Create a form |
| Project - Create an observation |
Create an observation |
| Project - Get companies |
Get the companies in your project |
| Project - Get discussion groups |
Get the discussion groups in your project |
| Project - Get document folders |
Get document folders in your project |
| Project - Get document or folder |
Get a document or folder |
| Project - Get form categories |
Get form categories |
| Project - Get form details |
Get the details of a given form (description, template name, assignee,...) |
| Project - Get form modules |
Get the list of all existing form modules for a given project |
| Project - Get forms priorities |
Get the forms priorities in your project |
| Project - Get forms templates |
Get forms templates |
| Project - Get observation categories |
Get observation categories (formerly trades) |
| Project - Get observation details |
Get the details of a given observation (description, status, assignee,...) |
| Project - Get observation models |
Get observation models (The category was formerly called trade) |
| Project - Get observation modules |
Get the list of all existing observation modules for a given project |
| Project - Get observation statuses |
Get the observations status in your project |
| Project - Get observations priorities |
Get the observations priorities in your project |
| Project - Get phases |
Get the phases in your project |
| Project - Get plans or folders |
Get the plans or folders in your project |
| Project - Get project details |
Get the details of a given project (time zone, language, update date,...) |
| Project - Get roles |
Get project roles |
| Project - Get users |
Get the users in your project |
| Setup - Language and timezone |
Setup the language and timezone configuration |
| Setup - Project |
Setup the project configuration |
| Workspace - Add members |
Add members to a workspace |
Get languages
Get all the available languages for libraries and items
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetLanguages
Get time zones list
Get the list of available time zones
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Number max of time zones to retrieve.
|
limit | string |
Number max of time zones to retrieve. |
|
|
Nth time zone.
|
offset | string |
Nth time zone. |
|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetTimeZones
Media - Abort chunk upload
Cancel the current chunk upload process and discard any received parts.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Media ID
|
mediaId | True | string |
Media ID |
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
|
|
Chunk ID
|
chunk_id | True | string |
Chunk ID |
Returns
- Body
- Media
Media - Append chunk part
Append an individual chunk to the ongoing media upload session.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Media ID
|
mediaId | True | string |
Media ID |
|
Language
|
Accept-Language | string |
Language |
|
|
Chunk ID
|
chunk_id | True | string |
Chunk ID |
|
Segment number
|
segment_index | True | integer |
Chunk Number |
|
Last Call?
|
last_chunk | boolean |
Last call? |
|
|
filename
|
filename | True | string | |
|
contentType
|
contentType | True | string | |
|
content
|
content | True | byte |
Media - Get media resource URL
Retrieve the URL for accessing a media resource
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Media ID
|
mediaId | True | string |
Media ID |
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- MediaResourceUrl
Media - Start chunk upload
Initiate the process for uploading a media file in chunks.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
|
|
Media file name
|
file_name | True | string |
Media file name |
|
Media total size in bytes
|
total_bytes | True | integer |
Media Total size in bytes |
|
Media MD5
|
md5 | string |
Media MD5 |
Returns
- Body
- UploadChunkInit
Media - Validate chunk upload
Confirm and finalize the upload by verifying that all chunks have been correctly received.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Media ID
|
mediaId | True | string |
Media ID |
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
|
|
Chunk ID
|
chunk_id | True | string |
Chunk ID |
Returns
- Body
- Media
Organization - Add members
Add members to an organization
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Organization ID
|
organizationId | True | string |
Organization ID |
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
|
|
Role Id
|
role_id | string |
Role Id |
|
|
Users Email
|
users_info | array of string |
users email |
Organization - Create a project
Create a project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Organization ID
|
organizationId | True | string |
Organization ID |
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
|
|
Project name
|
name | True | string |
Project name |
|
Project workspace id
|
workspace_id | string |
Project workspace id |
|
|
Project modules ids
|
module_ids | array of string |
Project modules ids |
|
|
Project description
|
description | string |
Project description |
|
|
Project language
|
language | string |
Project language |
|
|
Project time zone
|
time_zone | string |
Project timezone |
|
|
Project reference
|
case_number | string |
Project reference |
|
|
Project address
|
address | string |
Project address |
|
|
Project end date
|
end_date | string |
Project End date |
Returns
- Body
- CreateProject
Organization - Get connected user
Get your user informations
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetUserInfo
Organization - Get forms status
Get the forms status in a template
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Organization ID
|
organizationId | True | string |
Organization ID |
|
Form Template ID
|
formId | True | string |
Form Template ID |
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetFormStatuses
Organization - Get organizations list
Get the list of all the organizations where you are a member
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
|
array of object | ||
|
id
|
id | string |
id |
|
name
|
name | string |
name |
Organization - Get projects list
Get the list of all your projects in a given organization
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Organization ID
|
organizationId | True | string |
Organization ID |
|
Workspace ID
|
workspace_id | string |
Workspace ID |
|
|
Include child workspaces
|
with_workspace_children | boolean |
Include child workspaces |
|
|
Search term
|
search_term | string |
Search term |
|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetProjects
Organization - Get roles
Get organization roles
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Organization ID
|
organizationId | True | string |
Organization ID |
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetRoles
Organization - Get suggested modules
Get suggested modules related to your organization
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Organization ID
|
organizationId | True | string |
Organization ID |
|
Workspace ID
|
workspace_id | string |
Workspace ID |
|
|
Maximum number of modules
|
limit | string |
Maximum number of modules |
|
|
Nth module
|
offset | string |
Nth module |
|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
Organization - Get workspaces
Get workspaces related to your organization
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Organization ID
|
organizationId | True | string |
Organization ID |
|
Parent workspace ID
|
parent_id | string |
Parent workspace ID |
|
|
Include children
|
with_children | string |
Include children |
|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetWorkspaces
Project - Add users
Add users in your project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Do not send email to users
|
doNotSendEmail | boolean |
Do not send email to users |
|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
|
|
User Email
|
True | string |
User Email |
|
|
User Role Id
|
project_role_id | True | string |
User Role Id |
Returns
- Body
- AddMembers
Project - Create a document
Project - Create a document
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
|
|
Document Name
|
name | True | string |
Document name |
|
Document Parent ID
|
parent_id | string |
ID of the parent folder |
|
|
Document Media ID
|
media_id | string |
If the field is not filled in, a folder will be created |
Returns
- Body
- CreateDocument
Project - Create a form
Create a form
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
|
|
Form Module ID
|
module_id | True | string |
Form module ID |
|
Form Template
|
form_id | True | string |
Form Template ID |
|
Form Name
|
name | True | string |
Form name |
|
Form Category ID
|
category_id | string |
Form category ID |
|
|
Form Status ID
|
status_id | string |
Form status ID |
|
|
Form Company ID
|
company_id | string |
Form assigned company ID |
|
|
Form Assignee ID
|
assignee_id | string |
Form assigned user ID |
|
|
Form plan ID
|
plan_id | string |
Form plan ID |
|
|
Form X position
|
position_x | decimal |
Form X position on plan between 0 and 1 |
|
|
Form Y position
|
position_y | decimal |
Form Y position on plan between 0 and 1 |
|
|
Form Latitude
|
latitude | decimal |
Form latitude |
|
|
Form Longitude
|
longitude | decimal |
Form longitude |
|
|
Form Priority ID
|
priority_id | string |
Form priority ID |
|
|
Form Due date
|
due_date | string |
Form due date |
|
|
Form Phase ID
|
phase_id | string |
Form phase ID |
|
|
Form ID
|
id | string |
Form ID |
Returns
- Body
- CreateFormInstance
Project - Create an observation
Create an observation
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
|
|
Observation Module ID
|
module_id | True | string |
Observation module ID |
|
Observation Category ID
|
trade_id | string |
The category was formerly called trade |
|
|
Observation Model ID
|
common_observation_id | string |
The model was formerly called common observation |
|
|
Observation Description
|
description | string |
Observation description |
|
|
Observation Status ID
|
status_id | string |
Observation status ID |
|
|
Observation Company ID
|
company_id | string |
Observation assigned company ID |
|
|
Observation Assignee ID
|
assignee_id | string |
Observation assigned user ID |
|
|
Observation Plan ID
|
plan_id | string |
Observation plan ID |
|
|
Observation X position on plan
|
position_x | decimal |
Observation X position between 0 and 1 |
|
|
Observation Y position on plan
|
position_y | decimal |
Observation Y position between 0 and 1 |
|
|
Observation Priority ID
|
priority_id | string |
Observation priority ID |
|
|
Observation Due Date
|
due_date | string |
Observation due date |
|
|
Observation Phase ID
|
phase_id | string |
Observation phase ID |
|
|
Observation Discussion Group ID
|
group_id | string |
The discussion group in which the observation should be shared upon its creation |
|
|
Observation Latitude
|
latitude | decimal |
Observation latitude |
|
|
Observation Longitude
|
longitude | decimal |
Observation longitude |
|
|
Observation ID
|
id | string |
Observation ID |
Returns
- Body
- CreateObservation
Project - Get companies
Get the companies in your project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Continuous token
|
continuous_token | string |
Continuous token |
|
|
Maximum number of companies to retrieve
|
limit | integer |
Maximum number of companies to retrieve |
|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetCompanies
Project - Get discussion groups
Get the discussion groups in your project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Maximum number of discussion groups to retrieve
|
limit | integer |
Maximum number of discussion groups to retrieve |
|
|
The nth discussion group from which I wish to retrieve the discussion groups
|
offset | integer |
The nth discussion group from which I wish to retrieve the discussion groups |
|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetGroups
Project - Get document folders
Get document folders in your project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Parent folder ID
|
parent_id | string |
Parent folder ID |
|
|
Filter Content Type ÔÇÿfolder', 'documentÔÇÖ or nothing.
|
type | string |
Filter Content Type ÔÇÿfolder', 'documentÔÇÖ or nothing. |
|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetDocumentsFiltered
Project - Get document or folder
Get a document or folder
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Document ID
|
documentId | True | string |
Document ID |
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- Document
Project - Get form categories
Get form categories
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Module ID
|
module_id | string |
Module ID |
|
|
Parent category ID
|
category_id | string |
Parent category ID |
|
|
Include disabled
|
with_disabled | string |
Include disabled |
|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetModulesCategories
Project - Get form details
Get the details of a given form (description, template name, assignee,...)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Form ID
|
formId | True | string |
Form ID |
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetFormFull
Project - Get form modules
Get the list of all existing form modules for a given project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Continous token
|
continuous_token | string |
Continous token |
|
|
Maximum number of modules to retrieve
|
limit | integer |
Maximum number of modules to retrieve |
|
|
Include deleted
|
with_deleted | boolean |
Include deleted |
|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetModulesForm
Project - Get forms priorities
Get the forms priorities in your project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Continuous token
|
continuous_token | string |
Continuous token |
|
|
Maximum number of priorities to retrieve
|
limit | integer |
Maximum number of priorities to retrieve |
|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetPriorities
Project - Get forms templates
Get forms templates
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Module ID
|
module_id | string |
Module ID |
|
|
Category ID
|
category_id | string |
Category ID |
|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetForms
Project - Get observation categories
Get observation categories (formerly trades)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Module ID
|
module_id | string |
Module ID |
|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetTradesByModule
Project - Get observation details
Get the details of a given observation (description, status, assignee,...)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Observation ID
|
observationId | True | string |
Observation ID |
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetObservationFull
Project - Get observation models
Get observation models (The category was formerly called trade)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Category ID
|
tradeId | True | string |
Category ID |
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetCommonObsByTrade
Project - Get observation modules
Get the list of all existing observation modules for a given project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Continous token
|
continuous_token | string |
Continous token |
|
|
Max number of modules to retrieve
|
limit | integer |
Max number of modules to retrieve |
|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetModules
Project - Get observation statuses
Get the observations status in your project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Continuous token
|
continuous_token | string |
Continuous token |
|
|
Maximum number of status to retrieve
|
limit | integer |
Maximum number of status to retrieve |
|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetStatuses
Project - Get observations priorities
Get the observations priorities in your project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Continuous token
|
continuous_token | string |
Continuous token |
|
|
Nth priority
|
offset | string |
Nth priority |
|
|
Number max od priorities to retrieve
|
limit | integer |
Number max od priorities to retrieve |
|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetPriorities
Project - Get phases
Get the phases in your project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Continous token
|
continuous_token | string |
Continous token |
|
|
Nth phase
|
offset | string |
Nth phase |
|
|
Maximum number of phases to retrieve
|
limit | integer |
Maximum number of phases to retrieve |
|
|
Include deleted
|
with_deleted | boolean |
Include deleted |
|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetPhases
Project - Get plans or folders
Get the plans or folders in your project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Folder ID
|
folder_id | string |
Folder ID |
|
|
Include only plans or Folders
|
type | string |
Include only plans or Folders |
|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetFolderContent
Project - Get project details
Get the details of a given project (time zone, language, update date,...)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetProject
Project - Get roles
Get project roles
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
project ID
|
projectId | True | string |
project ID |
|
Maximum number of project roles to retrieve
|
limit | string |
Maximum number of project roles to retrieve |
|
|
Nth role
|
offset | string |
Nth role |
|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetProjectRoles
Project - Get users
Get the users in your project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project ID
|
projectId | True | string |
Project ID |
|
Continuous token
|
continuous_token | string |
Continuous token |
|
|
Maximum number of members to retrieve
|
limit | integer |
Maximum number of members to retrieve |
|
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
Returns
- Body
- GetMembers
Setup - Language and timezone
Setup the language and timezone configuration
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Language
|
language | string |
Language |
|
|
Time zone
|
timezone | string |
The user's time zone (in IANA format) |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
language
|
language | string | |
|
timezone
|
timezone | string |
Setup - Project
Setup the project configuration
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Organization ID
|
business_organization_id | string |
Organization ID |
|
|
Project ID
|
project_id | string |
Project ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
business_organization_id
|
business_organization_id | string | |
|
project_id
|
project_id | string |
Workspace - Add members
Add members to a workspace
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Organization ID
|
organizationId | True | string |
Organization ID |
|
Workspace ID
|
workspaceId | True | string |
Workspace ID |
|
Language
|
Accept-Language | string |
Language |
|
|
TimeZone
|
X-TimeZone | string |
TimeZone |
|
|
User Id
|
user_id | string |
User Id |
|
|
User Email
|
user_email | string |
User Email |
Returns
- Body
- GetWorkspaceMembers
Triggers
| Trigger - Document created |
Trigger the flow when a document is created |
| Trigger - Form created |
Trigger the flow when a form is created |
| Trigger - Form updated |
Trigger the flow when a form is updated |
| Trigger - Observation created |
Trigger the flow when an observation is created |
| Trigger - Observation updated |
Trigger the flow when an observation is updated |
Trigger - Document created
Trigger the flow when a document is created
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
business_organization_id
|
business_organization_id | True | string |
Organization ID |
|
project_id
|
project_id | True | string |
Project ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
parent_id
|
parent_id | string |
parent_id |
|
event
|
event | integer |
event |
|
element_id
|
element_id | string |
element_id |
|
data1
|
data1 | string |
data1 |
|
data2
|
data2 | string |
data2 |
|
data3
|
data3 | string |
data3 |
Trigger - Form created
Trigger the flow when a form is created
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
business_organization_id
|
business_organization_id | True | string |
Organization ID |
|
project_id
|
project_id | True | string |
Project ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
parent_id
|
parent_id | string |
parent_id |
|
event
|
event | integer |
event |
|
element_id
|
element_id | string |
element_id |
|
data1
|
data1 | string |
data1 |
|
data2
|
data2 | string |
data2 |
|
data3
|
data3 | string |
data3 |
Trigger - Form updated
Trigger the flow when a form is updated
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
business_organization_id
|
business_organization_id | True | string |
Organization ID |
|
project_id
|
project_id | True | string |
Project ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
parent_id
|
parent_id | string |
parent_id |
|
event
|
event | integer |
event |
|
element_id
|
element_id | string |
element_id |
|
data1
|
data1 | string |
data1 |
|
data2
|
data2 | string |
data2 |
|
data3
|
data3 | string |
data3 |
Trigger - Observation created
Trigger the flow when an observation is created
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
business_organization_id
|
business_organization_id | True | string |
Organization ID |
|
project_id
|
project_id | True | string |
Project ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
parent_id
|
parent_id | string |
parent_id |
|
event
|
event | integer |
event |
|
element_id
|
element_id | string |
element_id |
|
data1
|
data1 | string |
data1 |
|
data2
|
data2 | string |
data2 |
|
data3
|
data3 | string |
data3 |
Trigger - Observation updated
Trigger the flow when an observation is updated
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
business_organization_id
|
business_organization_id | True | string |
Organization ID |
|
project_id
|
project_id | True | string |
Project ID |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
parent_id
|
parent_id | string |
parent_id |
|
event
|
event | integer |
event |
|
element_id
|
element_id | string |
element_id |
|
data1
|
data1 | string |
data1 |
|
data2
|
data2 | string |
data2 |
|
data3
|
data3 | string |
data3 |
Definitions
AddMembers
| Name | Path | Type | Description |
|---|---|---|---|
|
Users list
|
project_roles | array of ProjectRole |
Users list |
Company
| Name | Path | Type | Description |
|---|---|---|---|
|
Company ID
|
id | string |
Company ID |
|
Company name
|
name | string |
Company name |
|
Company is enabled
|
enabled | boolean |
Company is enabled |
|
Company members
|
user_ids | array of string |
Company members |
|
Company reference
|
reference | string |
Company reference |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
CreateDocument
| Name | Path | Type | Description |
|---|---|---|---|
|
Document ID
|
id | string |
Document ID |
|
Document type
|
type | string |
Document type |
|
Document name
|
name | string |
Document name |
|
Document parent folder ID
|
parent_id | string |
Document parent folder ID |
|
media_resource
|
media_resource | Media | |
|
Document is enabled
|
enabled | boolean |
Document is enabled |
|
Document type
|
file_type | string |
Document type |
|
Document source
|
item_source | string |
Document source |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
CreateFormInstance
| Name | Path | Type | Description |
|---|---|---|---|
|
Form ID
|
id | string |
Form ID |
|
Form name
|
name | string |
Form name |
|
Form template ID
|
form_id | string |
Form template ID |
|
Form status ID
|
status_id | string |
Form status ID |
|
Form priority ID
|
priority_id | string |
Form priority ID |
|
Form plan ID
|
plan_id | string |
Form plan ID |
|
Form X position
|
position_x | decimal |
Form X position |
|
Form Y Position
|
position_y | decimal |
Form Y position |
|
Form latitude
|
latitude | decimal |
Form latitude |
|
Form longitude
|
longitude | decimal |
Form longitude |
|
Form user ID
|
assignee_id | string |
Form assigned user ID |
|
Form company ID
|
company_id | string |
Form assigned company ID |
|
Form due date
|
due_date | string |
Form due date |
|
Form creation date
|
client_created_at | string |
Form creation ID |
|
Form update date
|
client_updated_at | string |
Form update ID |
|
Form module ID
|
module_id | string |
Form module ID |
|
Form phase ID
|
phase_id | string |
Form phase ID |
|
Form category ID
|
category_id | string |
Form category ID |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
CreateObservation
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string | |
|
project_id
|
project_id | string | |
|
description
|
description | string | |
|
status_id
|
status_id | string | |
|
priority_id
|
priority_id | string | |
|
plan_id
|
plan_id | string | |
|
position_x
|
position_x | decimal | |
|
position_y
|
position_y | decimal | |
|
latitude
|
latitude | decimal | |
|
longitude
|
longitude | decimal | |
|
assignee_id
|
assignee_id | string | |
|
company_id
|
company_id | string | |
|
trade_id
|
trade_id | string | |
|
common_observation_id
|
common_observation_id | string | |
|
due_date
|
due_date | string | |
|
client_created_at
|
client_created_at | string | |
|
client_updated_at
|
client_updated_at | string | |
|
module_id
|
module_id | string | |
|
phase_id
|
phase_id | string | |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
CreateProject
| Name | Path | Type | Description |
|---|---|---|---|
|
Project address
|
address | string |
Project address |
|
Project time zone
|
time_zone | string |
Project IANA time zone |
|
Project language
|
language | string |
Project language |
|
Project ID
|
project_id | string |
Project ID |
|
Project organization ID
|
organization_id | string |
Project organization ID |
|
Project name
|
name | string |
Project name |
|
Project case
|
case_number | string |
Project case |
|
Project workspace ID
|
workspace_id | string |
Project workspace ID |
|
Project description
|
description | string |
Project description |
|
Project end date
|
end_date | string |
Project end date |
|
Project members count
|
member_count | integer |
Project members count |
|
Project is archived
|
is_archived | boolean |
Project is archived |
|
media_resource
|
media_resource | Media | |
|
Is current user in project
|
current_user_in_project | boolean |
Is current user in project ? |
|
Project is active
|
is_active | boolean |
Project is active |
|
Project status
|
status | string |
Project status |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
Document
| Name | Path | Type | Description |
|---|---|---|---|
|
Document ID
|
id | string |
Document ID |
|
Document type
|
type | string |
Document type |
|
Document name
|
name | string |
Document name |
|
Document parent folder ID
|
parent_id | string |
Document parent folder ID |
|
media_resource
|
media_resource | Media | |
|
Document is enabled
|
enabled | boolean |
Document is enabled |
|
Document type
|
file_type | string |
Document type |
|
Document source
|
item_source | string |
Document source |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
FolderContent
| Name | Path | Type | Description |
|---|---|---|---|
|
Folder content ID
|
id | string |
Folder content ID |
|
Folder content type
|
type | string |
Folder content type |
|
Folder content name
|
name | string |
Folder content name |
|
Folder content order
|
order | double |
Folder content order |
|
Folder content creation date
|
created_at | string |
Folder content creation date |
|
Folder content update date
|
updated_at | string |
Folder content update date |
|
Folder content source
|
source | string |
Folder content Isourced |
|
Folder content foldersource
|
sources_contained | string |
Folder content foldersource |
|
Folder content is enabled
|
enabled | boolean |
Folder content is enabled |
Form
| Name | Path | Type | Description |
|---|---|---|---|
|
Template ID
|
id | string |
Template ID |
|
Template name
|
name | string |
Template name |
|
Template enabled
|
enabled | boolean |
Template enabled yes/no |
|
Template version number
|
version | integer |
Template version number |
|
Template module ID
|
module_id | string |
Template module ID |
|
Template category ID
|
category_id | string |
Template category ID |
|
Template creation date
|
created_at | string |
Template creation date |
|
Template update date
|
updated_at | string |
Template update date |
GetCommonObsByTrade
| Name | Path | Type | Description |
|---|---|---|---|
|
CommonObs
|
common_observations | array of ObservationCommonObservation |
CommonObs |
GetCompanies
| Name | Path | Type | Description |
|---|---|---|---|
|
Companies
|
companies | array of Company |
Companies |
|
List is incomplet
|
need_to_relaunch | boolean |
List is incomplet |
|
Continuous token
|
continuous_token | string |
Token to get next items |
|
Items count
|
count | integer |
Items count |
|
Items total count
|
total_count | integer |
Items total count |
GetDocumentsFiltered
| Name | Path | Type | Description |
|---|---|---|---|
|
documents
|
documents | array of Document | |
|
count
|
count | integer |
GetFolderContent
| Name | Path | Type | Description |
|---|---|---|---|
|
Folder contents
|
contents | array of FolderContent |
Folder contents |
|
count
|
count | integer |
GetFormFull
| Name | Path | Type | Description |
|---|---|---|---|
|
Form ID
|
id | string |
Form ID |
|
Form number
|
legacy_id | integer |
Form number |
|
Form enabled
|
enabled | boolean |
Form enabled |
|
Form template ID
|
form_id | string |
Form template ID |
|
Organization ID
|
organization_id | string |
Organization ID |
|
Organization name
|
organization_name | string |
Organization name |
|
Project Id
|
project_id | string |
Project ID |
|
Project name
|
project_name | string |
Project name |
|
Form description
|
description | string |
Form description |
|
Form template name
|
template_name | string |
Form template name |
|
Form status ID
|
status_id | string |
Form status ID |
|
Form status name
|
status_name | string |
Form status name |
|
Form priority ID
|
priority_id | string |
Form priority ID |
|
Form priority name
|
priority_name | string |
Form priority name |
|
Form user ID
|
assignee_id | string |
Form assigned User ID |
|
Form User name
|
assignee_name | string |
Form assigned User name |
|
Form company ID
|
company_id | string |
Form company ID |
|
Form company name
|
company_name | string |
Form Assigned Company name |
|
Form due date
|
due_date | string |
Form due date |
|
Form plan ID
|
plan_id | string |
Form plan ID |
|
Form plan name
|
plan_name | string |
Form plan name |
|
Form X Position
|
position_x | string |
Form X position |
|
Form Y position
|
position_y | string |
Form Y position |
|
Form latitude
|
latitude | string |
Form latitude |
|
Form longitude
|
longitude | string |
Form longitude |
|
Form Module Id
|
module_id | string |
Form module ID |
|
Form Module name
|
module_name | string |
Form module name |
|
Form phase Id
|
phase_id | string |
Form phase ID |
|
Form phase name
|
phase_name | string |
Form phase name |
|
Form category Id
|
category_id | string |
Form category ID |
|
Form category name
|
category_name | string |
Form category name |
|
Form delete date
|
deleted_at | string |
Form delete date |
|
Form deleted by
|
deleted_by | string |
Form deleted by user id |
|
Form creation date
|
client_created_at | string |
Form creation date |
|
Form update date
|
client_updated_at | string |
Form update date |
|
Form URL
|
web_url | string |
Form URL |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
GetFormStatuses
| Name | Path | Type | Description |
|---|---|---|---|
|
Statuses
|
statuses | array of StatusResponseWithoutLanguage |
Statuses |
|
count
|
count | integer |
GetForms
| Name | Path | Type | Description |
|---|---|---|---|
|
List of templates
|
forms | array of Form |
List of templates |
|
count
|
count | integer |
GetGroup
| Name | Path | Type | Description |
|---|---|---|---|
|
Group ID
|
id | string |
Group ID |
|
Group name
|
name | string |
Group name |
GetGroups
| Name | Path | Type | Description |
|---|---|---|---|
|
Groups
|
groups | array of GetGroup |
Groups |
|
count
|
count | integer | |
|
total_count
|
total_count | integer | |
|
limit
|
limit | integer | |
|
offset
|
offset | integer |
GetLanguage
| Name | Path | Type | Description |
|---|---|---|---|
|
Language code
|
code | string |
Language code |
|
Language description
|
name | string |
Language description |
GetLanguages
| Name | Path | Type | Description |
|---|---|---|---|
|
Languages list
|
langs | array of GetLanguage |
Languages list |
|
Languages count
|
count | integer |
Languages count |
GetMembers
| Name | Path | Type | Description |
|---|---|---|---|
|
Project members
|
project_members | array of Member |
Project members |
|
List is incomplet
|
need_to_relaunch | boolean |
List is incomplet |
|
Continuous token
|
continuous_token | string |
Token to get next items |
|
Items count
|
count | integer |
Items count |
|
Items total count
|
total_count | integer |
Items total count |
GetModules
| Name | Path | Type | Description |
|---|---|---|---|
|
Modules list
|
modules | array of Module |
list of project modules |
|
need_to_relaunch
|
need_to_relaunch | boolean | |
|
continuous_token
|
continuous_token | string | |
|
offset
|
offset | string | |
|
count
|
count | integer |
GetModulesCategories
| Name | Path | Type | Description |
|---|---|---|---|
|
Categories
|
categories | array of ModuleCategory |
Categories |
|
count
|
count | integer |
GetModulesForm
| Name | Path | Type | Description |
|---|---|---|---|
|
Module list
|
modules | array of ModuleForm |
Module list |
|
List is incomplet
|
need_to_relaunch | boolean |
List is incomplet |
|
Continuous token
|
continuous_token | string |
Token to get next items |
|
Items count
|
count | integer |
Items count |
|
Items total count
|
total_count | integer |
Items total count |
GetModulesOrgaSuggestion
| Name | Path | Type | Description |
|---|---|---|---|
|
Suggestions
|
suggestions | array of ModuleOrgaSuggestion |
Suggestions |
|
count
|
count | integer | |
|
total_count
|
total_count | integer | |
|
limit
|
limit | integer | |
|
offset
|
offset | integer |
GetObservationFull
| Name | Path | Type | Description |
|---|---|---|---|
|
Observation ID
|
id | string |
Observation ID |
|
Observation num
|
legacy_id | integer |
Observation num |
|
Observation is enabled
|
enabled | boolean |
Observation is enabled |
|
Observation project ID
|
project_id | string |
Observation project ID |
|
Observation project name
|
project_name | string |
Observation project name |
|
Observation organization ID
|
organization_id | string |
Observation organization ID |
|
Observation organization name
|
organization_name | string |
Observation organization name |
|
Observation description
|
description | string |
Observation description |
|
Observation status ID
|
status_id | string |
Observation status ID |
|
Observation status name
|
status_name | string |
Observation status name |
|
Observation priority ID
|
priority_id | string |
Observation priority ID |
|
Observation priority name
|
priority_name | string |
Observation priority name |
|
Observation plan ID
|
plan_id | string |
Observation plan ID |
|
Observation plan name
|
plan_name | string |
Observation plan name |
|
Observation X position
|
position_x | decimal |
Observation X position |
|
Observation Y position
|
position_y | decimal |
Observation Y position |
|
Observation latitude
|
latitude | decimal |
Observation latitude |
|
Observation longitude
|
longitude | decimal |
Observation longitude |
|
Observation user ID
|
assignee_id | string |
Observation assigned user ID |
|
Observation user name
|
assignee_name | string |
Observation assigned user name |
|
Observation company ID
|
company_id | string |
Observation assigned company ID |
|
Observation company name
|
company_name | string |
Observation assigned company name |
|
Observation trade ID
|
trade_id | string |
Observation trade ID |
|
Observation trade name
|
trade_name | string |
Observation trade name |
|
Observation commonobs id
|
common_observation_id | string |
Observation common observation ID |
|
Observation commonobs name
|
common_observation_name | string |
Observation common observation name |
|
Observation due date
|
due_date | string |
Observation due date |
|
Observation module ID
|
module_id | string |
Observation module ID |
|
Observation module name
|
module_name | string |
Observation module name |
|
deleted_at
|
deleted_at | string | |
|
deleted_by
|
deleted_by | string | |
|
Observation phase ID
|
phase_id | string |
Observation phase ID |
|
Observation phase name
|
phase_name | string |
Observation phase name |
|
Observation images
|
photos | array of ObservationMediaResource |
Observation images |
|
Observation creation date
|
client_created_at | string |
Observation creation date |
|
Observation update date
|
client_updated_at | string |
Observation update date |
|
Observation URL
|
web_url | string |
Observation URL |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
GetPhases
| Name | Path | Type | Description |
|---|---|---|---|
|
Phases
|
phases | array of Phase |
Phases |
|
List is incomplet
|
need_to_relaunch | boolean |
List is incomplet |
|
Continuous token
|
continuous_token | string |
Token to get next items |
|
Items count
|
count | integer |
Items count |
|
Items total count
|
total_count | integer |
Items total count |
GetPriorities
| Name | Path | Type | Description |
|---|---|---|---|
|
Priorities
|
priorities | array of Priority |
Priorities |
|
List is incomplet
|
need_to_relaunch | boolean |
List is incomplet |
|
Continuous token
|
continuous_token | string |
Token to get next items |
|
Items count
|
count | integer |
Items count |
|
Items total count
|
total_count | integer |
Items total count |
GetProject
| Name | Path | Type | Description |
|---|---|---|---|
|
Project address
|
address | string |
Project address |
|
Project time zone
|
time_zone | string |
Project IANA time zone |
|
Project language
|
language | string |
Project language |
|
Project ID
|
project_id | string |
Project ID |
|
Project organization ID
|
organization_id | string |
Project organization ID |
|
Project name
|
name | string |
Project name |
|
Project case
|
case_number | string |
Project case |
|
Project workspace ID
|
workspace_id | string |
Project workspace ID |
|
Project description
|
description | string |
Project description |
|
Project end date
|
end_date | string |
Project end date |
|
Project members count
|
member_count | integer |
Project members count |
|
Project is archived
|
is_archived | boolean |
Project is archived |
|
media_resource
|
media_resource | Media | |
|
Is current user in project
|
current_user_in_project | boolean |
Is current user in project ? |
|
Project is active
|
is_active | boolean |
Project is active |
|
Project status
|
status | string |
Project status |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
GetProjectRoles
| Name | Path | Type | Description |
|---|---|---|---|
|
project_roles
|
project_roles | array of ProjectRole | |
|
count
|
count | integer | |
|
total_count
|
total_count | integer | |
|
limit
|
limit | integer | |
|
offset
|
offset | integer |
GetProjects
| Name | Path | Type | Description |
|---|---|---|---|
|
Projects list
|
projects | array of Project |
List of projects |
|
count
|
count | integer | |
|
total_count
|
total_count | integer | |
|
limit
|
limit | integer | |
|
offset
|
offset | integer |
GetRole
| Name | Path | Type | Description |
|---|---|---|---|
|
Role ID
|
id | string |
Role ID |
|
Role name
|
name | string |
Role name |
|
Role description
|
description | string |
Role description |
|
names
|
names | LocalizedLabelFallback | |
|
descriptions
|
descriptions | LocalizedLabelFallback | |
|
Role is default
|
is_default | boolean |
Role is default |
|
is_default_invitation_role
|
is_default_invitation_role | boolean | |
|
user_count
|
user_count | integer | |
|
position
|
position | integer | |
|
authorization_role_id
|
authorization_role_id | string | |
|
higher_role_id
|
higher_role_id | string | |
|
is_lower_role
|
is_lower_role | boolean |
GetRoles
| Name | Path | Type | Description |
|---|---|---|---|
|
organization_roles
|
organization_roles | array of GetRole |
GetStatuses
| Name | Path | Type | Description |
|---|---|---|---|
|
Statuses
|
statuses | array of StatusResponseWithoutFlow |
Statuses |
|
List is incomplet
|
need_to_relaunch | boolean |
List is incomplet |
|
Continuous token
|
continuous_token | string |
Token to get next items |
|
Items count
|
count | integer |
Items count |
|
Items total count
|
total_count | integer |
Items total count |
GetTimeZones
| Name | Path | Type | Description |
|---|---|---|---|
|
Timezones list
|
time_zones | array of TimeZones |
Timezones list |
|
count
|
count | integer | |
|
total_count
|
total_count | integer | |
|
limit
|
limit | integer | |
|
offset
|
offset | integer |
GetTradesByModule
| Name | Path | Type | Description |
|---|---|---|---|
|
Trades
|
trades | array of ProjectTrade |
Trades |
GetUserInfo
| Name | Path | Type | Description |
|---|---|---|---|
|
User ID
|
id | string |
User ID |
|
User first name
|
first_name | string |
User first name |
|
User last name
|
last_name | string |
User last name |
|
User email
|
string |
User email |
|
|
User company name
|
company | string |
User company name |
|
is active
|
is_active | string |
is active |
|
email_validated
|
email_validated | string | |
|
User creation date
|
created_at | string |
User creation date |
|
updated_at
|
updated_at | string | |
|
deleted_at
|
deleted_at | string | |
|
media_resource
|
media_resource | Media | |
|
User locale
|
locale | string |
User locale |
GetWorkspaceMembers
| Name | Path | Type | Description |
|---|---|---|---|
|
workspace_members
|
workspace_members | array of OrgaMemberResponses | |
|
count
|
count | integer | |
|
total_count
|
total_count | integer | |
|
limit
|
limit | integer | |
|
offset
|
offset | integer |
GetWorkspaces
| Name | Path | Type | Description |
|---|---|---|---|
|
Workspaces
|
workspaces | array of Workspace |
Workspaces |
IconTypeParameters
LocalizedLabel
| Name | Path | Type | Description |
|---|---|---|---|
|
language
|
language | string | |
|
translation
|
translation | string |
LocalizedLabelFallback
| Name | Path | Type | Description |
|---|---|---|---|
|
translation_fallback
|
translation_fallback | string | |
|
translations
|
translations | array of LocalizedLabel |
Media
| Name | Path | Type | Description |
|---|---|---|---|
|
Media ID
|
id | string |
Media ID |
|
Media file name
|
file_name | string |
Media file name |
|
Media MIME Type
|
mime_type | string |
Media MIME Type |
|
Media creation date
|
created_at | string |
Media creation date |
MediaResourceUrl
| Name | Path | Type | Description |
|---|---|---|---|
|
Media URL
|
url | string |
Media URL |
Member
| Name | Path | Type | Description |
|---|---|---|---|
|
Member ID
|
user_id | string |
Member ID |
|
Member first name
|
first_name | string |
Member first name |
|
Member last name
|
last_name | string |
Member last name |
|
Member email
|
string |
Member email |
|
|
Member role ID
|
project_role_id | string |
Member role ID |
|
picture
|
picture | Media | |
|
Member is enabled
|
enabled | boolean |
Member is enabled |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
Module
| Name | Path | Type | Description |
|---|---|---|---|
|
Module ID
|
id | string |
Module ID |
|
project_id
|
project_id | string | |
|
Module name
|
name | string |
Module name |
|
Module display order
|
order | double |
Module display order |
|
Module icon
|
icon | string |
Module icon |
|
Module color
|
color | string |
Module color |
|
Module type
|
type | string |
Module type |
|
names
|
names | array of LocalizedLabel | |
|
Module creation date
|
created_at | string |
Module creation date |
|
Module update date
|
updated_at | string |
Module update date |
|
Module is enabled
|
enabled | boolean |
Module is enabled |
|
settings
|
settings | ModuleSettings |
ModuleCategory
| Name | Path | Type | Description |
|---|---|---|---|
|
Category ID
|
id | string |
Category ID |
|
Category module ID
|
module_id | string |
Category module ID |
|
Category container ID
|
container_id | string |
Category container ID |
|
Category name
|
name | string |
Category name |
|
Parent category ID
|
parent_id | string |
Parent category ID |
|
Category creation date
|
created_at | string |
Category creation date |
|
Category update date
|
updated_at | string |
Category update date |
|
Category deletion date
|
deleted_at | string |
Category deletion date |
|
Category is enabled
|
enabled | boolean |
Category is enabled |
ModuleForm
| Name | Path | Type | Description |
|---|---|---|---|
|
Module ID
|
id | string |
Module ID |
|
Project ID
|
project_id | string |
Project ID |
|
Module name
|
name | string |
Module name |
|
Module order
|
order | double |
Module display order |
|
Module icon
|
icon | string |
Module icon |
|
Module color
|
color | string |
Module color |
|
Module type
|
type | string |
Module type |
|
names
|
names | array of LocalizedLabel | |
|
Module creation date
|
created_at | string |
Module settings |
|
Module update date
|
updated_at | string |
Module settings |
|
Module is enabled
|
enabled | boolean |
Module settings |
ModuleOrgaSuggestion
| Name | Path | Type | Description |
|---|---|---|---|
|
Suggestion default
|
is_default | boolean |
Suggestion default |
|
Suggestion names
|
names | array of LocalizedLabel |
Suggestion names |
|
id
|
id | string | |
|
container_id
|
container_id | string | |
|
container_type
|
container_type | string | |
|
Suggestion name
|
name | string |
Suggestion name |
|
icon
|
icon | string | |
|
color
|
color | string | |
|
Suggestion type
|
type | string |
Suggestion type |
|
Suggestion visibility
|
visibility | string |
Suggestion visibility |
|
created_at
|
created_at | string | |
|
updated_at
|
updated_at | string |
ModuleSettings
| Name | Path | Type | Description |
|---|---|---|---|
|
is_observation_library_mandatory
|
is_observation_library_mandatory | boolean | |
|
is_description_mandatory
|
is_description_mandatory | boolean | |
|
is_photo_mandatory
|
is_photo_mandatory | boolean | |
|
is_company_mandatory
|
is_company_mandatory | boolean | |
|
is_group_mandatory
|
is_group_mandatory | boolean | |
|
due_date_days_offset
|
due_date_days_offset | string |
ObservationCommonObservation
| Name | Path | Type | Description |
|---|---|---|---|
|
CommonObs Id
|
id | string |
CommonObs Id |
|
CommonObs Trade Id
|
trade_id | string |
CommonObs Trade Id |
|
CommonObs Name
|
name | string |
CommonObs Name |
|
CommonObs Names
|
names | array of LocalizedLabel |
CommonObs Names |
|
CommonObs Is Enabled
|
enabled | boolean |
CommonObs Is Enabled |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
ObservationMediaResource
| Name | Path | Type | Description |
|---|---|---|---|
|
Media ID
|
id | string |
Media ID |
|
Media order
|
position | string |
Media order |
|
Media MIME type
|
mime_type | string |
Media MIME type |
|
Media file name
|
file_name | string |
Media file name |
OrgaMemberResponses
| Name | Path | Type | Description |
|---|---|---|---|
|
user_id
|
user_id | string | |
|
email
|
string | ||
|
first_name
|
first_name | string | |
|
last_name
|
last_name | string | |
|
is_admin
|
is_admin | boolean | |
|
is_pending
|
is_pending | boolean | |
|
media_resource
|
media_resource | Media |
Phase
| Name | Path | Type | Description |
|---|---|---|---|
|
Phase ID
|
id | string |
Phase ID |
|
Phase order
|
order | double |
Phase order |
|
Phase name
|
name | string |
Phase name |
|
Phase names
|
names | array of LocalizedLabel |
Phase names |
|
Phase is enabled
|
enabled | boolean |
Phase is enabled |
|
Phase creation date
|
created_at | string |
Phase creation date |
|
Phase update date
|
updated_at | string |
Phase update date |
|
Phase deletion date
|
deleted_at | string |
Phase deletion date |
Priority
| Name | Path | Type | Description |
|---|---|---|---|
|
Priority ID
|
id | string |
Priority ID |
|
Priority name
|
name | string |
Priority name |
|
Priority order
|
position | integer |
Priority order |
|
Priority color
|
color | string |
Priority color |
|
icon
|
icon | IconTypeParameters | |
|
Priority ID
|
is_default | boolean |
Priority ID |
|
Priority is default
|
names | array of LocalizedLabel |
Priority is default |
|
Priority is enabled
|
enabled | boolean |
Priority is enabled |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
Project
| Name | Path | Type | Description |
|---|---|---|---|
|
Project ID
|
project_id | string |
Project ID |
|
Project organization ID
|
organization_id | string |
Project organization ID |
|
Project name
|
name | string |
Project name |
|
Project case
|
case_number | string |
Project case |
|
Project workspace ID
|
workspace_id | string |
Project workspace ID |
|
Project description
|
description | string |
Project description |
|
Project end date
|
end_date | string |
Project end date |
|
Project members count
|
member_count | integer |
Project members count |
|
Project is archived
|
is_archived | boolean |
Project is archived |
|
media_resource
|
media_resource | Media | |
|
Is current user in project
|
current_user_in_project | boolean |
Is current user in project ? |
|
Project is active
|
is_active | boolean |
Project is active |
|
Project status
|
status | string |
Project status |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
ProjectRole
| Name | Path | Type | Description |
|---|---|---|---|
|
Users list
|
user_ids | array of string |
Users list |
|
Role id
|
id | string |
Role id |
|
Role Name
|
name | string |
Role Name |
|
Role Names
|
names | array of LocalizedLabel |
Role Names |
|
Role Descriptions
|
descriptions | array of LocalizedLabel |
Role Descriptions |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
ProjectTrade
| Name | Path | Type | Description |
|---|---|---|---|
|
Trade ID
|
id | string |
Trades ID |
|
Is enabled
|
enabled | boolean |
Is enabled |
|
Trade name
|
name | string |
Trade name |
|
Trade names
|
names | array of LocalizedLabel |
Trade names |
|
Module ID
|
module_id | string |
Module ID |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
StatusResponseWithoutFlow
| Name | Path | Type | Description |
|---|---|---|---|
|
Status id
|
id | string |
Status id |
|
Status name
|
name | string |
Status name |
|
Status order
|
position | integer |
Status order |
|
Status color
|
color | string |
Status color |
|
Status is default
|
is_default | boolean |
Status is default |
|
Status is enabled
|
enabled | boolean |
Status is enabled |
|
Status names
|
names | array of LocalizedLabel |
Status names |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
StatusResponseWithoutLanguage
| Name | Path | Type | Description |
|---|---|---|---|
|
Status id
|
id | string |
Status id |
|
Status name
|
name | string |
Status name |
|
Status order
|
position | integer |
Status order |
|
Status color
|
color | string |
Status color |
|
Status is enabled
|
enabled | boolean |
Status is enabled |
TimeZones
| Name | Path | Type | Description |
|---|---|---|---|
|
Timezone ID
|
id | string |
Timezone ID |
|
Timezone name
|
display_name | string |
Timezone name |
|
Timezone standard name
|
standard_name | string |
Timezone standard name |
|
Timezone UTC offset
|
utc_offset | string |
Timezone UTC offset |
UploadChunkInit
| Name | Path | Type | Description |
|---|---|---|---|
|
Upload expiration delay
|
expires_after_secs | double |
Upload expiration delay |
|
Chunk ID
|
chunk_id | string |
Chunk ID |
|
Media ID
|
media_id | string |
Media ID |
|
Minimum chunk size
|
min_chunk_size | integer |
Minimum chunk size |
Workspace
| Name | Path | Type | Description |
|---|---|---|---|
|
Workspace ID
|
workspace_id | string |
Workspace ID |
|
Workspace name
|
name | string |
Workspace name |
|
Workspace parent ID
|
parent_id | string |
Workspace parent ID |
|
Workspace reference
|
client_reference | string |
Workspace reference |
|
media_resource
|
media_resource | Media | |
|
Workspace deletion date
|
deleted_by | string |
Workspace deletion date |
|
Workspace deleted by
|
deleted_at | string |
Workspace deleted by |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |