Finalcad One Connect (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 protected] |
Connector Metadata | |
---|---|
Publisher | FINALCAD |
Website | https://developer.finalcad.com/ |
Privacy policy | https://www.finalcad.com/apps-privacy-policy |
Categories | Productivity |
Fc1 Connector
Prerequisites
In order to use this connector, you should dispose of 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 a form detail
Read an observation detail
Read a project informations
Read current user informations
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
abort a chunk upload |
Abort Media Upload |
append a chunk to 1 upload |
Media Upload Part |
create 1 observation |
Crrate observation |
create a document |
Create a document |
create a form instance |
Create a formulaire |
Get 1 observation |
Get observation detail |
Get a document detail |
Get a document detail |
Get a media resource (not a media) |
Get media content |
Get a media resource Url (not a media) |
Get media url |
Get a project |
Get project detail |
Get Form instance Full Detail |
Get form detail |
Get form template list for project and module |
Get form template list |
get list of formulaires modules |
Get formulaires modules |
Get list of observations modules |
Get observations modules |
get organizations ids for user |
Get organizations list |
Get projects list |
Get projects list |
Get user infos |
Get current user detail |
Init |
Init |
start chunk upload |
Media Upload Init |
validate a chunk upload |
Validate Media Upload |
abort a chunk upload
Abort Media Upload
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 |
Returns
- Body
- Media
append a chunk to 1 upload
Media Upload Part
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 |
index of part
|
segment_index | True | integer |
index of segment |
is it the last
|
last_chunk | True | boolean |
is chunk the last |
file content
|
stream | True | file |
file content |
md5
|
md5 | True | string |
md5 |
create 1 observation
Crrate observation
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
the project id
|
projectId | True | string |
The project id |
Language usage
|
Accept-Language | string |
Language usage |
|
Observation user id
|
assignee_id | string |
Observationassigned 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
create a document
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 |
|
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
create a form instance
Create a formulaire
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
the project id
|
projectId | True | string |
the project id |
Language usage
|
Accept-Language | string |
Language usage |
|
formulaire user id
|
assignee_id | string |
formulaire assigned user id |
|
formulaire category id
|
category_id | string |
formulaire category id |
|
formulaire company id
|
company_id | string |
formulaire assigned company id |
|
formulaire due date
|
due_date | string |
formulaire due date |
|
formulaire Template
|
form_id | string |
formulaire Template id |
|
formulaire id
|
id | string |
formulaire id |
|
formulaire latitude
|
latitude | number |
formulaire latitude |
|
formulaire longitude
|
longitude | number |
formulaire longitude |
|
formulaire module id
|
module_id | string |
formulaire module id |
|
formulaire name
|
name | string |
formulaire name |
|
formulaire phase id
|
phase_id | string |
formulaire phase id |
|
formulaire plan id
|
plan_id | string |
formulaire plan id |
|
formulaire X position
|
position_x | number |
formulaire X position |
|
formulaire Y position
|
position_y | number |
formulaire Y position |
|
formulaire priority id
|
priority_id | string |
formulaire priority id |
|
formulaire status id
|
status_id | string |
formulaire status id |
Returns
- Body
- CreateFormInstance
Get 1 observation
Get observation detail
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id of the project
|
projectId | True | string |
Id of the project |
Id the the observation
|
observationId | True | string |
Id of the observation |
Language usage
|
Accept-Language | string |
Language usage |
Returns
- Body
- GetObservationFull
Get a document detail
Get a document detail
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
the 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 |
Returns
- Body
- Document
Get a media resource (not a media)
Get media content
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
is of the media
|
mediaId | True | string |
id of the media |
Language usage
|
Accept-Language | string |
Language usage |
Returns
- response
- binary
Get a media resource Url (not a media)
Get media url
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
id of the media
|
mediaId | True | string |
id of the media |
Language usage
|
Accept-Language | string |
Language usage |
Returns
- Body
- MediaResourceUrl
Get a project
Get project detail
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 |
Returns
- Body
- GetProject
Get Form instance Full Detail
Get form detail
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 |
Returns
- Body
- GetFormFull
Get form template list for project and module
Get form template list
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 |
|
Language usage
|
Accept-Language | string |
Language usage |
Returns
- Body
- GetForms
get list of formulaires modules
Get formulaires modules
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
the project id
|
projectId | True | string |
The project id |
continous token
|
continuous_token | string |
continous token |
|
limit
|
limit | integer |
limit |
|
with deleted
|
with_deleted | boolean |
With deleted |
|
Language usage
|
Accept-Language | string |
Language usage |
Returns
- Body
- GetModulesForm
Get list of observations modules
Get observations modules
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
the project id
|
projectId | True | string |
The project id |
continous token
|
continuous_token | string |
continous token |
|
limit
|
limit | integer |
limit |
|
Language usage
|
Accept-Language | string |
Language usage |
Returns
- Body
- GetModules
get organizations ids for user
Get organizations list
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Language usage
|
Accept-Language | string |
Language usage |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
id
|
id | string |
id |
name
|
name | string |
name |
Get projects list
Get projects list
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
The organizaton id
|
organizationId | True | string |
The organization id |
The workspace id
|
workspace_id | string |
The workspace id (optional) |
|
Search in child workspaces
|
with_workspace_children | boolean |
Search in child workspaces (optional) |
|
Search term
|
search_term | string |
Search term (optional) |
|
Language usage
|
Accept-Language | string |
Language usage |
Returns
- Body
- GetProjects
Get user infos
Get current user detail
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Language usage
|
Accept-Language | string |
Language usage |
Returns
- Body
- GetUserInfo
Init
Init
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
business_organization_id
|
business_organization_id | string |
business_organization_id |
|
project_id
|
project_id | string |
project_id |
|
language
|
language | string |
language |
|
timezone
|
timezone | string |
timezone |
Returns
Name | Path | Type | Description |
---|---|---|---|
business_organization_id
|
business_organization_id | string | |
project_id
|
project_id | string | |
language
|
language | string | |
timezone
|
timezone | string |
start chunk upload
Media Upload Init
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Language usage
|
Accept-Language | string |
Language usage |
|
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
validate a chunk upload
Validate Media Upload
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Id of the media
|
mediaId | True | string |
Id of the media |
Language usage
|
Accept-Language | string |
Language usage |
|
Chunk Id
|
chunk_id | string |
Chunk Id |
Returns
- Body
- Media
Triggers
trigger then document created |
trigger then document created |
trigger then formulaire created |
trigger then formulaire created |
trigger then formulaire updated |
trigger then formulaire updated |
trigger then observation created |
trigger then observation created |
trigger then observation updated |
trigger then observation updated |
trigger then document created
trigger then document 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 then formulaire created
trigger then formulaire 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 then formulaire updated
trigger then formulaire 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 then observation created
trigger then observation 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 then observation updated
trigger then observation 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
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 |
---|---|---|---|
Formulaire User Id
|
assignee_id | string |
Formulaire Assigned User Id |
Formulaire Category Id
|
category_id | string |
Formulaire Category Id |
Formulaire Creation Date
|
client_created_at | string |
Formulaire Creation Id |
Formulaire Update Date
|
client_updated_at | string |
Formulaire Update Id |
Formulaire Company Id
|
company_id | string |
Formulaire Assigned Company Id |
Creation date
|
created_at | string |
Creation date |
Created by
|
created_by | string |
Created by |
Formulaire Due Date
|
due_date | string |
Formulaire Due Date |
Formulaire Template Id
|
form_id | string |
Formulaire Template Id |
Formulaire Id
|
id | string |
Formulaire Id |
Formulaire Latitude
|
latitude | number |
Formulaire Latitude |
Formulaire Longitude
|
longitude | number |
Formulaire Longitude |
Formulaire Module Id
|
module_id | string |
Formulaire Module Id |
Formulaire Name
|
name | string |
Formulaire Name |
Formulaire Phase Id
|
phase_id | string |
Formulaire Phase Id |
Formulaire Plan Id
|
plan_id | string |
Formulaire Plan Id |
Formulaire X Position
|
position_x | number |
Formulaire X Position |
Formulaire Y Position
|
position_y | number |
Formulaire Y Position |
Formulaire Priority Id
|
priority_id | string |
Formulaire Priority Id |
Formulaire Status Id
|
status_id | string |
Formulaire 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 |
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 |
GetFormFull
Name | Path | Type | Description |
---|---|---|---|
Formulaire User Id
|
assignee_id | string |
Formulaire assigned User Id |
Formulaire User name
|
assignee_name | string |
Formulaire assigned User name |
Formulaire Category Id
|
category_id | string |
Formulaire Category Id |
Formulaire Category name
|
category_name | string |
Formulaire Category name |
Formulaire Creation date
|
client_created_at | string |
Formulaire Creation date |
Formulaire Update date
|
client_updated_at | string |
Formulaire Update date |
Formulaire Company Id
|
company_id | string |
Formulaire Company Id |
Formulaire Company name
|
company_name | string |
Formulaire Assigned Company name |
Creation date
|
created_at | string |
Creation date |
Created by
|
created_by | string |
Created by |
Formulaire Delete date
|
deleted_at | string |
Formulaire Delete date |
Formulaire Delete by
|
deleted_by | string |
Formulaire Delete by user id |
Formulaire Description
|
description | string |
Formulaire Description |
Formulaire Due Date
|
due_date | string |
Formulaire Due Date |
Formulaire Enabled
|
enabled | boolean |
Formulaire Enabled |
Formulaire Template Id
|
form_id | string |
Formulaire Template Id |
Formulaire Id
|
id | string |
Formulaire Id |
Formulaire Latitude
|
latitude | string |
Formulaire Latitude |
Formulaire Num
|
legacy_id | integer |
Formulaire Num |
Formulaire Longitude
|
longitude | string |
Formulaire Longitude |
Formulaire Module Id
|
module_id | string |
Formulaire Module Id |
Formulaire Module name
|
module_name | string |
Formulaire Module name |
Organization Id
|
organization_id | string |
Organization Id |
Organization Name
|
organization_name | string |
Organization Name |
Formulaire Phase Id
|
phase_id | string |
Formulaire Phase Id |
Formulaire Phase name
|
phase_name | string |
Formulaire Phase name |
Formulaire Plan Id
|
plan_id | string |
Formulaire Plan Id |
Formulaire Plan name
|
plan_name | string |
Formulaire Plan name |
Formulaire X Position
|
position_x | string |
Formulaire X Position |
Formulaire Y Position
|
position_y | string |
Formulaire Y Position |
Formulaire Priority Id
|
priority_id | string |
Formulaire Priority Id |
Formulaire Priority name
|
priority_name | string |
Formulaire Priority name |
Project Id
|
project_id | string |
Project Id |
Project Name
|
project_name | string |
Project Name |
Formulaire Status Id
|
status_id | string |
Formulaire Status Id |
Formulaire Status name
|
status_name | string |
Formulaire Status Name |
Formulaire Template name
|
template_name | string |
Formulaire Template name |
Update date
|
updated_at | string |
Update date |
Update by
|
updated_by | string |
Update by |
Formulaire Url
|
web_url | string |
Formulaire Url |
GetForms
Name | Path | Type | Description |
---|---|---|---|
count
|
count | integer | |
Templates list
|
forms | array of Form |
Template list |
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 |
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 |
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 |
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 |
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 |
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 |
LocalizedLabel
Name | Path | Type | Description |
---|---|---|---|
language
|
language | string | |
translation
|
translation | string |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Min chunk size
|
min_chunk_size | integer |
Min chunk size |
binary
This is the basic data type 'binary'.