Share via


Finalcad One Connect v2 (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
Email 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 - Get connected user

Get your user informations

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 - Create a document

Project - Create a document

Project - Create a Form

Create a Form

Project - Create observation

Create an observation

Project - Get companies

Get the companies in your project

Project - Get discussions groups

Get the discussions 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 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 categories

Get forms categories

Project - Get forms priorities

Get the forms priorities in your project

Project - Get forms status

Get the forms status 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 observations modules for a given project

Project - Get observations priorities

Get the observations priorities in your project

Project - Get observations status

Get the observations status 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

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

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

Media - Abort chunk upload

Cancel the current chunk upload process and discard any received parts.

Parameters

Name Key Required Type Description
the media ID
mediaId True string

the 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

the chunk ID
chunk_id True string

chunk id

the media index
segment_index True integer

chunk index

Is this chink the last one
last_chunk True boolean

is it the last chunk

the stream
stream True file

chunk stream

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

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 Total size
total_bytes integer

Media Total size in bytes

Returns

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 - 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

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

Organization - Get roles

Get organization roles

Parameters

Name Key Required Type Description
The organization id
organizationId True string

The organization id

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
The organization id
organizationId True string

The organization id

Number max of modules to get
limit string

Number max of modules to get

offset
offset string

offset

the workspace ID
workspace_id string

the 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
The organization id
organizationId True string

The organization id

the parent workspace ID
parent_id string

the parent workspace ID

include children
with_children string

include children

Language usage
Accept-Language string

Language usage

user time zone IANA format
X-TimeZone string

user time zone IANA format

Returns

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

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

Project - Create 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

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

Project - Get discussions groups

Get the discussions groups in your project

Parameters

Name Key Required Type Description
The parent project id.
projectId True string

The parent project id.

Number max of groups to get
limit integer

Number max of groups to get

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
The project ID
projectId True string

The project ID

The parent folder ID (optional)
parent_id string

The parent folder ID (optional)

Type folder or document (optional)
type string

Type folder or document (optional)

Language usage
Accept-Language string

Language usage

user time zone IANA format
X-TimeZone string

user time zone IANA format

Returns

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 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

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

Number of modules to get
limit integer

Number of modules to get

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

Project - Get forms categories

Get forms categories

Parameters

Name Key Required Type Description
The id of the project
projectId True string

The id of the project

The module ID
module_id string

The module ID

The parent category ID (optional)
category_id string

The parent category ID (optional)

Include disabled
with_disabled string

Include disabled

Language usage
Accept-Language string

Language usage

user time zone IANA format
X-TimeZone string

user time zone IANA format

Returns

Project - Get forms priorities

Get the forms priorities in your project

Parameters

Name Key Required Type Description
The project Id
projectId True string

The project Id

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

Project - Get forms status

Get the forms status in your project

Parameters

Name Key Required Type Description
Id of the project
projectId True string

Id of the project

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

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

Id of the category
category_id string

Id of the category

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
The project id
projectId True string

The project id

The module id
module_id string

The module id

Language usage
Accept-Language string

Language usage

user time zone IANA format
X-TimeZone string

user time zone IANA format

Returns

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

Project - Get observation models

Get observation models (formerly common observations)

Parameters

Name Key Required Type Description
The project id
projectId True string

The project id

The trade id
tradeId True string

The trade id

Language usage
Accept-Language string

Language usage

user time zone IANA format
X-TimeZone string

user time zone IANA format

Returns

Project - Get observation modules

Get the list of all existing observations 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

Number max of modules to get
limit integer

Number max of modules to get

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 observations priorities

Get the observations priorities in your project

Parameters

Name Key Required Type Description
The project id
projectId True string

The project id

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

Project - Get observations status

Get the observations status in your project

Parameters

Name Key Required Type Description
The project id
projectId True string

The project id

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

Project - Get phases

Get the phases in your project

Parameters

Name Key Required Type Description
The project id
projectId True string

The project id

continuous_token
continuous_token string

continuous_token

Offset
offset string

Offset

Number max to get
limit integer

Number max to get

Include deleted
with_deleted boolean

Include 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
The parent project id
projectId True string

The parent project id

The parent folder ID (optional)
folder_id string

The parent folder ID (optional)

Type folder or plan (optional)
type string

Type folder or plan (optional)

Language usage
Accept-Language string

Language usage

user time zone IANA format
X-TimeZone string

user time zone IANA format

Returns

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

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

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

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

Update 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

Update 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

Update 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

Update by
updated_by string

Update by

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

Update 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 number

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 num
version integer

Template version num

GetCommonObsByTrade

Name Path Type Description
CommonObs
common_observations array of ObservationCommonObservation

CommonObs

GetCompanies

Name Path Type Description
Companies
companies array of Company

Companies

Continous 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 Delete by
deleted_by string

Form Delete 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 Num
legacy_id integer

Form Num

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

Update 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
Templates list
forms array of Form

Template list

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
Continous 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
Continous 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

Update by
updated_by string

Update by

Observation url
web_url string

Observation url

GetPhases

Name Path Type Description
Continous 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
Continous 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

Update 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

Project list

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
Continous 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

Timezone 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
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

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 MimeType
mime_type string

Media MimeType

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
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

Update 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 number

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 number

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

Update 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

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 number

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

Update 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

Update 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

descriptions
descriptions array of LocalizedLabel
id
id string
name
name string
names
names array of LocalizedLabel
Update date
updated_at string

Update date

Update by
updated_by string

Update by

user_ids
user_ids array of string

ProjectTrade

Name Path Type Description
Creation date
created_at string

Creation date

Created by
created_by string

Created by

Is enable
enabled boolean

Is Enable

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

Update 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

Update 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 number

Upload expiration delay

Media Id
media_id string

Media Id

Min chunk size
min_chunk_size integer

Min 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

Update by
updated_by string

Update by

Workspace Id
workspace_id string

Workspace Id