Finalcad One Connect V3 (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 (formerly common observations) |
| 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 usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
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 get.
|
limit | string |
Number max of time zones to get. |
|
|
Offset index from where to begin getting time zones.
|
offset | string |
Offset index from where to begin getting time zones. |
|
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
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 usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
|
|
Chunk ID
|
chunk_id | 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 |
|---|---|---|---|---|
|
the media ID
|
mediaId | True | string |
the media ID |
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
chunk_id
|
chunk_id | string |
chunk id |
|
|
segment_index
|
segment_index | integer |
chunk index |
|
|
last_chunk
|
last_chunk | boolean |
is it the last chunk |
|
|
filename
|
filename | string | ||
|
contentType
|
contentType | string | ||
|
content
|
content | string |
Media - Get media resource URL
Retrieve the URL for accessing a media resource
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
id of the media
|
mediaId | True | string |
id of the media |
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
Returns
- Body
- MediaResourceUrl
Media - Start chunk upload
Initiate the process for uploading a media file in chunks.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
|
|
Media file name
|
file_name | string |
Media file name |
|
|
Media MD5
|
md5 | string |
Media MD5 |
|
|
Media total size
|
total_bytes | integer |
Media Total size in bytes |
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 |
|---|---|---|---|---|
|
Id of the media
|
mediaId | True | string |
Id of the media |
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
|
|
Chunk ID
|
chunk_id | 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 usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
|
|
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 usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
|
|
Project address
|
address | string |
Project address |
|
|
Project reference
|
case_number | string |
Project reference |
|
|
Project description
|
description | string |
Project description |
|
|
Project end date
|
end_date | string |
Project End date |
|
|
Project language
|
language | string |
Project language |
|
|
Project modules ids
|
module_ids | array of string |
Project modules ids |
|
|
Project name
|
name | True | string |
Project name |
|
Project time zone
|
time_zone | string |
Project timezone |
|
|
Project workspace id
|
workspace_id | string |
Project workspace id |
Returns
- Body
- CreateProject
Organization - Get connected user
Get your user informations
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
Returns
- Body
- GetUserInfo
Organization - Get forms status
Get the forms status in a template
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
organizationId
|
organizationId | True | string |
organizationId |
|
Id of form template
|
formId | True | string |
Id of form template |
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
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 usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
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 |
|---|---|---|---|---|
|
The organization id
|
organizationId | True | string |
The organization id |
|
The workspace id (optional)
|
workspace_id | string |
The workspace id (optional) |
|
|
Search in child workspaces (optional)
|
with_workspace_children | boolean |
Search in child workspaces (optional) |
|
|
Search term (optional)
|
search_term | string |
Search term (optional) |
|
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
Returns
- Body
- GetProjects
Organization - Get roles
Get organization roles
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
organizationId
|
organizationId | True | string |
organizationId |
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
Returns
- Body
- GetRoles
Organization - Get suggested modules
Get suggested modules related to your organization
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
organizationId
|
organizationId | True | string |
organizationId |
|
limit
|
limit | string |
limit |
|
|
offset
|
offset | string |
offset |
|
|
workspace_id
|
workspace_id | string |
workspace_id |
|
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
Returns
Organization - Get workspaces
Get workspaces related to your organization
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
organizationId
|
organizationId | True | string |
organizationId |
|
parent_id
|
parent_id | string |
parent_id |
|
|
with_children
|
with_children | string |
with_children |
|
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
Returns
- Body
- GetWorkspaces
Project - Add users
Add users in your project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The id of the project.
|
projectId | True | string |
The id of the project. |
|
Do not send email to user
|
doNotSendEmail | boolean |
Do not send email to user |
|
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
|
|
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 |
|---|---|---|---|---|
|
The Project Id
|
projectId | True | string |
The Project Id |
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
|
|
Document media ID
|
media_id | string |
Document media ID |
|
|
Document name
|
name | True | string |
Document name |
|
Document parent ID
|
parent_id | string |
ID of the parent folder |
Returns
- Body
- CreateDocument
Project - Create a form
Create a form
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
the project id
|
projectId | True | string |
the project id |
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
|
|
Form user ID
|
assignee_id | string |
Form assigned user ID |
|
|
Form category ID
|
category_id | string |
Form category ID |
|
|
Form company ID
|
company_id | string |
Form assigned company ID |
|
|
Form due date
|
due_date | string |
Form due date |
|
|
Form Template
|
form_id | string |
Form Template ID |
|
|
Form ID
|
id | string |
Form ID |
|
|
Form latitude
|
latitude | number |
Form latitude |
|
|
Form longitude
|
longitude | number |
Form longitude |
|
|
Form module ID
|
module_id | string |
Form module ID |
|
|
Form name
|
name | string |
Form name |
|
|
Form phase ID
|
phase_id | string |
Form phase ID |
|
|
Form plan ID
|
plan_id | string |
Form plan ID |
|
|
Form X position
|
position_x | number |
Form X position |
|
|
Form Y position
|
position_y | number |
Form Y position |
|
|
Form priority ID
|
priority_id | string |
Form priority ID |
|
|
Form status ID
|
status_id | string |
Form status ID |
Returns
- Body
- CreateFormInstance
Project - Create an observation
Create an observation
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The project id
|
projectId | True | string |
The project id |
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
|
|
Observation user ID
|
assignee_id | string |
Observation assigned user ID |
|
|
Observation commonobs ID
|
common_observation_id | string |
Observation common observation ID |
|
|
Observation company ID
|
company_id | string |
Observation assigned company ID |
|
|
Observation description
|
description | string |
Observation description |
|
|
Observation due date
|
due_date | string |
Observation due date |
|
|
Observation group ID
|
group_id | string |
Observation group ID |
|
|
Observation ID
|
id | string |
Observation ID |
|
|
Observation latitude
|
latitude | number |
Observation latitude |
|
|
Observation longitude
|
longitude | number |
Observation longitude |
|
|
Observation module ID
|
module_id | string |
Observation module ID |
|
|
Observation phase ID
|
phase_id | string |
Observation phase ID |
|
|
Observation plan ID
|
plan_id | string |
Observation plan ID |
|
|
Observation X position
|
position_x | number |
Observation X position |
|
|
Observation Y position
|
position_y | number |
Observation Y position |
|
|
Observation priority ID
|
priority_id | string |
Observation priority ID |
|
|
Observation status ID
|
status_id | string |
Observation status ID |
|
|
Observation trade ID
|
trade_id | string |
Observation trade ID |
Returns
- Body
- CreateObservation
Project - Get companies
Get the companies in your project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The id of the project.
|
projectId | True | string |
The id of the project. |
|
continuous token
|
continuous_token | string |
continuous token |
|
|
Number max of companies to get.
|
limit | integer |
Number max of companies to get. |
|
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
Returns
- Body
- GetCompanies
Project - Get discussion groups
Get the discussion groups in your project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The parent project id.
|
projectId | True | string |
The parent project id. |
|
limit
|
limit | integer |
limit |
|
|
offset
|
offset | integer |
offset |
|
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
Returns
- Body
- GetGroups
Project - Get document folders
Get document folders in your project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
projectId
|
projectId | True | string |
projectId |
|
parent_id
|
parent_id | string |
parent_id |
|
|
type
|
type | string |
type |
|
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
Returns
- Body
- GetDocumentsFiltered
Project - Get document or folder
Get a document or folder
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The parent project id.
|
projectId | True | string |
The parent project id. |
|
The document Id to get.
|
documentId | True | string |
The document Id to get. |
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
Returns
- Body
- Document
Project - Get form categories
Get form categories
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
projectId
|
projectId | True | string |
projectId |
|
module_id
|
module_id | string |
module_id |
|
|
category_id
|
category_id | string |
category_id |
|
|
with_disabled
|
with_disabled | string |
with_disabled |
|
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
Returns
- Body
- GetModulesCategories
Project - Get form details
Get the details of a given form (description, template name, assignee,...)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The project id
|
projectId | True | string |
The project id |
|
The Form id
|
formId | True | string |
The Form id |
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
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 |
|---|---|---|---|---|
|
The project Id
|
projectId | True | string |
The project Id |
|
continuous_token
|
continuous_token | string |
continuous_token |
|
|
limit
|
limit | integer |
limit |
|
|
With deleted
|
with_deleted | boolean |
With deleted |
|
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
Returns
- Body
- GetModulesForm
Project - Get forms priorities
Get the forms priorities in your project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
projectId
|
projectId | True | string |
projectId |
|
continuous token
|
continuous_token | string |
continuous token |
|
|
Number max to get.
|
limit | integer |
Number max to get. |
|
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
Returns
- Body
- GetPriorities
Project - Get forms templates
Get forms templates
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the project
|
projectId | True | string |
Id of the project |
|
Id of the module
|
module_id | string |
Id of the module |
|
|
category_id
|
category_id | string |
category_id |
|
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
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 usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
Returns
- Body
- GetTradesByModule
Project - Get observation details
Get the details of a given observation (description, status, assignee,...)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Id of the project
|
projectId | True | string |
Id of the project |
|
Id of the observation
|
observationId | True | string |
Id of the observation |
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
Returns
- Body
- GetObservationFull
Project - Get observation models
Get observation models (formerly common observations)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Project Id
|
projectId | True | string |
Project Id |
|
Trade Id
|
tradeId | True | string |
Trade Id |
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
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 |
|---|---|---|---|---|
|
The project id
|
projectId | True | string |
The project id |
|
continuous_token
|
continuous_token | string |
continuous_token |
|
|
limit
|
limit | integer |
limit |
|
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
Returns
- Body
- GetModules
Project - Get observation statuses
Get the observations status in your project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
projectId
|
projectId | True | string |
projectId |
|
Continuous token
|
continuous_token | string |
Continuous token |
|
|
Number max to get
|
limit | integer |
Number max to get |
|
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
Returns
- Body
- GetStatuses
Project - Get observations priorities
Get the observations priorities in your project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
projectId
|
projectId | True | string |
projectId |
|
continuous token
|
continuous_token | string |
continuous token |
|
|
offset
|
offset | string |
offset |
|
|
Number max to get.
|
limit | integer |
Number max to get. |
|
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
Returns
- Body
- GetPriorities
Project - Get phases
Get the phases in your project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
projectId
|
projectId | True | string |
projectId |
|
continuous_token
|
continuous_token | string |
continuous_token |
|
|
offset
|
offset | string |
offset |
|
|
limit
|
limit | integer |
limit |
|
|
with_deleted
|
with_deleted | boolean |
with_deleted |
|
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
Returns
- Body
- GetPhases
Project - Get plans or folders
Get the plans or folders in your project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
projectId
|
projectId | True | string |
projectId |
|
folder_id
|
folder_id | string |
folder_id |
|
|
type
|
type | string |
type |
|
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
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 |
|---|---|---|---|---|
|
The id of the project.
|
projectId | True | string |
The id of the project. |
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
Returns
- Body
- GetProject
Project - Get roles
Get project roles
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The id of the project.
|
projectId | True | string |
The id of the project. |
|
Number max of project roles to get.
|
limit | string |
Number max of project roles to get. |
|
|
Offset index from where to begin getting project roles.
|
offset | string |
Offset index from where to begin getting project roles. |
|
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
Returns
- Body
- GetProjectRoles
Project - Get users
Get the users in your project
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
The id of the project.
|
projectId | True | string |
The id of the project. |
|
continuous token
|
continuous_token | string |
continuous token |
|
|
Number max of members to get.
|
limit | integer |
Number max of members to get. |
|
|
Language usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
Returns
- Body
- GetMembers
Setup - Language and timezone
Setup the language and timezone configuration
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Your language (should appair in the project)
|
language | string |
Your language (should appair in the project) |
|
|
Your time-zone
|
timezone | string |
time-zone |
Returns
| Name | Path | Type | Description |
|---|---|---|---|
|
language
|
language | string | |
|
timezone
|
timezone | string |
Setup - Project
Setup the project configuration
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
business organization id
|
business_organization_id | string |
business 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 usage
|
Accept-Language | string |
Language usage |
|
|
user time zone IANA format
|
X-TimeZone | string |
user time zone IANA format |
|
|
User Email
|
user_email | string |
User Email |
|
|
User Id
|
user_id | string |
User Id |
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 | string |
business_organization_id |
|
|
project_id
|
project_id | 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 | string |
business_organization_id |
|
|
project_id
|
project_id | 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 | string |
business_organization_id |
|
|
project_id
|
project_id | 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 | string |
business_organization_id |
|
|
project_id
|
project_id | 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 | string |
business_organization_id |
|
|
project_id
|
project_id | 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 |
|---|---|---|---|
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Company is enabled
|
enabled | boolean |
Company is enabled |
|
Company ID
|
id | string |
Company ID |
|
Company name
|
name | string |
Company name |
|
Company reference
|
reference | string |
Company reference |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
|
Company members
|
user_ids | array of string |
Company members |
CreateDocument
| Name | Path | Type | Description |
|---|---|---|---|
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Document is enabled
|
enabled | boolean |
Document is enabled |
|
Document type
|
file_type | string |
Document type |
|
Document ID
|
id | string |
Document ID |
|
Document source
|
item_source | string |
Document source |
|
media_resource
|
media_resource | Media | |
|
Document name
|
name | string |
Document name |
|
Document parent folder ID
|
parent_id | string |
Document parent folder ID |
|
Document type
|
type | string |
Document type |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
CreateFormInstance
| Name | Path | Type | Description |
|---|---|---|---|
|
Form user ID
|
assignee_id | string |
Form assigned user ID |
|
Form category ID
|
category_id | string |
Form category ID |
|
Form creation date
|
client_created_at | string |
Form creation ID |
|
Form update date
|
client_updated_at | string |
Form update ID |
|
Form company ID
|
company_id | string |
Form assigned company ID |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Form due date
|
due_date | string |
Form due date |
|
Form template ID
|
form_id | string |
Form template ID |
|
Form ID
|
id | string |
Form ID |
|
Form latitude
|
latitude | number |
Form latitude |
|
Form longitude
|
longitude | number |
Form longitude |
|
Form module ID
|
module_id | string |
Form module ID |
|
Form name
|
name | string |
Form name |
|
Form phase ID
|
phase_id | string |
Form phase ID |
|
Form plan ID
|
plan_id | string |
Form plan ID |
|
Form X position
|
position_x | number |
Form X position |
|
Form Y Position
|
position_y | number |
Form Y position |
|
Form priority ID
|
priority_id | string |
Form priority ID |
|
Form status ID
|
status_id | string |
Form status ID |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
CreateObservation
| Name | Path | Type | Description |
|---|---|---|---|
|
assignee_id
|
assignee_id | string | |
|
client_created_at
|
client_created_at | string | |
|
client_updated_at
|
client_updated_at | string | |
|
common_observation_id
|
common_observation_id | string | |
|
company_id
|
company_id | string | |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
description
|
description | string | |
|
due_date
|
due_date | string | |
|
id
|
id | string | |
|
latitude
|
latitude | number | |
|
longitude
|
longitude | number | |
|
module_id
|
module_id | string | |
|
phase_id
|
phase_id | string | |
|
plan_id
|
plan_id | string | |
|
position_x
|
position_x | number | |
|
position_y
|
position_y | number | |
|
priority_id
|
priority_id | string | |
|
project_id
|
project_id | string | |
|
status_id
|
status_id | string | |
|
trade_id
|
trade_id | string | |
|
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 case
|
case_number | string |
Project case |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Is current user in project
|
current_user_in_project | boolean |
Is current user in project ? |
|
Project description
|
description | string |
Project description |
|
Project end date
|
end_date | string |
Project end date |
|
Project is active
|
is_active | boolean |
Project is active |
|
Project is archived
|
is_archived | boolean |
Project is archived |
|
Project language
|
language | string |
Project language |
|
media_resource
|
media_resource | Media | |
|
Project members count
|
member_count | integer |
Project members count |
|
Project name
|
name | string |
Project name |
|
Project organization ID
|
organization_id | string |
Project organization ID |
|
Project ID
|
project_id | string |
Project ID |
|
Project status
|
status | string |
Project status |
|
Project time zone
|
time_zone | string |
Project IANA time zone |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
|
Project workspace ID
|
workspace_id | string |
Project workspace ID |
Document
| Name | Path | Type | Description |
|---|---|---|---|
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Document is enabled
|
enabled | boolean |
Document is enabled |
|
Document type
|
file_type | string |
Document type |
|
Document ID
|
id | string |
Document ID |
|
Document source
|
item_source | string |
Document source |
|
media_resource
|
media_resource | Media | |
|
Document name
|
name | string |
Document name |
|
Document parent folder ID
|
parent_id | string |
Document parent folder ID |
|
Document type
|
type | string |
Document type |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
FolderContent
| Name | Path | Type | Description |
|---|---|---|---|
|
Folder content creation date
|
created_at | string |
Folder content creation date |
|
Folder content is enabled
|
enabled | boolean |
Folder content is enabled |
|
Folder content ID
|
id | string |
Folder content ID |
|
Folder content name
|
name | string |
Folder content name |
|
Folder content order
|
order | double |
Folder content order |
|
Folder content source
|
source | string |
Folder content Isourced |
|
Folder content foldersource
|
sources_contained | string |
Folder content foldersource |
|
Folder content type
|
type | string |
Folder content type |
|
Folder content update date
|
updated_at | string |
Folder content update date |
Form
| Name | Path | Type | Description |
|---|---|---|---|
|
Template category ID
|
category_id | string |
Template category ID |
|
Template creation date
|
created_at | string |
Template creation date |
|
Template enabled
|
enabled | boolean |
Template enabled yes/no |
|
Template ID
|
id | string |
Template ID |
|
Template module ID
|
module_id | string |
Template module ID |
|
Template name
|
name | string |
Template name |
|
Template update date
|
updated_at | string |
Template update date |
|
Template version number
|
version | integer |
Template version number |
GetCommonObsByTrade
| Name | Path | Type | Description |
|---|---|---|---|
|
CommonObs
|
common_observations | array of ObservationCommonObservation |
CommonObs |
GetCompanies
| Name | Path | Type | Description |
|---|---|---|---|
|
Companies
|
companies | array of Company |
Companies |
|
Continuous token
|
continuous_token | string |
Token to get next items |
|
Items count
|
count | integer |
Items count |
|
List is incomplet
|
need_to_relaunch | boolean |
List is incomplet |
|
Items total count
|
total_count | integer |
Items total count |
GetDocumentsFiltered
| Name | Path | Type | Description |
|---|---|---|---|
|
count
|
count | integer | |
|
documents
|
documents | array of Document |
GetFolderContent
| Name | Path | Type | Description |
|---|---|---|---|
|
Folder contents
|
contents | array of FolderContent |
Folder contents |
|
count
|
count | integer |
GetFormFull
| Name | Path | Type | Description |
|---|---|---|---|
|
Form user ID
|
assignee_id | string |
Form assigned User ID |
|
Form User name
|
assignee_name | string |
Form assigned User name |
|
Form category Id
|
category_id | string |
Form category ID |
|
Form category name
|
category_name | string |
Form category name |
|
Form creation date
|
client_created_at | string |
Form creation date |
|
Form update date
|
client_updated_at | string |
Form update date |
|
Form company ID
|
company_id | string |
Form company ID |
|
Form company name
|
company_name | string |
Form Assigned Company name |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Form delete date
|
deleted_at | string |
Form delete date |
|
Form deleted by
|
deleted_by | string |
Form deleted by user id |
|
Form description
|
description | string |
Form description |
|
Form due date
|
due_date | string |
Form due date |
|
Form enabled
|
enabled | boolean |
Form enabled |
|
Form template ID
|
form_id | string |
Form template ID |
|
Form ID
|
id | string |
Form ID |
|
Form latitude
|
latitude | string |
Form latitude |
|
Form number
|
legacy_id | integer |
Form number |
|
Form longitude
|
longitude | string |
Form longitude |
|
Form Module Id
|
module_id | string |
Form module ID |
|
Form Module name
|
module_name | string |
Form module name |
|
Organization ID
|
organization_id | string |
Organization ID |
|
Organization name
|
organization_name | string |
Organization name |
|
Form phase Id
|
phase_id | string |
Form phase ID |
|
Form phase name
|
phase_name | string |
Form phase name |
|
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 priority ID
|
priority_id | string |
Form priority ID |
|
Form priority name
|
priority_name | string |
Form priority name |
|
Project Id
|
project_id | string |
Project ID |
|
Project name
|
project_name | string |
Project name |
|
Form status ID
|
status_id | string |
Form status ID |
|
Form status name
|
status_name | string |
Form status name |
|
Form template name
|
template_name | string |
Form template name |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
|
Form URL
|
web_url | string |
Form URL |
GetFormStatuses
| Name | Path | Type | Description |
|---|---|---|---|
|
count
|
count | integer | |
|
Statuses
|
statuses | array of StatusResponseWithoutLanguage |
Statuses |
GetForms
| Name | Path | Type | Description |
|---|---|---|---|
|
count
|
count | integer | |
|
List of templates
|
forms | array of Form |
List of templates |
GetGroup
| Name | Path | Type | Description |
|---|---|---|---|
|
Group ID
|
id | string |
Group ID |
|
Group name
|
name | string |
Group name |
GetGroups
| Name | Path | Type | Description |
|---|---|---|---|
|
count
|
count | integer | |
|
Groups
|
groups | array of GetGroup |
Groups |
|
limit
|
limit | integer | |
|
offset
|
offset | integer | |
|
total_count
|
total_count | integer |
GetLanguage
| Name | Path | Type | Description |
|---|---|---|---|
|
Language code
|
code | string |
Language code |
|
Language description
|
name | string |
Language description |
GetLanguages
| Name | Path | Type | Description |
|---|---|---|---|
|
Languages count
|
count | integer |
Languages count |
|
Languages list
|
langs | array of GetLanguage |
Languages list |
GetMembers
| Name | Path | Type | Description |
|---|---|---|---|
|
Continuous token
|
continuous_token | string |
Token to get next items |
|
Items count
|
count | integer |
Items count |
|
List is incomplet
|
need_to_relaunch | boolean |
List is incomplet |
|
Project members
|
project_members | array of Member |
Project members |
|
Items total count
|
total_count | integer |
Items total count |
GetModules
| Name | Path | Type | Description |
|---|---|---|---|
|
continuous_token
|
continuous_token | string | |
|
count
|
count | integer | |
|
Modules list
|
modules | array of Module |
list of project modules |
|
need_to_relaunch
|
need_to_relaunch | boolean | |
|
offset
|
offset | string |
GetModulesCategories
| Name | Path | Type | Description |
|---|---|---|---|
|
Categories
|
categories | array of ModuleCategory |
Categories |
|
count
|
count | integer |
GetModulesForm
| Name | Path | Type | Description |
|---|---|---|---|
|
Continuous token
|
continuous_token | string |
Token to get next items |
|
Items count
|
count | integer |
Items count |
|
Module list
|
modules | array of ModuleForm |
Module list |
|
List is incomplet
|
need_to_relaunch | boolean |
List is incomplet |
|
Items total count
|
total_count | integer |
Items total count |
GetModulesOrgaSuggestion
| Name | Path | Type | Description |
|---|---|---|---|
|
count
|
count | integer | |
|
limit
|
limit | integer | |
|
offset
|
offset | integer | |
|
Suggestions
|
suggestions | array of ModuleOrgaSuggestion |
Suggestions |
|
total_count
|
total_count | integer |
GetObservationFull
| Name | Path | Type | Description |
|---|---|---|---|
|
Observation user ID
|
assignee_id | string |
Observation assigned user ID |
|
Observation user name
|
assignee_name | string |
Observation assigned user name |
|
Observation creation date
|
client_created_at | string |
Observation creation date |
|
Observation update date
|
client_updated_at | string |
Observation update date |
|
Observation commonobs id
|
common_observation_id | string |
Observation common observation ID |
|
Observation commonobs name
|
common_observation_name | string |
Observation common observation name |
|
Observation company ID
|
company_id | string |
Observation assigned company ID |
|
Observation company name
|
company_name | string |
Observation assigned company name |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
deleted_at
|
deleted_at | string | |
|
deleted_by
|
deleted_by | string | |
|
Observation description
|
description | string |
Observation description |
|
Observation due date
|
due_date | string |
Observation due date |
|
Observation is enabled
|
enabled | boolean |
Observation is enabled |
|
Observation ID
|
id | string |
Observation ID |
|
Observation latitude
|
latitude | number |
Observation latitude |
|
Observation num
|
legacy_id | integer |
Observation num |
|
Observation longitude
|
longitude | number |
Observation longitude |
|
Observation module ID
|
module_id | string |
Observation module ID |
|
Observation module name
|
module_name | string |
Observation module name |
|
Observation organization ID
|
organization_id | string |
Observation organization ID |
|
Observation organization name
|
organization_name | string |
Observation organization name |
|
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 plan ID
|
plan_id | string |
Observation plan ID |
|
Observation plan name
|
plan_name | string |
Observation plan name |
|
Observation X position
|
position_x | number |
Observation X position |
|
Observation Y position
|
position_y | number |
Observation Y position |
|
Observation priority ID
|
priority_id | string |
Observation priority ID |
|
Observation priority name
|
priority_name | string |
Observation priority name |
|
Observation project ID
|
project_id | string |
Observation project ID |
|
Observation project name
|
project_name | string |
Observation project name |
|
Observation status ID
|
status_id | string |
Observation status ID |
|
Observation status name
|
status_name | string |
Observation status name |
|
Observation trade ID
|
trade_id | string |
Observation trade ID |
|
Observation trade name
|
trade_name | string |
Observation trade name |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
|
Observation URL
|
web_url | string |
Observation URL |
GetPhases
| Name | Path | Type | Description |
|---|---|---|---|
|
Continuous token
|
continuous_token | string |
Token to get next items |
|
Items count
|
count | integer |
Items count |
|
List is incomplet
|
need_to_relaunch | boolean |
List is incomplet |
|
Phases
|
phases | array of Phase |
Phases |
|
Items total count
|
total_count | integer |
Items total count |
GetPriorities
| Name | Path | Type | Description |
|---|---|---|---|
|
Continuous token
|
continuous_token | string |
Token to get next items |
|
Items count
|
count | integer |
Items count |
|
List is incomplet
|
need_to_relaunch | boolean |
List is incomplet |
|
Priorities
|
priorities | array of Priority |
Priorities |
|
Items total count
|
total_count | integer |
Items total count |
GetProject
| Name | Path | Type | Description |
|---|---|---|---|
|
Project address
|
address | string |
Project address |
|
Project case
|
case_number | string |
Project case |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Is current user in project
|
current_user_in_project | boolean |
Is current user in project ? |
|
Project description
|
description | string |
Project description |
|
Project end date
|
end_date | string |
Project end date |
|
Project is active
|
is_active | boolean |
Project is active |
|
Project is archived
|
is_archived | boolean |
Project is archived |
|
Project language
|
language | string |
Project language |
|
media_resource
|
media_resource | Media | |
|
Project members count
|
member_count | integer |
Project members count |
|
Project name
|
name | string |
Project name |
|
Project organization ID
|
organization_id | string |
Project organization ID |
|
Project ID
|
project_id | string |
Project ID |
|
Project status
|
status | string |
Project status |
|
Project time zone
|
time_zone | string |
Project IANA time zone |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
|
Project workspace ID
|
workspace_id | string |
Project workspace ID |
GetProjectRoles
| Name | Path | Type | Description |
|---|---|---|---|
|
count
|
count | integer | |
|
limit
|
limit | integer | |
|
offset
|
offset | integer | |
|
project_roles
|
project_roles | array of ProjectRole | |
|
total_count
|
total_count | integer |
GetProjects
| Name | Path | Type | Description |
|---|---|---|---|
|
count
|
count | integer | |
|
limit
|
limit | integer | |
|
offset
|
offset | integer | |
|
Projects list
|
projects | array of Project |
List of projects |
|
total_count
|
total_count | integer |
GetRole
| Name | Path | Type | Description |
|---|---|---|---|
|
authorization_role_id
|
authorization_role_id | string | |
|
Role description
|
description | string |
Role description |
|
descriptions
|
descriptions | LocalizedLabelFallback | |
|
higher_role_id
|
higher_role_id | string | |
|
Role ID
|
id | string |
Role ID |
|
Role is default
|
is_default | boolean |
Role is default |
|
is_default_invitation_role
|
is_default_invitation_role | boolean | |
|
is_lower_role
|
is_lower_role | boolean | |
|
Role name
|
name | string |
Role name |
|
names
|
names | LocalizedLabelFallback | |
|
position
|
position | integer | |
|
user_count
|
user_count | integer |
GetRoles
| Name | Path | Type | Description |
|---|---|---|---|
|
organization_roles
|
organization_roles | array of GetRole |
GetStatuses
| Name | Path | Type | Description |
|---|---|---|---|
|
Continuous token
|
continuous_token | string |
Token to get next items |
|
Items count
|
count | integer |
Items count |
|
List is incomplet
|
need_to_relaunch | boolean |
List is incomplet |
|
Statuses
|
statuses | array of StatusResponseWithoutFlow |
Statuses |
|
Items total count
|
total_count | integer |
Items total count |
GetTimeZones
| Name | Path | Type | Description |
|---|---|---|---|
|
count
|
count | integer | |
|
limit
|
limit | integer | |
|
offset
|
offset | integer | |
|
Timezones list
|
time_zones | array of TimeZones |
Timezones list |
|
total_count
|
total_count | integer |
GetTradesByModule
| Name | Path | Type | Description |
|---|---|---|---|
|
Trades
|
trades | array of ProjectTrade |
Trades |
GetUserInfo
| Name | Path | Type | Description |
|---|---|---|---|
|
User company name
|
company | string |
User company name |
|
User creation date
|
created_at | string |
User creation date |
|
deleted_at
|
deleted_at | string | |
|
User email
|
string |
User email |
|
|
email_validated
|
email_validated | string | |
|
User first name
|
first_name | string |
User first name |
|
User ID
|
id | string |
User ID |
|
is active
|
is_active | string |
is active |
|
User last name
|
last_name | string |
User last name |
|
User locale
|
locale | string |
User locale |
|
media_resource
|
media_resource | Media | |
|
updated_at
|
updated_at | string |
GetWorkspaceMembers
| Name | Path | Type | Description |
|---|---|---|---|
|
count
|
count | integer | |
|
limit
|
limit | integer | |
|
offset
|
offset | integer | |
|
total_count
|
total_count | integer | |
|
workspace_members
|
workspace_members | array of OrgaMemberResponses |
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 creation date
|
created_at | string |
Media creation date |
|
Media file name
|
file_name | string |
Media file name |
|
Media ID
|
id | string |
Media ID |
|
Media MIME Type
|
mime_type | string |
Media MIME Type |
MediaResourceUrl
| Name | Path | Type | Description |
|---|---|---|---|
|
Media URL
|
url | string |
Media URL |
Member
| Name | Path | Type | Description |
|---|---|---|---|
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Member email
|
string |
Member email |
|
|
Member is enabled
|
enabled | boolean |
Member is enabled |
|
Member first name
|
first_name | string |
Member first name |
|
Member last name
|
last_name | string |
Member last name |
|
picture
|
picture | Media | |
|
Member role ID
|
project_role_id | string |
Member role ID |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
|
Member ID
|
user_id | string |
Member ID |
Module
| Name | Path | Type | Description |
|---|---|---|---|
|
Module color
|
color | string |
Module color |
|
Module creation date
|
created_at | string |
Module creation date |
|
Module is enabled
|
enabled | boolean |
Module is enabled |
|
Module icon
|
icon | string |
Module icon |
|
Module ID
|
id | string |
Module ID |
|
Module name
|
name | string |
Module name |
|
names
|
names | array of LocalizedLabel | |
|
Module display order
|
order | double |
Module display order |
|
project_id
|
project_id | string | |
|
settings
|
settings | ModuleSettings | |
|
Module type
|
type | string |
Module type |
|
Module update date
|
updated_at | string |
Module update date |
ModuleCategory
| Name | Path | Type | Description |
|---|---|---|---|
|
Category container ID
|
container_id | string |
Category container ID |
|
Category creation date
|
created_at | string |
Category creation date |
|
Category deletion date
|
deleted_at | string |
Category deletion date |
|
Category is enabled
|
enabled | boolean |
Category is enabled |
|
Category ID
|
id | string |
Category ID |
|
Category module ID
|
module_id | string |
Category module ID |
|
Category name
|
name | string |
Category name |
|
Parent category ID
|
parent_id | string |
Parent category ID |
|
Category update date
|
updated_at | string |
Category update date |
ModuleForm
| Name | Path | Type | Description |
|---|---|---|---|
|
Module color
|
color | string |
Module color |
|
Module creation date
|
created_at | string |
Module settings |
|
Module is enabled
|
enabled | boolean |
Module settings |
|
Module icon
|
icon | string |
Module icon |
|
Module ID
|
id | string |
Module ID |
|
Module name
|
name | string |
Module name |
|
names
|
names | array of LocalizedLabel | |
|
Module order
|
order | double |
Module display order |
|
Project ID
|
project_id | string |
Project ID |
|
Module type
|
type | string |
Module type |
|
Module update date
|
updated_at | string |
Module settings |
ModuleOrgaSuggestion
| Name | Path | Type | Description |
|---|---|---|---|
|
color
|
color | string | |
|
container_id
|
container_id | string | |
|
container_type
|
container_type | string | |
|
created_at
|
created_at | string | |
|
icon
|
icon | string | |
|
id
|
id | string | |
|
Suggestion default
|
is_default | boolean |
Suggestion default |
|
Suggestion name
|
name | string |
Suggestion name |
|
Suggestion names
|
names | array of LocalizedLabel |
Suggestion names |
|
Suggestion type
|
type | string |
Suggestion type |
|
updated_at
|
updated_at | string | |
|
Suggestion visibility
|
visibility | string |
Suggestion visibility |
ModuleSettings
| Name | Path | Type | Description |
|---|---|---|---|
|
due_date_days_offset
|
due_date_days_offset | string | |
|
is_company_mandatory
|
is_company_mandatory | boolean | |
|
is_description_mandatory
|
is_description_mandatory | boolean | |
|
is_group_mandatory
|
is_group_mandatory | boolean | |
|
is_observation_library_mandatory
|
is_observation_library_mandatory | boolean | |
|
is_photo_mandatory
|
is_photo_mandatory | boolean |
ObservationCommonObservation
| Name | Path | Type | Description |
|---|---|---|---|
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
CommonObs Is Enabled
|
enabled | boolean |
CommonObs Is Enabled |
|
CommonObs Id
|
id | string |
CommonObs Id |
|
CommonObs Name
|
name | string |
CommonObs Name |
|
CommonObs Names
|
names | array of LocalizedLabel |
CommonObs Names |
|
CommonObs Trade Id
|
trade_id | string |
CommonObs Trade Id |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
ObservationMediaResource
| Name | Path | Type | Description |
|---|---|---|---|
|
Media file name
|
file_name | string |
Media file name |
|
Media ID
|
id | string |
Media ID |
|
Media MIME type
|
mime_type | string |
Media MIME type |
|
Media order
|
position | string |
Media order |
OrgaMemberResponses
| Name | Path | Type | Description |
|---|---|---|---|
|
email
|
string | ||
|
first_name
|
first_name | string | |
|
is_admin
|
is_admin | boolean | |
|
is_pending
|
is_pending | boolean | |
|
last_name
|
last_name | string | |
|
media_resource
|
media_resource | Media | |
|
user_id
|
user_id | string |
Phase
| Name | Path | Type | Description |
|---|---|---|---|
|
Phase creation date
|
created_at | string |
Phase creation date |
|
Phase deletion date
|
deleted_at | string |
Phase deletion date |
|
Phase is enabled
|
enabled | boolean |
Phase is enabled |
|
Phase ID
|
id | string |
Phase ID |
|
Phase name
|
name | string |
Phase name |
|
Phase names
|
names | array of LocalizedLabel |
Phase names |
|
Phase order
|
order | double |
Phase order |
|
Phase update date
|
updated_at | string |
Phase update date |
Priority
| Name | Path | Type | Description |
|---|---|---|---|
|
Priority color
|
color | string |
Priority color |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Priority is enabled
|
enabled | boolean |
Priority is enabled |
|
icon
|
icon | IconTypeParameters | |
|
Priority ID
|
id | string |
Priority ID |
|
Priority ID
|
is_default | boolean |
Priority ID |
|
Priority name
|
name | string |
Priority name |
|
Priority is default
|
names | array of LocalizedLabel |
Priority is default |
|
Priority order
|
position | integer |
Priority order |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
Project
| Name | Path | Type | Description |
|---|---|---|---|
|
Project case
|
case_number | string |
Project case |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Is current user in project
|
current_user_in_project | boolean |
Is current user in project ? |
|
Project description
|
description | string |
Project description |
|
Project end date
|
end_date | string |
Project end date |
|
Project is active
|
is_active | boolean |
Project is active |
|
Project is archived
|
is_archived | boolean |
Project is archived |
|
media_resource
|
media_resource | Media | |
|
Project members count
|
member_count | integer |
Project members count |
|
Project name
|
name | string |
Project name |
|
Project organization ID
|
organization_id | string |
Project organization ID |
|
Project ID
|
project_id | string |
Project ID |
|
Project status
|
status | string |
Project status |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
|
Project workspace ID
|
workspace_id | string |
Project workspace ID |
ProjectRole
| Name | Path | Type | Description |
|---|---|---|---|
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Role Descriptions
|
descriptions | array of LocalizedLabel |
Role Descriptions |
|
Role id
|
id | string |
Role id |
|
Role Name
|
name | string |
Role Name |
|
Role Names
|
names | array of LocalizedLabel |
Role Names |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
|
Users list
|
user_ids | array of string |
Users list |
ProjectTrade
| Name | Path | Type | Description |
|---|---|---|---|
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Is enabled
|
enabled | boolean |
Is enabled |
|
Trade ID
|
id | string |
Trades ID |
|
Module ID
|
module_id | string |
Module ID |
|
Trade name
|
name | string |
Trade name |
|
Trade names
|
names | array of LocalizedLabel |
Trade names |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
StatusResponseWithoutFlow
| Name | Path | Type | Description |
|---|---|---|---|
|
Status color
|
color | string |
Status color |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Status is enabled
|
enabled | boolean |
Status is enabled |
|
Status id
|
id | string |
Status id |
|
Status is default
|
is_default | boolean |
Status is default |
|
Status name
|
name | string |
Status name |
|
Status names
|
names | array of LocalizedLabel |
Status names |
|
Status order
|
position | integer |
Status order |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
StatusResponseWithoutLanguage
| Name | Path | Type | Description |
|---|---|---|---|
|
Status color
|
color | string |
Status color |
|
Status is enabled
|
enabled | boolean |
Status is enabled |
|
Status id
|
id | string |
Status id |
|
Status name
|
name | string |
Status name |
|
Status order
|
position | integer |
Status order |
TimeZones
| Name | Path | Type | Description |
|---|---|---|---|
|
Timezone name
|
display_name | string |
Timezone name |
|
Timezone ID
|
id | string |
Timezone ID |
|
Timezone standard name
|
standard_name | string |
Timezone standard name |
|
Timezone UTC offset
|
utc_offset | string |
Timezone UTC offset |
UploadChunkInit
| Name | Path | Type | Description |
|---|---|---|---|
|
Chunk ID
|
chunk_id | string |
Chunk ID |
|
Upload expiration delay
|
expires_after_secs | double |
Upload expiration delay |
|
Media ID
|
media_id | string |
Media ID |
|
Minimum chunk size
|
min_chunk_size | integer |
Minimum chunk size |
Workspace
| Name | Path | Type | Description |
|---|---|---|---|
|
Workspace reference
|
client_reference | string |
Workspace reference |
|
Creation date
|
created_at | string |
Creation date |
|
Created by
|
created_by | string |
Created by |
|
Workspace deleted by
|
deleted_at | string |
Workspace deleted by |
|
Workspace deletion date
|
deleted_by | string |
Workspace deletion date |
|
media_resource
|
media_resource | Media | |
|
Workspace name
|
name | string |
Workspace name |
|
Workspace parent ID
|
parent_id | string |
Workspace parent ID |
|
Update date
|
updated_at | string |
Update date |
|
Updated by
|
updated_by | string |
Update by |
|
Workspace ID
|
workspace_id | string |
Workspace ID |