Morta (Preview)

Reference

The Morta API is based around REST. Our API accepts json encoded request bodies and returns JSON encoded respones. We use standard HTTP responses, authentication and verbs. All API requests must have an authorization header of the form: { 'Authorization': 'Bearer <API_KEY>' }

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following: - Azure Government regions - Azure China regions - 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)
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)

Contact
Name	Mort Support
URL	https://morta.io
Email	support@morta.io

Connector Metadata
Publisher	Morta
Website	https://morta.io
Privacy policy	https://morta.io/termsofservice
Categories	Productivity;Content and Files

Morta offers a cloud-based solution that deeply integrates with the software you are accustomed to, empowering you to digitize, connect, and automate your tracking processes effectively. The Morta connector allows you to interact with all Morta functionality through the Microsoft Power Automate platform.

Prerequisites

To use this connector you will need an Morta Account

How to get credentials

Login to your Morta account, navigate to your Morta Integrations and simply add a new API key. You can then use this API key within Microsoft Power Automate. When entering your API key on the Microsoft Power Automate Platform make sure to prepend "Bearer " so that your entered API key looks like the following: "Bearer YOUR_API_KEY_HERE"

Get started with your connector

To get started with the connector you can start by pulling your favourite projects/workspaces from the Morta platform. To do this you can use the 'GetFavouriteProjects' action.

Following this, you can create a process/document on Morta using the 'CreateProcess' action and the following parameters:

name: New Process
project id: <one_of_your_project_public_ids>
type: Custom

Known issues and limitations

None

Common errors and remedies

When using the Morta connector users may experience one of the following HTTP status codes:

401: The request action is not authorised. This could be because you have not entered your API key or you have entered your API key incorrectly (e.g. not add "Bearer " before the copied API key)
403: You do not have access to the requested Morta resource. Make sure to request permissions to the requested resource from the owner of that resource.
404: The Morta resource does not exist. Please login to the Morta platform to make sure you have entered the ID correctly.
422: Data is missing or formatted incorrectly in the request. Make sure you have read the description for all the data required in the request and have followed the specification. For example, you may be required to enter a number as a field but have entered a string instead.
429: Too many requests have been sent to Morta in a period of time. Make sure you are not sending more than 10 requests per second to the Morta platform.

FAQ

Question: Why is my Morta API key not working? Answer: Make sure you have added "Bearer " to the beginning of the API key (the word 'Bearer' and a space). The final API key being entered should like like the following (a dummy API key is being used here): "Bearer zSujSa_eXxd3b1yVtTQVMw7Ghn18Ja9sOWvj-O4C908"

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 your MotaWord connection	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Add a column to a view	Add a new column to a specific table view.
Add or update rows in a table	Upsert (add or update) rows in a table view based on a specified column.
Add Row to Table	Add a new row to the specified table.
Add rows to end of table	Insert new rows at the end of the specified table view.
Add Tag to User	Add a tag to a specific user
Change a User's Role in a Project	Change the role of a user in a specific project, identified by the project's UUID and user's Firebase ID
Check Processes Table is Used In	Check and return a list of processes, table joins, and selects where the specified table is used.
Check Views Column Is Used In	Retrieve all views in which a specific table column is used.
Create a new notification	Create a new notification for a specific project.
Create a New Process	Create a new process in a specified project
Create a New Process Section	Create a new section within a specified process, with an option to set a parent section
Create a New Project	Create a new project with the specified name
Create a New Project Secret	Create a new secret for a specified project
Create a new view for a table	Create a new view for a specific table.
Create API Key for User	Create an API key for the currently logged in user
Create Index on Table Column	Create an index on one or more columns of a table to improve query performance.
Create Multiple New Process Sections	Create multiple new sections within a specified process, each with an optional parent section
Create New Comment	Create a new comment within a specific comment thread
Create New Comment Thread	Create a new comment thread
Create new document table	Create a new document table within a project.
Create New Process Response	Create a new response for a process section.
Create New Process Sections	Create multiple new sections within a process
Create New Project Heading Styling	Create new heading styling for a specific project
Create New User	Create a new user
Create Passthrough Download Request	Make a passthrough API call to an external source system for downloading files.
Create Passthrough Request to Source System	Make a passthrough API call to an external source system.
Create Permissions for a Resource	Create permissions for a specific resource (such as a table, table view, or process).
Create Table Column	Add a new column to an existing table.
Create Table Join	Create a join between two tables.
Delete a Project	Delete a specific project identified by its UUID
Delete a Project Invite	Delete an invite to a project
Delete a Project Secret	Delete a specific secret from a project
Delete a single notification	Delete a specific notification by its ID.
Delete a table	Delete a specified table by its UUID.
Delete a User from a Project	Remove a user from a specific project, identified by the project's UUID and user's Firebase ID
Delete a view for a table	Delete a specific view of a table.
Delete All Rows from Table	Deletes all rows from the specified table.
Delete API Key	Delete an API key for the currently logged in user
Delete Comment	Delete a specific comment within a comment thread
Delete Comment Thread	Delete a comment thread
Delete Integration from Table	Remove a specific integration from a table.
Delete Permissions for a Resource	Delete permissions for a specific resource (such as a table, table view, or process).
Delete Process	Delete a process identified by its UUID
Delete Process Response	Delete a specific process response.
Delete Process Section	Delete a specific process section.
Delete specific rows	Delete specific rows from a table view based on row IDs.
Delete Table Column	Delete a specific column from a table.
Delete Table Join	Delete a join from a table.
Delete Table Rows	Delete all rows or specific rows from a table.
Delete Tag from User	Delete a tag from a specific user
Delete Top Project Heading Styling	Delete the top heading styling for a specific project
Download chart image	Download an image file of a chart based on data from a specific table view.
Download Table Data as CSV	Download the data of a specified table as a CSV file.
Download view data as a csv file	Download the data of a specific table view in CSV format.
Duplicate a Process	Duplicate an existing process, potentially in a different project
Duplicate a Project	Create a duplicate of an existing project
Duplicate a table	Create a duplicate of an existing table along with its data, settings, and optionally linked tables.
Duplicate a view for a table	Create a duplicate of an existing view for a specific table.
Duplicate Process	Duplicate an existing process, optionally into a different project
Duplicate Process Section	Duplicate a specific process section.
Duplicate Process Section	Duplicate a specific process section asynchronously.
Duplicate the default view for a table	Create a duplicate of the default view for a specific table.
Export Process	Export a specific process by its UUID into different formats (PDF or DOCX)
Get a list of all supported event types	Retrieve a list of all supported event types for notifications.
Get a single view for a table	Retrieve a specific view by its ID for a table.
Get actual table view data	Retrieve the actual data for a specific table view.
Get all events for a resource	Retrieve all events associated with a specific resource, filtered by various criteria.
Get All Table Joins	Retrieve all joins associated with a table.
Get all views for a table	Retrieve all views associated with a specific table.
Get chart data for the view	Retrieve data for generating a chart based on a specific table view.
Get Comment Thread	Retrieve a specific comment thread by its ID
Get Comment Thread Statistics	Retrieve statistics for comment threads based on reference type and main reference ID
Get Comment Threads by Reference	Retrieve all comment threads associated with a specific reference
Get Deleted Process Sections	Retrieve all deleted sections of a specific process, with an optional filter for a specific process section
Get Deleted Tables in a Project	Retrieve all deleted tables from a specific project, identified by its UUID. Only accessible by project owners.
Get File for Table Cell	Retrieve a file associated with a specific cell in a table.
Get Invited Project Members	Retrieve all invited members for a specified project
Get my details	Get info on the current user
Get Notifications for a Project	Retrieve all notifications associated with a specific project. This endpoint is accessible only to users with owner-level permissions for the project.
Get Process Details	Retrieve detailed information of a specific process by its UUID
Get Process Section	Retrieve a specific process section.
Get Project Information	Retrieve detailed information about a specific project identified by its UUID
Get Project Members	Retrieve all members associated with a specified project
Get Project Resources	Retrieve resources associated with a specific project identified by its UUID
Get Project Secrets	Retrieve all secrets for a specified project
Get Project Tables	Retrieve tables associated with a specific project, identified by its UUID
Get Project Tags	Retrieve all tags associated with a specified project
Get Project Variables	Retrieve all variables associated with a specified project
Get Resource Permissions	Retrieve permissions for a specified resource, such as a table, table view, or process.
Get Sent Notifications for a Project	Retrieve all sent notifications for a specified project
Get Specific User Details	Get information on a specific user
Get stats on table columns	Retrieve statistical data for columns in a specific table view.
Get Table and Its Rows	Retrieve a table and its rows based on provided parameters
Get Table Column Statistics	Retrieve statistics for table columns based on specified parameters.
Get Table Columns	Retrieve all active columns of a specific table.
Get Table Rows	Retrieve rows from a table based on provided query parameters.
Get Tag by Public ID	Retrieve a tag by its public ID.
Get the unique values for a column	Retrieve the unique/distinct values for a specific column in a table view.
Get Unique Values for a Column	Retrieve a list of distinct (unique) values for a specified column in a table.
Get User's Favourite Projects	Get all favourite projects the currently logged in user is part of
Get User's Owned and Administered Projects	Get all projects where the user is the owner or an admin
Get User's Pinned Projects	Get the projects pinned by a user identified by their Firebase ID
Get User's Public Contributions	Get the public contributions made by a user, identified by their Firebase ID
Get User's Public Projects	Get all public projects where the user is a member
Get User Achievements	Get the achievement badges of a user by their Firebase ID
Get User Contributions	Get the number of contributions per day made by a user, identified by their Firebase ID
Get User Details by Public ID	Get information on a specific user by their public ID
Get User Projects	Get all projects the currently logged in user is part of
Get User Templates	Get all templates the currently logged in user has access to
Invite a User to a Project	Invite a single user to join a project by email. If the user already exists, they are added directly; otherwise, an invite is sent. Requires owner or admin permissions.
Invite Multiple Users to a Project	Invite multiple users to join a project, by email. If users already exist, they are added directly, otherwise, an invite is sent. Requires owner or admin permissions.
Preview resulting row from inputs	Preview the resulting row from given inputs in a specific table view.
Reopen Comment Thread	Reopen a previously resolved comment thread
Request Permissions for a Resource	Request permissions for a specific resource (such as a table, table view, or process).
Resend an Invite to a User for a Project	Resend an invitation to a user for a project. This is applicable for both new users and existing users who have previously been invited. Requires owner or admin permissions.
Reset Process Response	Reset an existing process response to its initial state.
Resolve Comment Thread	Resolve a comment thread
Restore a deleted table	Restore a previously deleted table using its UUID.
Restore a Project	Restore a specific project, identified by its UUID, that has been previously deleted
Restore Process	Restore a deleted process identified by its UUID
Restore Process Response	Restore a previously deleted process response.
Restore Process Section	Restore a previously deleted process section.
Restore Table Column	Restore a previously deleted column in a table.
Retrieve Deleted Processes within a Project	Get all deleted processes associated with a specific project, identified by its UUID
Retrieve Processes within a Project	Get all processes associated with a specific project, identified by its UUID
Search for Users	Search for users by project or process
Search within a Project	Perform a search operation within a specific project, identified by its UUID
Set the view as the default view	Designate a specific table view as the default view for the table.
Stream all rows for the table	Stream the data of all rows for a specific table.
Stream all rows for the view	Stream the data of all rows for a specific table view.
Submit Process Response	Submit a process response, marking it as completed.
Submit Process Response Draft	Submit a draft of a process response for later completion.
Sync Table with Integration	Sync a table with a specified integration.
Toggle Favourite Status of a Project	Change whether the project is a favourite for the currently logged in user
Toggle Pin Status of a Project	Change whether the project is pinned for the currently logged in user
Update a Project Invite	Update an existing invite in a project
Update a Project Secret	Update a specific secret in a project
Update a single notification	Update a specific notification by its ID.
Update a view for a table	Update an existing view for a specific table.
Update an Existing Process	Update an existing process's details by process ID
Update an Existing Process Section	Update an existing process section's details by process section ID
Update an Existing Project	Update an existing project's details by project ID
Update API Key	Update an API key for the currently logged in user
Update column on view	Update a specific column in a table view.
Update Comment	Update a specific comment within a comment thread
Update Current User Profile	Update the profile of the currently logged in user
Update Existing Process Response	Update an existing response for a process section.
Update existing rows	Update existing rows in a specified table view.
Update Existing Rows in Table	Update existing rows in the specified table.
Update existing table	Update the properties of an existing table.
Update existing table cells	Update specific cells in a table view.
Update Multiple Process Sections	Update multiple existing process sections.
Update Permissions for a Resource	Update permissions for a specific resource (such as a table, table view, or process).
Update Process Responders	Update the list of responders for a given process identified by its UUID
Update Process Section Order	Update the order of process sections within a process.
Update Project Heading Styling	Update heading styling for a specific project
Update Table Cells	Update specific cells in a table.
Update Table Column	Update the properties of a specific column in a table.
Update Table Join	Update an existing join on a table.
Update User Account	Update the account details for the currently logged in user
Upsert Row in Table	Add or update a row in the specified table based on a unique column value.

Add a column to a view

Operation ID:: AddColumnToTableView

Add a new column to a specific table view.

Parameters

Name	Key	Required	Type	Description
View Id	view_id	True	uuid	The UUID of the table view to which a column is to be added.
aconexSynced	aconexSynced		integer
aggregate	aggregate		integer
alterOptions	alterOptions
autodeskBim360Synced	autodeskBim360Synced		integer
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
dateFormat	dateFormat		string
decimalPlaces	decimalPlaces		integer
description	description
hardValidation	hardValidation		boolean
isIndexed	isIndexed		boolean
isJoined	isJoined		boolean
kind	kind		string
manualOptions	manualOptions		array of string
tableOptions	tableOptions
locked	locked	True	boolean
mortaSynced	mortaSynced		integer
name	name	True	string
procoreSynced	procoreSynced		integer
publicId	publicId		uuid
required	required	True	boolean
reviztoIssuesSynced	reviztoIssuesSynced		integer
script	script		string
scriptEnabled	scriptEnabled		boolean
sortOrder	sortOrder	True	number
stringValidation	stringValidation		string
thousandSeparator	thousandSeparator		boolean
validationMessage	validationMessage		string
validationNoBlanks	validationNoBlanks		boolean
validationNoDuplicates	validationNoDuplicates		boolean
viewpointSynced	viewpointSynced		integer
width	width		integer

Returns

Name	Path	Type	Description
data	data	TableViewColumn
metadata	metadata	object

Add or update rows in a table

Operation ID:: UpsertTableRowsInView

Upsert (add or update) rows in a table view based on a specified column.

Parameters

Name	Key	Required	Type	Description
View Id	view_id	True	uuid	The UUID of the table view where rows are to be upserted.
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
rowData	rowData	True	object
sortOrder	sortOrder		number
upsertColumnName	upsertColumnName	True	string

Returns

Name	Path	Type
data	data	array of object
publicId	data.publicId	string
rowData	data.rowData	object
sortOrder	data.sortOrder	number
metadata	metadata	object

Add Row to Table

Operation ID:: CreateTableRows

Add a new row to the specified table.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table to which the row will be added
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
rowData	rowData	True	object
sortOrder	sortOrder		number

Returns

Name	Path	Type
data	data	array of object
publicId	data.publicId	string
rowData	data.rowData	object
sortOrder	data.sortOrder	number
metadata	metadata	object

Add rows to end of table

Operation ID:: InsertTableRowsInView

Insert new rows at the end of the specified table view.

Parameters

Name	Key	Required	Type	Description
View Id	view_id	True	uuid	The UUID of the table view where rows are to be added.
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
rowData	rowData	True	object
sortOrder	sortOrder		number

Returns

Name	Path	Type
data	data	array of object
publicId	data.publicId	string
rowData	data.rowData	object
sortOrder	data.sortOrder	number
metadata	metadata	object

Add Tag to User

Operation ID:: UserAddTag

Add a tag to a specific user

Parameters

Name	Key	Required	Type	Description
User Id	user_id	True	uuid	Public UUID of the user to add the tag to
tagReferenceId	tagReferenceId	True	string

Returns

Name	Path	Type	Description
data	data	Tag
metadata	metadata	object	Additional metadata

Change a User's Role in a Project

Operation ID:: ChangeUserRoleOnProject

Change the role of a user in a specific project, identified by the project's UUID and user's Firebase ID

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	UUID of the project
Firebase Id	firebase_id	True	string	Firebase ID of the user whose role is to be changed
role	role	True	string

Returns

Name	Path	Type	Description
data	data	SimpleProject
metadata	metadata	object

Check Processes Table is Used In

Operation ID:: GetWhereTableUsed

Check and return a list of processes, table joins, and selects where the specified table is used.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table to check usage

Returns

Name	Path	Type	Description
data	data	array of object
link	data.link	string	Direct link to the process, join or select
name	data.name	string	Name of the process, join or select where the table is used
type	data.type	string	Type of usage (process, sourceJoin, targetJoin, sourceSelect, etc.)
metadata	metadata	object

Check Views Column Is Used In

Operation ID:: CheckColumnInViews

Retrieve all views in which a specific table column is used.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table containing the column
Column Id	column_id	True	uuid	UUID of the column to check in views

Returns

Name	Path	Type	Description
data	data	array of TableView
metadata	metadata	object

Create a new notification

Operation ID:: CreateNotification

Create a new notification for a specific project.

Parameters

Name	Key	Required	Type
description	description	True	string
processes	processes		array of uuid
projectId	projectId	True	uuid
tables	tables		array of uuid
resource	resource	True	string
verb	verb	True	string
webhookUrl	webhookUrl	True	string

Returns

Name	Path	Type	Description
data	data	Notification
metadata	metadata	object

Create a New Process

Operation ID:: CreateProcess

Create a new process in a specified project

Parameters

Name	Key	Required	Type
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
name	name	True	string
projectId	projectId	True	uuid
type	type	True	string

Returns

Name	Path	Type	Description
data	data	Process
change	metadata.change	object	The changes made during process creation
event	metadata.event	string	The event type, e.g., 'process.created'
resourceId	metadata.resourceId	uuid	The UUID of the newly created process

Create a New Process Section

Operation ID:: CreateProcessSection

Create a new section within a specified process, with an option to set a parent section

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process to create a new section in
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
description	description
name	name	True	string
parentId	parentId		uuid
plaintextDescription	plaintextDescription		string

Returns

Name	Path	Type	Description
data	data	MortaProcessSection
metadata	metadata	object

Create a New Project

Operation ID:: CreateProject

Create a new project with the specified name

Parameters

Name	Key	Required	Type	Description
name	name	True	string

Returns

Name	Path	Type	Description
data	data	SimpleProject
metadata	metadata	object

Create a New Project Secret

Operation ID:: CreateProjectSecret

Create a new secret for a specified project

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	The UUID of the project where the secret will be created
name	name	True	string
value	value	True	string

Returns

Name	Path	Type	Description
data	data	ProjectSecret
metadata	metadata	object

Create a new view for a table

Operation ID:: CreateTableView

Create a new view for a specific table.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	The UUID of the table for which the view is to be created.
allowContributorDelete	allowContributorDelete		boolean
chartSettings	chartSettings
collapsedGroupView	collapsedGroupView		boolean
backgroundColour	backgroundColour	True	string
columnId	columnId		uuid
columnName	columnName	True	string
filterType	filterType	True	string
fontColour	fontColour	True	string
multipleValues	multipleValues		array of
value	value
columnId	columnId		uuid
columnName	columnName	True	string
description	description
locked	locked		boolean
required	required		boolean
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
description	description
disableNewRow	disableNewRow		boolean
displayCommentRows	displayCommentRows		integer
displayValidationErrorRows	displayValidationErrorRows		integer
columnId	columnId		uuid
columnName	columnName	True	string
filterType	filterType	True	string
multipleValues	multipleValues		array of
orGroup	orGroup		string
value	value
frozenIndex	frozenIndex		integer
columnId	columnId		uuid
columnName	columnName	True	string
direction	direction	True	string
includeAllColumns	includeAllColumns		boolean
isDefault	isDefault		boolean
name	name	True	string
rowHeight	rowHeight		integer
columnId	columnId		uuid
columnName	columnName	True	string
direction	direction	True	string
type	type		integer
unpackMultiselectGroupView	unpackMultiselectGroupView		boolean

Returns

Name	Path	Type	Description
data	data	TableView
metadata	metadata	object

Create API Key for User

Operation ID:: CreateApiKey

Create an API key for the currently logged in user

Parameters

Name	Key	Required	Type	Description
name	name		string

Returns

Name	Path	Type	Description
data	data	ApiKey
metadata	metadata	object

Create Index on Table Column

Operation ID:: CreateTableIndexes

Create an index on one or more columns of a table to improve query performance.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table for which indexes are to be created.
publicId	publicId	True	uuid

Returns

Name	Path	Type	Description
data	data	array of TableColumn
metadata	metadata	object

Create Multiple New Process Sections

Operation ID:: CreateMultipleProcessSections

Create multiple new sections within a specified process, each with an optional parent section

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process where new sections will be created
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
description	description
name	name	True	string
parentId	parentId		uuid
plaintextDescription	plaintextDescription		string

Returns

Name	Path	Type	Description
data	data	string
resourceIds	metadata.resourceIds	array of string	List of UUIDs for the newly created process sections

Create New Comment

Operation ID:: CreateComment

Create a new comment within a specific comment thread

Parameters

Name	Key	Required	Type	Description
Comment Thread Id	comment_thread_id	True	uuid	UUID of the comment thread to which the comment is being added
commentText	commentText	True	string
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid

Returns

Name	Path	Type	Description
data	data	Comment
change	metadata.change	object	Changes made in this operation
event	metadata.event	string	Event type for the operation
resourceId	metadata.resourceId	string	UUID of the newly created comment

Create New Comment Thread

Operation ID:: CreateCommentThread

Create a new comment thread

Parameters

Name	Key	Required	Type
commentText	commentText	True	string
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
mainReferenceId	mainReferenceId		uuid
referenceId	referenceId	True	uuid
referenceType	referenceType	True	string

Returns

Name	Path	Type	Description
data	data	CommentThread
change	metadata.change	object	Changes made in this operation
event	metadata.event	string	Event type for the operation
resourceId	metadata.resourceId	string	UUID of the newly created comment thread

Create new document table

Operation ID:: CreateTable

Create a new document table within a project.

Parameters

Name	Key	Required	Type
aconexSynced	aconexSynced		integer
aggregate	aggregate		integer
alterOptions	alterOptions
autodeskBim360Synced	autodeskBim360Synced		integer
dateFormat	dateFormat		string
decimalPlaces	decimalPlaces		integer
description	description
isIndexed	isIndexed		boolean
isJoined	isJoined		boolean
kind	kind		string
manualOptions	manualOptions		array of string
tableOptions	tableOptions
mortaSynced	mortaSynced		integer
name	name	True	string
procoreSynced	procoreSynced		integer
publicId	publicId		uuid
reviztoIssuesSynced	reviztoIssuesSynced		integer
script	script		string
scriptEnabled	scriptEnabled		boolean
thousandSeparator	thousandSeparator		boolean
viewpointSynced	viewpointSynced		integer
width	width		integer
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
sourceColumnId	sourceColumnId		string
targetColumnId	targetColumnId		string
isOneToMany	isOneToMany		boolean
sourceColumnId	sourceColumnId		string
targetColumnId	targetColumnId		string
joinTableName	joinTableName		string
joinViewId	joinViewId		string
joinViewName	joinViewName		string
name	name	True	string
projectId	projectId	True	uuid
type	type		string

Returns

Name	Path	Type	Description
data	data	Table
metadata	metadata	object

Create New Process Response

Operation ID:: CreateProcessResponse

Create a new response for a process section.

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process.
Process Section Id	process_section_id	True	uuid	The UUID of the process section.
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
type	type		string

Returns

Name	Path	Type	Description
data	data	ProcessResponse
metadata	metadata	object

Create New Process Sections

Operation ID:: CreateProcessSections

Create multiple new sections within a process

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process where new sections will be created
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
description	description
name	name	True	string
parentId	parentId		uuid
plaintextDescription	plaintextDescription		string

Returns

Name	Path	Type	Description
data	data	array of MortaProcessSection
metadata	metadata	object

Create New Project Heading Styling

Operation ID:: CreateProjectHeadingStyling

Create new heading styling for a specific project

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	The UUID of the project for which to create the heading styling

Returns

Name	Path	Type	Description
data	data	SimpleProject
metadata	metadata	object

Create New User

Operation ID:: CreateUser

Create a new user

Parameters

Name	Key	Required	Type
email	email	True	email
name	name	True	string
password	password	True	string
projectId	projectId		uuid

Returns

Name	Path	Type	Description
data	data	User
metadata	metadata	object

Create Passthrough Download Request

Operation ID:: IntegrationsPassthroughDownloadApiCall

Make a passthrough API call to an external source system for downloading files.

Parameters

Name	Key	Required	Type
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
data	data
headers	headers
method	method	True	string
onBehalfUserId	onBehalfUserId		uuid
path	path	True	string
sourceSystem	sourceSystem	True	string

Returns

response: binary

Create Passthrough Request to Source System

Operation ID:: IntegrationsPassthroughApiCall

Make a passthrough API call to an external source system.

Parameters

Name	Key	Required	Type
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
data	data
headers	headers
method	method	True	string
onBehalfUserId	onBehalfUserId		uuid
path	path	True	string
sourceSystem	sourceSystem	True	string

Returns

Name	Path	Type	Description
data	data	IntegrationsPassthroughResponse
metadata	metadata	object

Create Permissions for a Resource

Operation ID:: CreateResourcePermissions

Create permissions for a specific resource (such as a table, table view, or process).

Parameters

Name	Key	Required	Type
attributeId	attributeId		uuid
attributeKind	attributeKind	True	string
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
resourceId	resourceId	True	uuid
resourceKind	resourceKind	True	string
role	role	True	integer
tagReferenceId	tagReferenceId		string

Returns

Name	Path	Type	Description
data	data	AccessPolicy
metadata	metadata	object

Create Table Column

Operation ID:: CreateTableColumn

Add a new column to an existing table.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table to which the column will be added
aconexSynced	aconexSynced		integer
aggregate	aggregate		integer
alterOptions	alterOptions
autodeskBim360Synced	autodeskBim360Synced		integer
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
dateFormat	dateFormat		string
decimalPlaces	decimalPlaces		integer
description	description
isIndexed	isIndexed		boolean
kind	kind		string
manualOptions	manualOptions		array of string
tableOptions	tableOptions
mortaSynced	mortaSynced		integer
name	name	True	string
procoreSynced	procoreSynced		integer
publicId	publicId		uuid
reviztoIssuesSynced	reviztoIssuesSynced		integer
script	script		string
scriptEnabled	scriptEnabled		boolean
thousandSeparator	thousandSeparator		boolean
viewpointSynced	viewpointSynced		integer
width	width		integer

Returns

Name	Path	Type	Description
data	data	TableColumn
metadata	metadata	object

Create Table Join

Operation ID:: CreateTableJoin

Create a join between two tables.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table to create the join on.
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
dataColumns	dataColumns		array of string
isOneToMany	isOneToMany		boolean
sourceColumnId	sourceColumnId		string
targetColumnId	targetColumnId		string
joinViewId	joinViewId		string

Returns

Name	Path	Type	Description
data	data	Table
metadata	metadata	object

Delete a Project

Operation ID:: DeleteProject

Delete a specific project identified by its UUID

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	UUID of the project to be deleted

Returns

Name	Path	Type	Description
data	data	string
metadata	metadata	object

Delete a Project Invite

Operation ID:: DeleteProjectInvite

Delete an invite to a project

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	The UUID of the project from which the invite is to be deleted
Invite Id	invite_id	True	uuid	The UUID of the invite to be deleted

Returns

Name	Path	Type	Description
data	data	string
metadata	metadata	object

Delete a Project Secret

Operation ID:: DeleteProjectSecret

Delete a specific secret from a project

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	The UUID of the project from which the secret will be deleted
Secret Id	secret_id	True	uuid	The UUID of the secret to be deleted

Returns

Name	Path	Type	Description
data	data	string
metadata	metadata	object

Delete a single notification

Operation ID:: DeleteNotification

Delete a specific notification by its ID.

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	The UUID of the notification to be deleted.

Returns

Name	Path	Type	Description
data	data	string
metadata	metadata	object

Delete a table

Operation ID:: DeleteTable

Delete a specified table by its UUID.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table to delete

Returns

Name	Path	Type	Description
data	data	string
metadata	metadata	object

Delete a User from a Project

Operation ID:: RemoveUserFromProject

Remove a user from a specific project, identified by the project's UUID and user's Firebase ID

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	UUID of the project
Firebase Id	firebase_id	True	string	Firebase ID of the user to be removed

Returns

Name	Path	Type	Description
data	data	SimpleProject
metadata	metadata	object

Delete a view for a table

Operation ID:: DeleteTableView

Delete a specific view of a table.

Parameters

Name	Key	Required	Type	Description
View Id	view_id	True	uuid	The UUID of the table view to be deleted.

Returns

Name	Path	Type	Description
data	data	string
metadata	metadata	object

Delete All Rows from Table

Operation ID:: TruncateTable

Deletes all rows from the specified table.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table from which all rows are to be deleted.

Returns

Name	Path	Type	Description
data	data	string
metadata	metadata	object

Delete API Key

Operation ID:: DeleteApiKey

Delete an API key for the currently logged in user

Parameters

Name	Key	Required	Type	Description
Api Key Id	api_key_id	True	uuid	The UUID of the API key to delete

Returns

Name	Path	Type	Description
data	data	string
metadata	metadata	object	Additional metadata

Delete Comment

Operation ID:: DeleteComment

Delete a specific comment within a comment thread

Parameters

Name	Key	Required	Type	Description
Comment Thread Id	comment_thread_id	True	uuid	UUID of the comment thread containing the comment
Comment Id	comment_id	True	uuid	UUID of the comment to be deleted

Returns

Name	Path	Type	Description
data	data	Comment
change	metadata.change	object	Changes made to the comment
event	metadata.event	string	Event type for the operation
resourceId	metadata.resourceId	string	UUID of the deleted comment

Delete Comment Thread

Operation ID:: DeleteCommentThread

Delete a comment thread

Parameters

Name	Key	Required	Type	Description
Comment Thread Id	comment_thread_id	True	uuid	UUID of the comment thread to delete

Returns

Name	Path	Type	Description
data	data	CommentThread
change	metadata.change	object	Changes made to the comment thread
event	metadata.event	string	Event type for the operation
resourceId	metadata.resourceId	string	UUID of the deleted comment thread

Delete Integration from Table

Operation ID:: DeleteIntegrationFromTable

Remove a specific integration from a table.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table from which the integration will be removed.
Integration Name	integration_name	True	string	Name of the integration to be removed.

Returns

Name	Path	Type	Description
data	data	string
metadata	metadata	object

Delete Permissions for a Resource

Operation ID:: DeleteResourcePermissions

Delete permissions for a specific resource (such as a table, table view, or process).

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	UUID of the policy to delete.

Delete Process

Operation ID:: DeleteProcess

Delete a process identified by its UUID

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process to delete

Returns

Name	Path	Type	Description
data	data	MortaProcess
metadata	metadata	object

Delete Process Response

Operation ID:: DeleteProcessResponse

Delete a specific process response.

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process.
Process Section Id	process_section_id	True	uuid	The UUID of the process section.
Process Response Id	process_response_id	True	uuid	The UUID of the process response to be deleted.

Returns

Name	Path	Type	Description
data	data	MortaProcessSection
metadata	metadata	object

Delete Process Section

Operation ID:: DeleteProcessSection

Delete a specific process section.

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process.
Process Section Id	process_section_id	True	uuid	The UUID of the process section to be deleted.

Returns

Name	Path	Type	Description
data	data	MortaProcessSection
metadata	metadata	object

Delete specific rows

Operation ID:: DeleteTableRowsInView

Delete specific rows from a table view based on row IDs.

Parameters

Name	Key	Required	Type	Description
View Id	view_id	True	uuid	The UUID of the table view from which rows are to be deleted.

Returns

Name	Path	Type	Description
data	data	string
metadata	metadata	object

Delete Table Column

Operation ID:: DeleteTableColumn

Delete a specific column from a table.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table containing the column
Column Id	column_id	True	uuid	UUID of the column to delete

Returns

Name	Path	Type	Description
data	data	string
metadata	metadata	object

Delete Table Join

Operation ID:: DeleteTableJoin

Delete a join from a table.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table from which the join will be deleted.
Join Id	join_id	True	uuid	UUID of the join to be deleted.

Returns

Name	Path	Type	Description
data	data	string
metadata	metadata	object

Delete Table Rows

Operation ID:: DeleteTableRows

Delete all rows or specific rows from a table.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table from which rows are to be deleted.

Returns

Name	Path	Type	Description
data	data	string
metadata	metadata	object

Delete Tag from User

Operation ID:: UserDeleteTag

Delete a tag from a specific user

Parameters

Name	Key	Required	Type	Description
User Id	user_id	True	uuid	Public UUID of the user from whom the tag is to be deleted
Tag Id	tag_id	True	uuid	Public UUID of the tag to be deleted

Returns

Name	Path	Type	Description
data	data	string
metadata	metadata	object

Delete Top Project Heading Styling

Operation ID:: DeleteTopProjectHeadingStyling

Delete the top heading styling for a specific project

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	The UUID of the project for which to delete the top heading styling

Returns

Name	Path	Type	Description
data	data	SimpleProject
metadata	metadata	object

Download chart image

Operation ID:: DownloadTableViewChartImage

Download an image file of a chart based on data from a specific table view.

Parameters

Name	Key	Required	Type	Description
View Id	view_id	True	uuid	The UUID of the table view for which the chart image is generated.
Chart Type	chart_type		string	Type of chart for which image is being generated.
Show Legend	show_legend		boolean	Flag to indicate whether to include the legend in the chart image.
Show Values	show_values		boolean	Flag to indicate whether to include values in the chart image.
Column Value Id	column_value_id		uuid	UUID of the column used as the value source for the chart image.
Column Label Id	column_label_id		uuid	UUID of the column used as the label source for the chart image.

Returns

response: binary

Download Table Data as CSV

Operation ID:: DownloadTableAsCSV

Download the data of a specified table as a CSV file.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table to download data from
Sort	sort		string	Sorting criteria for the table rows
Filter	filter		string	Filter criteria for the table rows

Returns

response: binary

Download view data as a csv file

Operation ID:: DownloadTableViewCSV

Download the data of a specific table view in CSV format.

Parameters

Name	Key	Required	Type	Description
View Id	view_id	True	uuid	The UUID of the table view to be downloaded as CSV.
Filter	filter		string	Filters to apply to the CSV data.
Sort	sort		string	Sorting parameters for the CSV data.
Process Id	process_id		uuid	Optional UUID of a process to filter the data.

Returns

response: binary

Duplicate a Process

Operation ID:: DuplicateProcessAsync

Duplicate an existing process, potentially in a different project

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process to be duplicated
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
duplicateLinkedTables	duplicateLinkedTables		boolean
duplicatePermissions	duplicatePermissions		boolean
targetProjectId	targetProjectId		string

Duplicate a Project

Operation ID:: DuplicateProject

Create a duplicate of an existing project

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	The UUID of the project to be duplicated
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
duplicatePermissions	duplicatePermissions		boolean

Duplicate a table

Operation ID:: DuplicateTable

Create a duplicate of an existing table along with its data, settings, and optionally linked tables.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table to be duplicated
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
duplicateLinkedTables	duplicateLinkedTables		boolean
duplicatePermissions	duplicatePermissions		boolean
targetProjectId	targetProjectId		string

Returns

Name	Path	Type	Description
data	data	string
metadata	metadata	object

Duplicate a view for a table

Operation ID:: DuplicateTableView

Create a duplicate of an existing view for a specific table.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	The UUID of the table for which the view is to be duplicated.
View Id	view_id	True	uuid	The UUID of the view to be duplicated.

Returns

Name	Path	Type	Description
data	data	TableView
metadata	metadata	object

Duplicate Process

Operation ID:: DuplicateProcess

Duplicate an existing process, optionally into a different project

Parameters

Name	Key	Required	Type
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
processId	processId	True	uuid
projectId	projectId		uuid

Returns

Name	Path	Type	Description
data	data	MortaProcess
metadata	metadata	object

Duplicate Process Section

Operation ID:: DuplicateProcessSection

Duplicate a specific process section.

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process.
Process Section Id	process_section_id	True	uuid	The UUID of the process section to duplicate.

Returns

Name	Path	Type	Description
data	data	MortaProcessSection
metadata	metadata	object

Duplicate Process Section

Operation ID:: DuplicateProcessSectionAsync

Duplicate a specific process section asynchronously.

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process.
Process Section Id	process_section_id	True	uuid	The UUID of the process section to duplicate.

Returns

Name	Path	Type	Description
data	data	string
metadata	metadata	object

Duplicate the default view for a table

Operation ID:: DuplicateDefaultTableView

Create a duplicate of the default view for a specific table.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	The UUID of the table for which the default view is to be duplicated.
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
name	name		string
type	type		integer

Returns

Name	Path	Type	Description
data	data	TableView
metadata	metadata	object

Export Process

Operation ID:: ExportProcess

Export a specific process by its UUID into different formats (PDF or DOCX)

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process to export
Export Format	export_format		string	The format of the export (PDF or DOCX)
Table Links	table_links		boolean	Include table links in the export
Description	description		boolean	Include process description in the export
Page Format	page_format		string	Page format for the export
Page Orientation	page_orientation		string	Page orientation for the export
Font Type	font_type		string	Font type for the export
Font Size	font_size		integer	Font size for the export

Returns

response: binary

Get a list of all supported event types

Operation ID:: GetNotificationEventTypes

Retrieve a list of all supported event types for notifications.

Returns

Name	Path	Type	Description
data	data	array of string
metadata	metadata	object

Get a single view for a table

Operation ID:: GetTableView

Retrieve a specific view by its ID for a table.

Parameters

Name	Key	Required	Type	Description
View Id	view_id	True	uuid	The UUID of the table view to be retrieved.
Ignore Cached Options	ignore_cached_options		boolean	Flag to indicate whether to ignore cached options in the response.

Returns

Name	Path	Type	Description
data	data	TableViewWithTable
metadata	metadata	object

Get actual table view data

Operation ID:: GetTableViewRows

Retrieve the actual data for a specific table view.

Parameters

Name	Key	Required	Type	Description
View Id	view_id	True	uuid	The UUID of the table view for which data is to be retrieved.
Filter	filter		string	Filters to apply to the data retrieval.
Sort	sort		string	Sorting parameters for the data retrieval.
Page	page		integer	Page number for pagination.
Size	size		integer	Number of items per page for pagination.

Returns

Name	Path	Type
data	data	array of object
publicId	data.publicId	string
rowData	data.rowData	object
sortOrder	data.sortOrder	number
next_page_token	metadata.next_page_token	string
size	metadata.size	integer
total	metadata.total	integer

Get all events for a resource

Operation ID:: GetEvents

Retrieve all events associated with a specific resource, filtered by various criteria.

Parameters

Name	Key	Required	Type	Description
Resource Id	resource_id	True	uuid	The UUID of the resource for which events are to be retrieved.
Type	type	True	string	The type of the resource (e.g., user, process, table, project).
Page	page		integer	Page number for pagination.
User	user		uuid	Optional UUID of a user to filter the events.
Verb	verb		array	Optional list of verbs to filter the events.
Start Date	start_date		date-time	Optional start date to filter the events.
End Date	end_date		date-time	Optional end date to filter the events.
Search	search		string	Optional search term to filter the events.

Returns

Name	Path	Type	Description
data	data	array of Event
metadata	metadata	object

Get All Table Joins

Operation ID:: GetTableJoins

Retrieve all joins associated with a table.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table for which joins are to be retrieved.

Returns

Name	Path	Type	Description
data	data	array of TableJoin
metadata	metadata	object

Get all views for a table

Operation ID:: GetTableViews

Retrieve all views associated with a specific table.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	The UUID of the table for which views are to be retrieved.
Ignore Columns	ignore_columns		boolean	Flag to indicate whether to ignore column data in the response.

Returns

Name	Path	Type	Description
data	data	array of TableView
metadata	metadata	object

Get chart data for the view

Operation ID:: GetTableViewChartData

Retrieve data for generating a chart based on a specific table view.

Parameters

Name	Key	Required	Type	Description
View Id	view_id	True	uuid	The UUID of the table view for which chart data is requested.
Chart Type	chart_type		string	Type of chart for which data is being fetched.
Show Legend	show_legend		boolean	Flag to indicate whether to show the legend in the chart.
Show Values	show_values		boolean	Flag to indicate whether to show values in the chart.
Column Value Id	column_value_id		uuid	UUID of the column to be used as the value source for the chart.
Column Label Id	column_label_id		uuid	UUID of the column to be used as the label source for the chart.

Returns

Name	Path	Type
data	data	array of object
items	data	object
metadata	metadata	object

Get Comment Thread

Operation ID:: GetCommentThread

Retrieve a specific comment thread by its ID

Parameters

Name	Key	Required	Type	Description
Comment Thread Id	comment_thread_id	True	uuid	UUID of the comment thread to retrieve

Returns

Name	Path	Type	Description
data	data	CommentThread
metadata	metadata	object

Get Comment Thread Statistics

Operation ID:: GetCommentThreadStatsByReference

Retrieve statistics for comment threads based on reference type and main reference ID

Parameters

Name	Key	Required	Type	Description
Reference Type	reference_type	True	string	Type of the reference (process_section, table, or table_view) for which to gather statistics
Main Reference ID	main_reference_id		uuid	UUID of the main reference for which to gather statistics

Returns

Name	Path	Type	Description
data	data	array of CommentThreadStats
metadata	metadata	object

Get Comment Threads by Reference

Operation ID:: GetCommentThreadsByReference

Retrieve all comment threads associated with a specific reference

Parameters

Name	Key	Required	Type	Description
Reference Type	reference_type	True	string	Type of the reference (process_section, table, or table_view) associated with the comment threads
Reference Id	reference_id	True	uuid	UUID of the reference associated with the comment threads
Main Reference	main_reference		string	Optional main reference for additional filtering

Returns

Name	Path	Type	Description
data	data	array of CommentThread
metadata	metadata	object

Get Deleted Process Sections

Operation ID:: GetDeletedProcessSections

Retrieve all deleted sections of a specific process, with an optional filter for a specific process section

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process to retrieve deleted sections from
Process Section Id	process_section_id		uuid	Optional UUID of a specific process section to filter deleted sections

Returns

response: array of MortaProcessSection

Get Deleted Tables in a Project

Operation ID:: GetProjectDeletedTables

Retrieve all deleted tables from a specific project, identified by its UUID. Only accessible by project owners.

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	The UUID of the project for which to retrieve deleted tables

Returns

Name	Path	Type	Description
data	data	array of Table
metadata	metadata	object

Get File for Table Cell

Operation ID:: GetFileForTableCell

Retrieve a file associated with a specific cell in a table.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table containing the file.
Column Id	column_id	True	uuid	UUID of the column containing the cell.
Filename	filename	True	string	Name of the file to retrieve.

Returns

response: binary

Get Invited Project Members

Operation ID:: GetInvitedProjectMembers

Retrieve all invited members for a specified project

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	The UUID of the project for which invited members are to be retrieved

Returns

Name	Path	Type	Description
data	data	array of InvitedMember
metadata	metadata	object

Get my details

Operation ID:: GetMe

Get info on the current user

Returns

Name	Path	Type	Description
data	data	User
metadata	metadata	object	The metadata object

Get Notifications for a Project

Operation ID:: GetProjectNotifications

Retrieve all notifications associated with a specific project. This endpoint is accessible only to users with owner-level permissions for the project.

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	The UUID of the project for which notifications are to be retrieved

Returns

Name	Path	Type	Description
data	data	array of Notification
metadata	metadata	object

Get Process Details

Operation ID:: GetProcess

Retrieve detailed information of a specific process by its UUID

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process to retrieve
Exclude Children	exclude_children		boolean	Flag to exclude child elements from the process response

Returns

Name	Path	Type	Description
data	data	MortaProcess
metadata	metadata	object

Get Process Section

Operation ID:: GetProcessSection

Retrieve a specific process section.

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process.
Process Section Id	process_section_id	True	uuid	The UUID of the process section.
Main Parent Section	main_parent_section		boolean	Flag to retrieve the main parent section of the process section

Returns

Name	Path	Type	Description
data	data	MortaProcessSection
metadata	metadata	object

Get Project Information

Operation ID:: GetProject

Retrieve detailed information about a specific project identified by its UUID

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	UUID of the project to retrieve

Returns

Name	Path	Type	Description
folders	data.folders	array of object
childFolders	data.folders.childFolders	array of object
name	data.folders.childFolders.name	string
name	data.folders.name	string
projectDetails	data.projectDetails	SimpleProject
role	data.role	string	User's role in the project
metadata	metadata	object

Get Project Members

Operation ID:: GetProjectMembers

Retrieve all members associated with a specified project

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	The UUID of the project for which members are to be retrieved

Returns

Name	Path	Type	Description
data	data	array of ProjectListWithUserTags
metadata	metadata	object

Get Project Resources

Operation ID:: GetProjectResources

Retrieve resources associated with a specific project identified by its UUID

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	UUID of the project whose resources are to be retrieved
adminView	adminView		boolean
excludeProcesses	excludeProcesses		boolean
excludeTables	excludeTables		boolean
onlyDeleted	onlyDeleted		boolean
projectPermissions	projectPermissions		boolean
typeId	typeId		string

Returns

Name	Path	Type	Description
data	data	array of object
name	data.name	string	Name of the resource
process	data.process	PermissionedProcess
table	data.table	SimpleDocumentTable
type	data.type	string	Type of the resource (process or table)
metadata	metadata	object

Get Project Secrets

Operation ID:: GetProjectSecrets

Retrieve all secrets for a specified project

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	The UUID of the project for which secrets are to be retrieved

Returns

Name	Path	Type	Description
data	data	array of ProjectSecret
metadata	metadata	object

Get Project Tables

Operation ID:: GetProjectTables

Retrieve tables associated with a specific project, identified by its UUID

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	The UUID of the project for which to retrieve tables

Returns

Name	Path	Type	Description
data	data	array of Table
metadata	metadata	object

Get Project Tags

Operation ID:: GetProjectTags

Retrieve all tags associated with a specified project

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	The UUID of the project for which tags are to be retrieved

Returns

Name	Path	Type
data	data	array of object
cells	data.cells	array of object
name	data.cells.column.name	string
publicId	data.cells.column.publicId	uuid
id	data.cells.id	string
value	data.cells.value	string
name	data.name	string
publicId	data.publicId	uuid
metadata	metadata	object

Get Project Variables

Operation ID:: GetProjectVariables

Retrieve all variables associated with a specified project

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	The UUID of the project for which variables are to be retrieved

Returns

Name	Path	Type
data	data	array of object
cells	data.cells	array of object
name	data.cells.column.name	string
publicId	data.cells.column.publicId	uuid
id	data.cells.id	string
value	data.cells.value	string
name	data.name	string
publicId	data.publicId	uuid
metadata	metadata	object

Get Resource Permissions

Operation ID:: GetResourcePermissions

Retrieve permissions for a specified resource, such as a table, table view, or process.

Parameters

Name	Key	Required	Type	Description
Resource	resource	True	string	The kind of resource for which to retrieve permissions. Valid options are 'process', 'table', or 'table_view'.
Resource Id	resource_id	True	uuid	UUID of the resource for which to retrieve permissions.

Returns

Name	Path	Type	Description
data	data	array of AccessPolicy
metadata	metadata	object

Get Sent Notifications for a Project

Operation ID:: GetProjectSentNotifications

Retrieve all sent notifications for a specified project

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	The UUID of the project for which sent notifications are to be retrieved
Page	page		integer	Page number of the notification executions
Size	size		integer	Number of notification executions per page
Notification Id	notification_id		uuid	UUID of a specific notification to filter the executions

Returns

Name	Path	Type	Description
data	data	array of NotificationExecution
metadata	metadata	object

Get Specific User Details

Operation ID:: GetUser

Get information on a specific user

Parameters

Name	Key	Required	Type	Description
Firebase Id	firebase_id	True	string	Firebase ID of the user to retrieve

Returns

Name	Path	Type	Description
data	data	User
metadata	metadata	object	Metadata object

Get stats on table columns

Operation ID:: GetTableViewStats

Retrieve statistical data for columns in a specific table view.

Parameters

Name	Key	Required	Type	Description
View Id	view_id	True	uuid	The UUID of the table view for which stats are to be retrieved.
Filter	filter		string	Filters to apply to the statistical data retrieval.
Sum, avg, max, min, count	sum, avg, max, min, count		array	Specify columns to perform sum, average, max, min, or count operations.
Process Id	process_id		uuid	Optional UUID of a process to filter the data.

Returns

Name	Path	Type	Description
data	data	array of TableColumnWithAggregation
metadata	metadata	object

Get Table and Its Rows

Operation ID:: GetTable

Retrieve a table and its rows based on provided parameters

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table to retrieve
Page	page		integer	Page number for pagination
Size	size		integer	Number of items per page for pagination
Sort	sort		string	Sorting criteria for the table rows
Filter	filter		string	Filter criteria for the table rows
Last Updated At	last_updated_at		date-time	Filter for rows updated after this date
Last Created At	last_created_at		date-time	Filter for rows created after this date
Next Page Token	next_page_token		string	Token for fetching the next page of results
Columns	columns		array	Specific columns to include in the response
Distinct Columns	distinct_columns		array	Columns to apply distinct filtering

Returns

Name	Path	Type	Description
data	data	Table
page	metadata.page	integer	Current page number
size	metadata.size	integer	Number of items per page
total	metadata.total	integer	Total number of rows in the table

Get Table Column Statistics

Operation ID:: GetTableColumnStats

Retrieve statistics for table columns based on specified parameters.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table for which statistics are being retrieved
Aggregation	aggregation		string	Aggregation functions to apply on columns
Filter	filter		string	Filter criteria for the columns

Returns

Name	Path	Type	Description
data	data	array of TableColumnWithAggregation
metadata	metadata	object

Get Table Columns

Operation ID:: GetTableColumns

Retrieve all active columns of a specific table.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table whose columns are to be retrieved

Returns

Name	Path	Type	Description
data	data	array of TableColumn
metadata	metadata	object

Get Table Rows

Operation ID:: GetTableRows

Retrieve rows from a table based on provided query parameters.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table from which rows are to be retrieved
Page	page		integer	Page number for pagination
Size	size		integer	Number of items per page for pagination
Sort	sort		string	Sorting criteria for the table rows
Filter	filter		string	Filter criteria for the table rows
Last Updated At	last_updated_at		date-time	Filter for rows updated after this date
Last Created At	last_created_at		date-time	Filter for rows created after this date
Next Page Token	next_page_token		string	Token for fetching the next page of results
Columns	columns		array	Specific columns to include in the response
Distinct Columns	distinct_columns		array	Columns to apply distinct filtering

Returns

Name	Path	Type
data	data	array of object
publicId	data.publicId	string
rowData	data.rowData	object
sortOrder	data.sortOrder	number
next_page_token	metadata.next_page_token	string
page	metadata.page	integer
size	metadata.size	integer
total	metadata.total	integer

Get Tag by Public ID

Operation ID:: GetTagByPublicId

Retrieve a tag by its public ID.

Parameters

Name	Key	Required	Type	Description
Tag Public ID	tag_id	True	string	Public ID of the tag to retrieve.

Returns

Name	Path	Type	Description
data	data	Tag
metadata	metadata	object

Get the unique values for a column

Operation ID:: GetTableViewDistinctValues

Retrieve the unique/distinct values for a specific column in a table view.

Parameters

Name	Key	Required	Type	Description
View Id	view_id	True	uuid	The UUID of the table view.
Column Id	column_id	True	uuid	The UUID of the column for which distinct values are to be retrieved.
Filter	filter		string	Filters to apply to the data retrieval.
Group Columns	group_columns		array	Optional columns to group the distinct values.

Returns

Name	Path	Type	Description
data	data	array of string
metadata	metadata	object

Get Unique Values for a Column

Operation ID:: GetDistinctValuesForColumn

Retrieve a list of distinct (unique) values for a specified column in a table.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table containing the column
Column Id	column_id	True	uuid	UUID of the column for which to retrieve distinct values
Filter	filter		string	Filter criteria for the distinct values
Group Columns	group_columns		array	Specify columns for grouping values

Returns

Name	Path	Type	Description
data	data	array of string
metadata	metadata	object

Get User's Favourite Projects

Operation ID:: GetFavouriteProjects

Get all favourite projects the currently logged in user is part of

Returns

Name	Path	Type	Description
data	data	array of object
isDeleted	data.isDeleted	boolean	Indicates if the project is deleted
name	data.name	string	Name of the project
projectRole	data.projectRole	string	User's role in the project
publicId	data.publicId	uuid	Public ID of the project
metadata	metadata	object	Additional metadata

Get User's Owned and Administered Projects

Operation ID:: GetUserOwnerProjects

Get all projects where the user is the owner or an admin

Returns

Name	Path	Type	Description
data	data	array of HomeProject
metadata	metadata	object	Additional metadata

Get User's Pinned Projects

Operation ID:: GetUserPinnedProjects

Get the projects pinned by a user identified by their Firebase ID

Parameters

Name	Key	Required	Type	Description
Firebase Id	firebase_id	True	string	Firebase ID of the user whose pinned projects are to be retrieved

Returns

Name	Path	Type	Description
data	data	array of object
contributors	data.contributors	integer	Number of contributors to the project
name	data.name	string	Name of the project
primaryColour	data.primaryColour	string	Primary colour of the project
publicId	data.publicId	uuid	Public ID of the project
views	data.views	integer	Number of views of the project
metadata	metadata	object	Metadata object

Get User's Public Contributions

Operation ID:: GetUserPublicContributions

Get the public contributions made by a user, identified by their Firebase ID

Parameters

Name	Key	Required	Type	Description
Firebase Id	firebase_id	True	string	Firebase ID of the user whose public contributions are to be retrieved

Returns

Name	Path	Type	Description
data	data	array of Event
metadata	metadata	object	Metadata object

Get User's Public Projects

Operation ID:: GetUserPublicProjects

Get all public projects where the user is a member

Returns

Name	Path	Type	Description
data	data	array of HomeProject
metadata	metadata	object	Additional metadata

Get User Achievements

Operation ID:: GetUserAchievements

Get the achievement badges of a user by their Firebase ID

Parameters

Name	Key	Required	Type	Description
Firebase Id	firebase_id	True	string	Firebase ID of the user whose achievements are to be retrieved

Returns

Name	Path	Type	Description
createdProcesses	data.createdProcesses	integer	Number of processes created by the user
createdTables	data.createdTables	integer	Number of tables created by the user
metadata	metadata	object	Metadata object

Get User Contributions

Operation ID:: GetUserContributions

Get the number of contributions per day made by a user, identified by their Firebase ID

Parameters

Name	Key	Required	Type	Description
Firebase Id	firebase_id	True	string	Firebase ID of the user whose contributions are to be retrieved

Returns

Name	Path	Type	Description
data	data	object	Contributions per day, keyed by date
metadata	metadata	object	Metadata object

Get User Details by Public ID

Operation ID:: GetUserByPublicId

Get information on a specific user by their public ID

Parameters

Name	Key	Required	Type	Description
Public Id	public_id	True	uuid	Public UUID of the user to retrieve

Returns

Name	Path	Type	Description
data	data	User
metadata	metadata	object	Metadata object

Get User Projects

Operation ID:: GetUserProjects

Get all projects the currently logged in user is part of

Returns

Name	Path	Type	Description
data	data	array of HomeProject
metadata	metadata	object	Additional metadata

Get User Templates

Operation ID:: GetUserTemplates

Get all templates the currently logged in user has access to

Returns

Name	Path	Type
data	data	array of object
createdBy	data.createdBy	SummaryUser
metadata	metadata	object

Invite a User to a Project

Operation ID:: InviteUserToProject

Invite a single user to join a project by email. If the user already exists, they are added directly; otherwise, an invite is sent. Requires owner or admin permissions.

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	The UUID of the project to which the user is being invited
email	email	True	email
tags	tags		array of string

Returns

Name	Path	Type	Description
data	data	string
metadata	metadata	object

Invite Multiple Users to a Project

Operation ID:: InviteMultipleUsersToProject

Invite multiple users to join a project, by email. If users already exist, they are added directly, otherwise, an invite is sent. Requires owner or admin permissions.

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	The UUID of the project to which users are being invited
emails	emails		array of email
tags	tags		array of string

Returns

Name	Path	Type	Description
data	data	string
metadata	metadata	object

Preview resulting row from inputs

Operation ID:: PreviewTableRowInView

Preview the resulting row from given inputs in a specific table view.

Parameters

Name	Key	Required	Type	Description
View Id	view_id	True	uuid	The UUID of the table view for which the row preview is generated.
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
rowData	rowData	True	object

Returns

Name	Path	Type
publicId	data.publicId	string
rowData	data.rowData	object
sortOrder	data.sortOrder	number
metadata	metadata	object

Reopen Comment Thread

Operation ID:: ReopenCommentThread

Reopen a previously resolved comment thread

Parameters

Name	Key	Required	Type	Description
Comment Thread Id	comment_thread_id	True	uuid	UUID of the comment thread to reopen

Returns

Name	Path	Type	Description
data	data	CommentThread
change	metadata.change	object	Changes made to the comment thread
event	metadata.event	string	Event type for the operation
resourceId	metadata.resourceId	string	UUID of the reopened comment thread

Request Permissions for a Resource

Operation ID:: RequestResourcePermissions

Request permissions for a specific resource (such as a table, table view, or process).

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	UUID of the project that the resource belongs to.
Type	type	True	string	The kind of resource for which to request permissions. Valid options are 'project', 'process', 'table', or 'view'.
Id	id	True	uuid	UUID of the resource for which to request permissions.

Resend an Invite to a User for a Project

Operation ID:: ResendInviteToUserForProject

Resend an invitation to a user for a project. This is applicable for both new users and existing users who have previously been invited. Requires owner or admin permissions.

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	The UUID of the project for which the invite is being resent
Invite Id	invite_id	True	uuid	The UUID of the invite to be resent

Returns

Name	Path	Type	Description
data	data	string
metadata	metadata	object

Reset Process Response

Operation ID:: ResetProcessResponse

Reset an existing process response to its initial state.

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process.
Process Section Id	process_section_id	True	uuid	The UUID of the process section.
Process Response Id	process_response_id	True	uuid	The UUID of the process response to be reset.

Returns

Name	Path	Type	Description
data	data	MortaProcessSection
metadata	metadata	object

Resolve Comment Thread

Operation ID:: ResolveCommentThread

Resolve a comment thread

Parameters

Name	Key	Required	Type	Description
Comment Thread Id	comment_thread_id	True	uuid	UUID of the comment thread to resolve

Returns

Name	Path	Type	Description
data	data	CommentThread
change	metadata.change	object	Changes made to the comment thread
event	metadata.event	string	Event type for the operation
resourceId	metadata.resourceId	string	UUID of the resolved comment thread

Restore a deleted table

Operation ID:: RestoreTable

Restore a previously deleted table using its UUID.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table to be restored

Returns

Name	Path	Type	Description
data	data	Table
metadata	metadata	object

Restore a Project

Operation ID:: RestoreProject

Restore a specific project, identified by its UUID, that has been previously deleted

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	UUID of the project to be restored

Returns

Name	Path	Type	Description
data	data	string
metadata	metadata	object

Restore Process

Operation ID:: RestoreProcess

Restore a deleted process identified by its UUID

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process to restore

Returns

Name	Path	Type	Description
data	data	MortaProcess
metadata	metadata	object

Restore Process Response

Operation ID:: RestoreProcessResponse

Restore a previously deleted process response.

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process.
Process Section Id	process_section_id	True	uuid	The UUID of the process section.
Process Response Id	process_response_id	True	uuid	The UUID of the process response to be restored.

Returns

Name	Path	Type	Description
data	data	ProcessResponse
metadata	metadata	object

Restore Process Section

Operation ID:: RestoreProcessSection

Restore a previously deleted process section.

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process.
Process Section Id	process_section_id	True	uuid	The UUID of the process section to be restored.

Returns

Name	Path	Type	Description
data	data	MortaProcessSection
metadata	metadata	object

Restore Table Column

Operation ID:: RestoreTableColumn

Restore a previously deleted column in a table.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table containing the column to be restored
Column Id	column_id	True	uuid	UUID of the column to be restored

Returns

Name	Path	Type	Description
data	data	TableColumn
metadata	metadata	object

Retrieve Deleted Processes within a Project

Operation ID:: GetProjectDeletedProcesses

Get all deleted processes associated with a specific project, identified by its UUID

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	UUID of the project for which deleted processes are to be retrieved

Returns

Name	Path	Type	Description
data	data	array of SimpleProcess
metadata	metadata	object

Retrieve Processes within a Project

Operation ID:: GetProjectProcesses

Get all processes associated with a specific project, identified by its UUID

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	UUID of the project for which processes are to be retrieved

Returns

Name	Path	Type	Description
data	data	array of SimpleProcess
metadata	metadata	object

Search for Users

Operation ID:: SearchUsers

Search for users by project or process

Parameters

Name	Key	Required	Type	Description
Project Id	project_id		uuid	Project ID to restrict search
Process Id	process_id		uuid	Process ID to restrict search
Table View Id	table_view_id		uuid	Table View ID to restrict search
Query	query	True	string	Query string for searching users

Returns

Name	Path	Type	Description
data	data	array of SummaryUser
metadata	metadata	object	Additional metadata

Search within a Project

Operation ID:: SearchProject

Perform a search operation within a specific project, identified by its UUID

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	UUID of the project where the search is to be performed
Search	search	True	string	Search query string
Process Public Id	process_public_id		uuid	Optional UUID of a process to restrict the search within a specific process

Returns

Name	Path	Type	Description
data	data	Answer
metadata	metadata	object

Set the view as the default view

Operation ID:: SetTableViewAsDefault

Designate a specific table view as the default view for the table.

Parameters

Name	Key	Required	Type	Description
View Id	view_id	True	uuid	The UUID of the table view to be set as the default.

Returns

Name	Path	Type	Description
data	data	TableView
metadata	metadata	object

Stream all rows for the table

Operation ID:: StreamTableRows

Stream the data of all rows for a specific table.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table to stream rows from.
Filter	filter		string	Filters to apply to the streaming data.
Sort	sort		string	Sorting parameters for the streaming data.
Page	page		integer	Page number for pagination
Size	size		integer	Number of items per page for pagination

Returns

response: binary

Stream all rows for the view

Operation ID:: StreamTableViewRows

Stream the data of all rows for a specific table view.

Parameters

Name	Key	Required	Type	Description
View Id	view_id	True	uuid	The UUID of the table view for which data streaming is requested.
Filter	filter		string	Filters to apply to the streaming data.
Sort	sort		string	Sorting parameters for the streaming data.
Process Id	process_id		uuid	Optional UUID of a process to filter the data.
Page	page		integer	Page number for pagination
Size	size		integer	Number of items per page for pagination

Returns

response: binary

Submit Process Response

Operation ID:: SubmitProcessResponse

Submit a process response, marking it as completed.

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process.
Process Section Id	process_section_id	True	uuid	The UUID of the process section.
Process Response Id	process_response_id	True	uuid	The UUID of the process response to be submitted.
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
response	response

Returns

Name	Path	Type	Description
data	data	MortaProcessSection
metadata	metadata	object

Submit Process Response Draft

Operation ID:: SubmitProcessResponseDraft

Submit a draft of a process response for later completion.

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process.
Process Section Id	process_section_id	True	uuid	The UUID of the process section.
Process Response Id	process_response_id	True	uuid	The UUID of the process response to submit as a draft.
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
response	response

Returns

Name	Path	Type	Description
data	data	ProcessSection
metadata	metadata	object

Sync Table with Integration

Operation ID:: SyncTableWithIntegration

Sync a table with a specified integration.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table to sync.
Integration Name	integration_name	True	string	Name of the integration to sync with.
companyId	companyId		string
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
enterpriseId	enterpriseId		string
folderId	folderId		string
hubId	hubId		string
licenseId	licenseId		string
projectId	projectId		string
projectIds	projectIds		array of string
topFolderId	topFolderId		string
type	type		string

Returns

Name	Path	Type	Description
data	data	string
metadata	metadata	object

Toggle Favourite Status of a Project

Operation ID:: ChangeUserFavourite

Change whether the project is a favourite for the currently logged in user

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	Public ID of the project to toggle favourite status

Returns

Name	Path	Type	Description
data	data	array of object
isDeleted	data.isDeleted	boolean	Indicates if the project is deleted
name	data.name	string	Name of the project
projectRole	data.projectRole	string	User's role in the project
publicId	data.publicId	uuid	Public ID of the project
metadata	metadata	object	Additional metadata

Toggle Pin Status of a Project

Operation ID:: ChangeUserPin

Change whether the project is pinned for the currently logged in user

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	Public ID of the project to toggle pin status

Returns

Name	Path	Type	Description
data	data	array of object
contributors	data.contributors	integer	Number of contributors to the project
name	data.name	string	Name of the project
primaryColour	data.primaryColour	string	Primary colour of the project
publicId	data.publicId	uuid	Public ID of the project
views	data.views	integer	Number of views of the project
metadata	metadata	object	Additional metadata

Update a Project Invite

Operation ID:: UpdateProjectInvite

Update an existing invite in a project

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	The UUID of the project in which the invite is located
Invite Id	invite_id	True	uuid	The UUID of the invite to be updated
tags	tags		array of string

Returns

Name	Path	Type	Description
data	data	InvitedMember
metadata	metadata	object

Update a Project Secret

Operation ID:: UpdateProjectSecret

Update a specific secret in a project

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	The UUID of the project where the secret is located
Secret Id	secret_id	True	uuid	The UUID of the secret to be updated
name	name	True	string
value	value	True	string

Returns

Name	Path	Type	Description
data	data	ProjectSecret
metadata	metadata	object

Update a single notification

Operation ID:: UpdateNotification

Update a specific notification by its ID.

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	The UUID of the notification to be updated.
description	description		string
processes	processes		array of uuid
tables	tables		array of uuid
publicId	publicId		uuid
resource	resource	True	string
verb	verb	True	string
webhookUrl	webhookUrl	True	string

Returns

Name	Path	Type	Description
data	data	Notification
metadata	metadata	object

Update a view for a table

Operation ID:: UpdateTableView

Update an existing view for a specific table.

Parameters

Name	Key	Required	Type	Description
View Id	view_id	True	uuid	The UUID of the table view to be updated.
allowContributorDelete	allowContributorDelete		boolean
chartSettings	chartSettings
collapsedGroupView	collapsedGroupView		boolean
backgroundColour	backgroundColour	True	string
columnId	columnId		uuid
columnName	columnName	True	string
filterType	filterType	True	string
fontColour	fontColour	True	string
multipleValues	multipleValues		array of
value	value
aconexSynced	aconexSynced		integer
aggregate	aggregate		integer
alterOptions	alterOptions
autodeskBim360Synced	autodeskBim360Synced		integer
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
dateFormat	dateFormat		string
decimalPlaces	decimalPlaces		integer
description	description
hardValidation	hardValidation		boolean
isIndexed	isIndexed		boolean
isJoined	isJoined		boolean
kind	kind		string
manualOptions	manualOptions		array of string
tableOptions	tableOptions
locked	locked		boolean
mortaSynced	mortaSynced		integer
name	name		string
procoreSynced	procoreSynced		integer
publicId	publicId		uuid
required	required		boolean
reviztoIssuesSynced	reviztoIssuesSynced		integer
script	script		string
scriptEnabled	scriptEnabled		boolean
sortOrder	sortOrder		number
stringValidation	stringValidation		string
thousandSeparator	thousandSeparator		boolean
validationMessage	validationMessage		string
validationNoBlanks	validationNoBlanks		boolean
validationNoDuplicates	validationNoDuplicates		boolean
viewpointSynced	viewpointSynced		integer
width	width		integer
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
description	description
disableNewRow	disableNewRow		boolean
displayCommentRows	displayCommentRows		integer
displayValidationErrorRows	displayValidationErrorRows		integer
columnId	columnId		uuid
columnName	columnName	True	string
filterType	filterType	True	string
multipleValues	multipleValues		array of
orGroup	orGroup		string
value	value
frozenIndex	frozenIndex		integer
columnId	columnId		uuid
columnName	columnName	True	string
direction	direction	True	string
name	name		string
rowHeight	rowHeight		integer
columnId	columnId		uuid
columnName	columnName	True	string
direction	direction	True	string
type	type		integer
unpackMultiselectGroupView	unpackMultiselectGroupView		boolean

Returns

Name	Path	Type	Description
data	data	TableView
metadata	metadata	object

Update an Existing Process

Operation ID:: UpdateProcess

Update an existing process's details by process ID

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process to update
allowComments	allowComments		boolean
allowDuplication	allowDuplication		boolean
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
description	description
expandByDefault	expandByDefault		boolean
isTemplate	isTemplate		boolean
logo	logo		string
name	name		string
plaintextDescription	plaintextDescription		string
templateCategory	templateCategory		string
type	type		string
variables	variables		array of string

Returns

Name	Path	Type	Description
data	data	SimpleProcess
metadata	metadata	object

Update an Existing Process Section

Operation ID:: UpdateProcessSection

Update an existing process section's details by process section ID

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process.
Process Section Id	process_section_id	True	uuid	The UUID of the process section to update.
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
description	description
name	name		string
pageBreakBefore	pageBreakBefore		boolean
pdfIncludeDescription	pdfIncludeDescription		boolean
pdfIncludeSection	pdfIncludeSection		boolean
plaintextDescription	plaintextDescription		string

Returns

Name	Path	Type	Description
data	data	MortaProcessSection
metadata	metadata	object

Update an Existing Project

Operation ID:: UpdateProject

Update an existing project's details by project ID

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	The UUID of the project to update
defaultProcessId	defaultProcessId		uuid
hideProcessCreated	hideProcessCreated		boolean
logo	logo		string
mfaRequired	mfaRequired		boolean
name	name		string
primaryColour	primaryColour		string
processTitleBold	processTitleBold		boolean
processTitleColour	processTitleColour		string
processTitleFontSize	processTitleFontSize		number
processTitleItalic	processTitleItalic		boolean
processTitleUnderline	processTitleUnderline		boolean
public	public		boolean

Returns

Name	Path	Type	Description
data	data	SimpleProject
metadata	metadata	object

Update API Key

Operation ID:: UpdateApiKey

Update an API key for the currently logged in user

Parameters

Name	Key	Required	Type	Description
Api Key Id	api_key_id	True	uuid	The UUID of the API key to update
name	name		string

Returns

Name	Path	Type	Description
apiKey	apiKey	string	Updated API key details

Update column on view

Operation ID:: UpdateColumnOnTableView

Update a specific column in a table view.

Parameters

Name	Key	Required	Type	Description
View Id	view_id	True	uuid	The UUID of the table view containing the column to be updated.
Column Id	column_id	True	uuid	The UUID of the column in the table view to be updated.
aconexSynced	aconexSynced		integer
aggregate	aggregate		integer
alterOptions	alterOptions
autodeskBim360Synced	autodeskBim360Synced		integer
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
dateFormat	dateFormat		string
decimalPlaces	decimalPlaces		integer
description	description
hardValidation	hardValidation		boolean
isIndexed	isIndexed		boolean
isJoined	isJoined		boolean
kind	kind		string
manualOptions	manualOptions		array of string
tableOptions	tableOptions
locked	locked		boolean
mortaSynced	mortaSynced		integer
name	name		string
procoreSynced	procoreSynced		integer
publicId	publicId		uuid
required	required		boolean
reviztoIssuesSynced	reviztoIssuesSynced		integer
script	script		string
scriptEnabled	scriptEnabled		boolean
sortOrder	sortOrder		number
stringValidation	stringValidation		string
thousandSeparator	thousandSeparator		boolean
validationMessage	validationMessage		string
validationNoBlanks	validationNoBlanks		boolean
validationNoDuplicates	validationNoDuplicates		boolean
viewpointSynced	viewpointSynced		integer
width	width		integer

Returns

Name	Path	Type	Description
data	data	TableViewColumn
metadata	metadata	object

Update Comment

Operation ID:: UpdateComment

Update a specific comment within a comment thread

Parameters

Name	Key	Required	Type	Description
Comment Thread Id	comment_thread_id	True	uuid	UUID of the comment thread containing the comment
Comment Id	comment_id	True	uuid	UUID of the comment to be updated
commentText	commentText	True	string
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid

Returns

Name	Path	Type	Description
data	data	Comment
change	metadata.change	object	Changes made to the comment
event	metadata.event	string	Event type for the operation
resourceId	metadata.resourceId	string	UUID of the updated comment

Update Current User Profile

Operation ID:: UpdateCurrentUser

Update the profile of the currently logged in user

Parameters

Name	Key	Type
bio	bio	string
linkedin	linkedin	string
location	location	string
name	name	string
organisation	organisation	string
profilePicture	profilePicture	string
signature	signature	string
twitter	twitter	string
university	university	string
universityDegree	universityDegree	string
website	website	string

Returns

Name	Path	Type	Description
data	data	User
metadata	metadata	object

Update Existing Process Response

Operation ID:: UpdateProcessResponse

Update an existing response for a process section.

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process.
Process Section Id	process_section_id	True	uuid	The UUID of the process section.
Process Response Id	process_response_id	True	uuid	The UUID of the process response to be updated.
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
dueDate	dueDate		date-time
expireResponse	expireResponse		boolean
pdfIncludeResponse	pdfIncludeResponse		boolean
resetAfterResponse	resetAfterResponse		boolean
responders	responders		array of string
type	type		string
typeOptions	typeOptions

Returns

Name	Path	Type	Description
data	data	MortaProcessResponse
metadata	metadata	object

Update existing rows

Operation ID:: UpdateTableRowsInView

Update existing rows in a specified table view.

Parameters

Name	Key	Required	Type	Description
View Id	view_id	True	uuid	The UUID of the table view where rows are to be updated.
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
publicId	publicId	True	uuid
rowData	rowData	True	object
sortOrder	sortOrder		number

Returns

Name	Path	Type
data	data	array of object
publicId	data.publicId	string
rowData	data.rowData	object
sortOrder	data.sortOrder	number
metadata	metadata	object

Update Existing Rows in Table

Operation ID:: UpdateTableRows

Update existing rows in the specified table.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table where rows will be updated
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
publicId	publicId	True	uuid
rowData	rowData	True	object
sortOrder	sortOrder		number

Returns

Name	Path	Type
data	data	array of object
publicId	data.publicId	string
rowData	data.rowData	object
sortOrder	data.sortOrder	number
metadata	metadata	object

Update existing table

Operation ID:: UpdateTable

Update the properties of an existing table.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table to update
allowDuplication	allowDuplication		boolean
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
sourceColumnId	sourceColumnId		string
targetColumnId	targetColumnId		string
isOneToMany	isOneToMany		boolean
sourceColumnId	sourceColumnId		string
targetColumnId	targetColumnId		string
joinTableName	joinTableName		string
joinViewId	joinViewId		string
joinViewName	joinViewName		string
publicId	publicId		uuid
keepColoursInSync	keepColoursInSync		boolean
keepValidationsInSync	keepValidationsInSync		boolean
logo	logo		string
name	name		string
syncHourlyFrequency	syncHourlyFrequency		integer
type	type		string
variables	variables		array of string

Returns

Name	Path	Type	Description
data	data	Table
metadata	metadata	object

Update existing table cells

Operation ID:: UpdateDocumentTableCellsInView

Update specific cells in a table view.

Parameters

Name	Key	Required	Type	Description
View Id	view_id	True	uuid	The UUID of the table view where cells are to be updated.
columnName	columnName	True	string
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
rowId	rowId	True	string
value	value
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid

Returns

Name	Path	Type
data	data	array of object
publicId	data.publicId	string
rowData	data.rowData	object
sortOrder	data.sortOrder	number
metadata	metadata	object

Update Multiple Process Sections

Operation ID:: UpdateMultipleProcessSections

Update multiple existing process sections.

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process.
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
description	description
name	name		string
pageBreakBefore	pageBreakBefore		boolean
pdfIncludeDescription	pdfIncludeDescription		boolean
pdfIncludeSection	pdfIncludeSection		boolean
plaintextDescription	plaintextDescription		string
publicId	publicId	True	uuid

Returns

Name	Path	Type	Description
data	data	array of MortaProcessSection
metadata	metadata	object

Update Permissions for a Resource

Operation ID:: UpdateResourcePermissions

Update permissions for a specific resource (such as a table, table view, or process).

Parameters

Name	Key	Required	Type	Description
Id	id	True	uuid	UUID of the policy to update.
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
role	role	True	integer

Returns

Name	Path	Type	Description
data	data	AccessPolicy
metadata	metadata	object

Update Process Responders

Operation ID:: UpdateProcessResponders

Update the list of responders for a given process identified by its UUID

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process whose responders are to be updated
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
responders	responders		array of string

Returns

Name	Path	Type	Description
data	data	MortaProcess
metadata	metadata	object

Update Process Section Order

Operation ID:: UpdateProcessSectionOrder

Update the order of process sections within a process.

Parameters

Name	Key	Required	Type	Description
Process Id	process_id	True	uuid	The UUID of the process.
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
parentId	parentId		uuid
position	position		integer
sectionId	sectionId		uuid

Returns

Name	Path	Type	Description
data	data	MortaProcess
metadata	metadata	object

Update Project Heading Styling

Operation ID:: UpdateProjectHeadingStyling

Update heading styling for a specific project

Parameters

Name	Key	Required	Type	Description
Project Id	project_id	True	uuid	The UUID of the project for which to update the heading styling
Style Id	style_id	True	uuid	The UUID of the style to be updated
bold	bold		boolean
colour	colour		string
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
fontSize	fontSize		number
italic	italic		boolean
numberingStyle	numberingStyle		integer
startAt0	startAt0		boolean
underline	underline		boolean

Returns

Name	Path	Type	Description
data	data	SimpleProject
metadata	metadata	object

Update Table Cells

Operation ID:: UpdateTableCells

Update specific cells in a table.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table containing the cells to be updated.
columnName	columnName	True	string
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
rowId	rowId	True	string
value	value
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid

Returns

Name	Path	Type	Description
data	data	string
metadata	metadata	object

Update Table Column

Operation ID:: UpdateTableColumn

Update the properties of a specific column in a table.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table containing the column
Column Id	column_id	True	uuid	UUID of the column to update
aconexSynced	aconexSynced		integer
aggregate	aggregate		integer
alterOptions	alterOptions
autodeskBim360Synced	autodeskBim360Synced		integer
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
dateFormat	dateFormat		string
decimalPlaces	decimalPlaces		integer
description	description
isIndexed	isIndexed		boolean
kind	kind		string
manualOptions	manualOptions		array of string
tableOptions	tableOptions
mortaSynced	mortaSynced		integer
name	name	True	string
procoreSynced	procoreSynced		integer
publicId	publicId		uuid
reviztoIssuesSynced	reviztoIssuesSynced		integer
script	script		string
scriptEnabled	scriptEnabled		boolean
thousandSeparator	thousandSeparator		boolean
viewpointSynced	viewpointSynced		integer
width	width		integer

Returns

Name	Path	Type	Description
data	data	TableColumn
metadata	metadata	object

Update Table Join

Operation ID:: UpdateTableJoin

Update an existing join on a table.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table with the join to be updated.
Join Id	join_id	True	uuid	UUID of the join to be updated.
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
dataColumns	dataColumns		array of string
isOneToMany	isOneToMany		boolean
sourceColumnId	sourceColumnId		string
targetColumnId	targetColumnId		string
joinViewId	joinViewId		string

Returns

Name	Path	Type	Description
data	data	Table
metadata	metadata	object

Update User Account

Operation ID:: UpdateUserAccount

Update the account details for the currently logged in user

Parameters

Name	Key	Required	Type
oldPassword	oldPassword	True	string
password	password	True	string
passwordConfirm	passwordConfirm	True	string
twoFactorCode	twoFactorCode		string

Returns

Name	Path	Type	Description
data	data	UserWithToken
metadata	metadata	object

Upsert Row in Table

Operation ID:: UpsertTableRows

Add or update a row in the specified table based on a unique column value.

Parameters

Name	Key	Required	Type	Description
Table Id	table_id	True	uuid	UUID of the table to upsert the row
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
processPublicId	processPublicId		uuid
processResponsePublicId	processResponsePublicId		uuid
processSectionPublicId	processSectionPublicId		uuid
projectId	projectId		uuid
rowData	rowData	True	object
sortOrder	sortOrder		number
upsertColumnName	upsertColumnName	True	string

Returns

Name	Path	Type
data	data	array of object
publicId	data.publicId	string
rowData	data.rowData	object
sortOrder	data.sortOrder	number
metadata	metadata	object

Definitions

AccessAttribute

Name	Path	Type
documentTable	documentTable	Table3
kind	kind	string
project	project	Project
publicId	publicId	uuid
tag	tag	Tag
user	user	User3

AccessPolicy

Name	Path	Type
accessAttribute	accessAttribute	AccessAttribute
accessResource	accessResource	AccessResource
publicId	publicId	uuid
role	role	integer
roleLabel	roleLabel	string

AccessResource

Name	Path	Type
documentTable	documentTable	Table3
kind	kind	string
process	process	Process
publicId	publicId	uuid

Action

Name	Path	Type
kind	kind	string
publicId	publicId	uuid
webhookUrl	webhookUrl	string

Answer

Name	Path	Type	Description
answers	answers	array of SearchProjectAnswerResources
resources	resources	array of SearchProjectResources

ApiKey

Name	Path	Type
hash	hash	string
name	name	string
prefix	prefix	string
publicId	publicId	uuid

Chart

Name	Path	Type
chartType	chartType	string
columnLabelId	columnLabelId	uuid
columnValueId	columnValueId	uuid
showLegend	showLegend	boolean
showValues	showValues	boolean

Colour

Name	Path	Type
backgroundColour	backgroundColour	string
columnId	columnId	uuid
columnName	columnName	string
filterType	filterType	string
fontColour	fontColour	string
multipleValues	multipleValues	array of
value	value

Comment

Name	Path	Type
commentText	commentText	string
createdAt	createdAt	date-time
deletedAt	deletedAt	date-time
isOwner	isOwner
publicId	publicId	uuid
updatedAt	updatedAt	date-time
user	user	SummaryUser

CommentThread

Name	Path	Type
comments	comments	array of Comment
createdAt	createdAt	date-time
deletedAt	deletedAt	date-time
isCommentInitiator	isCommentInitiator
publicId	publicId	uuid
resolvedAt	resolvedAt	date-time
resolver	resolver	User1
updatedAt	updatedAt	date-time

CommentThreadStats

Name	Path	Type
openCommentThreads	openCommentThreads	integer
referenceId	referenceId	uuid
resolvedCommentThreads	resolvedCommentThreads	integer

Draftjs

Name	Path	Type	Description
content	content	DraftjsContent

DraftjsBlock

Name	Path	Type
data	data
depth	depth	integer
entityRanges	entityRanges	array of
inlineStyleRanges	inlineStyleRanges	array of
key	key	string
text	text	string
type	type	string

DraftjsContent

Name	Path	Type	Description
blocks	blocks	array of DraftjsBlock
entityMap	entityMap

Event

Name	Path	Type
change	change
changeId	changeId	string
context	context
contextProcessId	contextProcessId	integer
contextProcessResponseId	contextProcessResponseId	integer
contextProcessSectionId	contextProcessSectionId	integer
contextTableColumnId	contextTableColumnId	integer
contextTableId	contextTableId	integer
contextTableViewId	contextTableViewId	integer
createdAt	createdAt	date-time
projectId	projectId	integer
publicId	publicId	uuid
resource	resource	string
resourcePublicId	resourcePublicId	uuid
userId	userId	integer
verb	verb	string

Filter

Name	Path	Type
columnId	columnId	uuid
columnName	columnName	string
filterType	filterType	string
multipleValues	multipleValues	array of
orGroup	orGroup	string
value	value

Group

Name	Path	Type
columnId	columnId	uuid
columnName	columnName	string
direction	direction	string

HeadingStyle

Name	Path	Type
bold	bold	boolean
colour	colour	string
fontSize	fontSize	number
italic	italic	boolean
level	level	integer
numberingStyle	numberingStyle	integer
publicId	publicId	uuid
startAt0	startAt0	boolean
underline	underline	boolean

HomeProject

Name	Path	Type
deletedAt	deletedAt	date-time
hideProcessCreated	hideProcessCreated	boolean
isDeleted	isDeleted	boolean
mfaRequired	mfaRequired	boolean
name	name	string
primaryColour	primaryColour	string
publicId	publicId	string

IntegrationsPassthroughResponse

Name	Path	Type
body	body
contentType	contentType	string
headers	headers
status	status	string

InvitedMember

Name	Path	Type
createdAt	createdAt	date-time
email	email	string
invitedBy	invitedBy	SummaryUser
publicId	publicId	uuid
tags	tags	array of Tag

MortaProcess

Name	Path	Type
allowComments	allowComments	boolean
allowDuplication	allowDuplication	boolean
children	children	array of ProcessSection1
createdAt	createdAt	date-time
deletedAt	deletedAt	date-time
description	description
expandByDefault	expandByDefault	boolean
isDeleted	isDeleted	boolean
isTemplate	isTemplate	boolean
logo	logo	string
name	name	string
publicId	publicId	uuid
templateCategory	templateCategory	string
type	type	string
updatedAt	updatedAt	date-time
variableValues	variableValues	array of string
variables	variables	array of string

MortaProcessResponse

Name	Path	Type
approved	approved	boolean
createdAt	createdAt	date-time
deletedAt	deletedAt	date-time
dueDate	dueDate	date-time
expireResponse	expireResponse	boolean
isDeleted	isDeleted	boolean
pdfIncludeResponse	pdfIncludeResponse	boolean
position	position	integer
publicId	publicId	uuid
resetAfterResponse	resetAfterResponse	boolean
responders	responders	array of string
response	response
responseDate	responseDate	date-time
type	type	string
typeOptions	typeOptions
updatedAt	updatedAt	date-time
user	user	SummaryUser
userResponders	userResponders	array of SummaryUser

MortaProcessSection

Name	Path	Type
children	children	array of MortaProcessSection
createdAt	createdAt	date-time
deletedAt	deletedAt	date-time
description	description	Draftjs
isDeleted	isDeleted	boolean
name	name	string
openCommentThreads	openCommentThreads	integer
pageBreakBefore	pageBreakBefore	boolean
parentId	parentId	uuid
pdfIncludeDescription	pdfIncludeDescription	boolean
pdfIncludeSection	pdfIncludeSection	boolean
position	position	integer
publicId	publicId	uuid
responses	responses	array of ProcessResponse
status	status	integer

Notification

Name	Path	Type
actions	actions	array of Action
createdAt	createdAt	date-time
description	description	string
processes	processes	array of Process
publicId	publicId	uuid
tables	tables	array of Table1
triggers	triggers	array of Trigger
user	user	SummaryUser

Notification1

Name	Path	Type
actions	actions	array of Action
createdAt	createdAt	date-time
description	description	string
processes	processes	array of Process
publicId	publicId	uuid
tables	tables	array of Table1
triggers	triggers	array of Trigger

NotificationExecution

Name	Path	Type
createdAt	createdAt	date-time
description	description	string
isSuccess	isSuccess	boolean
notification	notification	Notification1
publicId	publicId	uuid
updatedAt	updatedAt	date-time

PermissionedProcess

Name	Path	Type
createdAt	createdAt	date-time
deletedAt	deletedAt	date-time
logo	logo	string
name	name	string
publicId	publicId	uuid
type	type	string
updatedAt	updatedAt	date-time

Process

Name	Path	Type	Description
name	name	string
publicId	publicId	uuid

ProcessResponse

Name	Path	Type
approved	approved	boolean
createdAt	createdAt	date-time
deletedAt	deletedAt	date-time
dueDate	dueDate	date-time
expireResponse	expireResponse	boolean
isDeleted	isDeleted	boolean
pdfIncludeResponse	pdfIncludeResponse	boolean
position	position	integer
publicId	publicId	uuid
resetAfterResponse	resetAfterResponse	boolean
responders	responders	array of string
response	response
responseDate	responseDate	date-time
type	type	string
typeOptions	typeOptions
updatedAt	updatedAt	date-time
user	user	SummaryUser
userResponders	userResponders	array of SummaryUser

ProcessSection

Name	Path	Type
name	name	string
publicId	publicId	uuid
status	status	integer

ProcessSection1

Name	Path	Type
children	children	array of ProcessSection1
createdAt	createdAt	date-time
deletedAt	deletedAt	date-time
description	description	Draftjs
isDeleted	isDeleted	boolean
name	name	string
openCommentThreads	openCommentThreads	integer
pageBreakBefore	pageBreakBefore	boolean
parentId	parentId	uuid
pdfIncludeDescription	pdfIncludeDescription	boolean
pdfIncludeSection	pdfIncludeSection	boolean
position	position	integer
publicId	publicId	uuid
responses	responses	array of ProcessResponse
status	status	integer

Project

Name	Path	Type	Description
name	name	string
publicId	publicId	string

ProjectList

Name	Path	Type
createdAt	createdAt	date-time
favourite	favourite	boolean
projectRole	projectRole	string
updatedAt	updatedAt	date-time
user	user	User4

ProjectListWithUserTags

Name	Path	Type
createdAt	createdAt	date-time
favourite	favourite	boolean
projectRole	projectRole	string
updatedAt	updatedAt	date-time
user	user	User2

ProjectSecret

Name	Path	Type
createdAt	createdAt	date-time
name	name	string
publicId	publicId	uuid
updatedAt	updatedAt	date-time
value	value	string

SearchProjectAnswerResources

Name	Path	Type
label	label	string
link	link	string
originalText	originalText	string
similarity	similarity	number
text	text	string

SearchProjectResources

Name	Path	Type
link	link	string
text	text	string
type	type	string

SelectOptionsLookup

Name	Path	Type	Description
manualOptions	manualOptions	array of string
tableOptions	tableOptions

SimpleDocumentTable

Name	Path	Type
createdAt	createdAt	date-time
defaultViewId	defaultViewId	string
deletedAt	deletedAt	date-time
isDeleted	isDeleted	boolean
joins	joins	array of TableJoin
logo	logo	string
name	name	string
publicId	publicId	uuid
type	type	string
updatedAt	updatedAt	date-time

SimpleProcess

Name	Path	Type
allowComments	allowComments	boolean
allowDuplication	allowDuplication	boolean
children	children	array of ProcessSection
createdAt	createdAt	date-time
deletedAt	deletedAt	date-time
description	description
expandByDefault	expandByDefault	boolean
isDeleted	isDeleted	boolean
isTemplate	isTemplate	boolean
logo	logo	string
name	name	string
publicId	publicId	uuid
templateCategory	templateCategory	string
type	type	string
updatedAt	updatedAt	date-time
variableValues	variableValues	array of string
variables	variables	array of string

SimpleProject

Name	Path	Type
adminLimit	adminLimit	integer
automationLimit	automationLimit	integer
createdAt	createdAt	date-time
defaultProcessId	defaultProcessId	string
deletedAt	deletedAt	date-time
headingStyles	headingStyles	array of HeadingStyle
hideProcessCreated	hideProcessCreated	boolean
image	image	string
isDeleted	isDeleted	boolean
logo	logo	string
mfaRequired	mfaRequired	boolean
name	name	string
noOfAdmins	noOfAdmins	integer
primaryColour	primaryColour	string
processTitleBold	processTitleBold	boolean
processTitleColour	processTitleColour	string
processTitleFontSize	processTitleFontSize	number
processTitleItalic	processTitleItalic	boolean
processTitleUnderline	processTitleUnderline	boolean
projectList	projectList	array of ProjectList
public	public	boolean
publicId	publicId	string
updatedAt	updatedAt	date-time

Sort

Name	Path	Type
columnId	columnId	uuid
columnName	columnName	string
direction	direction	string

SummaryUser

Name	Path	Type
email	email	string
firebaseUserId	firebaseUserId	string
name	name	string
profilePicture	profilePicture	string
publicId	publicId	uuid

Table

Name	Path	Type
allowDuplication	allowDuplication	boolean
columns	columns	array of TableColumn
createdAt	createdAt	date-time
defaultViewId	defaultViewId	string
deletedAt	deletedAt	date-time
isAconexSynced	isAconexSynced	boolean
isAutodeskBim360Synced	isAutodeskBim360Synced	boolean
isDeleted	isDeleted	boolean
isMortaProjectsSynced	isMortaProjectsSynced	boolean
isMortaResourcesSynced	isMortaResourcesSynced	boolean
isMortaSynced	isMortaSynced	boolean
isMortaUsersSynced	isMortaUsersSynced	boolean
isProcoreSynced	isProcoreSynced	boolean
isReviztoIssuesSynced	isReviztoIssuesSynced	boolean
isSynced	isSynced	boolean
isViewpointSynced	isViewpointSynced	boolean
joins	joins	array of TableJoin
keepColoursInSync	keepColoursInSync	boolean
keepValidationsInSync	keepValidationsInSync	boolean
lastSync	lastSync	date-time
logo	logo	string
name	name	string
projects	projects	array of Project
publicId	publicId	uuid
syncHourlyFrequency	syncHourlyFrequency	integer
type	type	string
updatedAt	updatedAt	date-time
variables	variables	array of string

Table1

Name	Path	Type
defaultViewId	defaultViewId	string
name	name	string
publicId	publicId	uuid

Table2

Name	Path	Type
createdAt	createdAt	date-time
name	name	string
publicId	publicId	uuid
type	type	string
updatedAt	updatedAt	date-time

Table3

Name	Path	Type	Description
name	name	string
publicId	publicId	uuid

TableColumn

Name	Path	Type
aconexSynced	aconexSynced	integer
aggregate	aggregate	integer
alterOptions	alterOptions
autodeskBim360Synced	autodeskBim360Synced	integer
dateFormat	dateFormat	string
decimalPlaces	decimalPlaces	integer
description	description
isIndexed	isIndexed	boolean
isJoined	isJoined	boolean
kind	kind	string
kindOptions	kindOptions	SelectOptionsLookup
mortaSynced	mortaSynced	integer
name	name	string
procoreSynced	procoreSynced	integer
publicId	publicId	uuid
reviztoIssuesSynced	reviztoIssuesSynced	integer
script	script	string
scriptEnabled	scriptEnabled	boolean
thousandSeparator	thousandSeparator	boolean
viewpointSynced	viewpointSynced	integer
width	width	integer

TableColumnAggregationResult

Name	Path	Type	Description
name	name	string
value	value	number

TableColumnJoin

Name	Path	Type	Description
sourceColumnId	sourceColumnId	string
targetColumnId	targetColumnId	string

TableColumnWithAggregation

Name	Path	Type
aggregation	aggregation	TableColumnAggregationResult
name	name	string
publicId	publicId	uuid

TableJoin

Name	Path	Type
dataColumns	dataColumns	array of TableJoinImportedColumns
isOneToMany	isOneToMany	boolean
joinColumns	joinColumns	array of TableColumnJoin
joinTableId	joinTableId	string
joinViewId	joinViewId	string
publicId	publicId	uuid

TableJoinImportedColumns

Name	Path	Type	Description
sourceColumnId	sourceColumnId	string
targetColumnId	targetColumnId	string

TableView

Name	Path	Type
allowContributorDelete	allowContributorDelete	boolean
chartSettings	chartSettings	Chart
collapsedGroupView	collapsedGroupView	boolean
colourSettings	colourSettings	array of Colour
columns	columns	array of TableViewColumn
description	description	Draftjs
disableNewRow	disableNewRow	boolean
displayCommentRows	displayCommentRows	integer
displayValidationErrorRows	displayValidationErrorRows	integer
filterSettings	filterSettings	array of Filter
frozenIndex	frozenIndex	integer
groupSettings	groupSettings	array of Group
isDefault	isDefault	boolean
name	name	string
publicId	publicId	uuid
rowHeight	rowHeight	integer
sortSettings	sortSettings	array of Sort
type	type	integer
unpackMultiselectGroupView	unpackMultiselectGroupView	boolean

TableViewColumn

Name	Path	Type
aconexSynced	aconexSynced	integer
aggregate	aggregate	integer
alterOptions	alterOptions
autodeskBim360Synced	autodeskBim360Synced	integer
dateFormat	dateFormat	string
decimalPlaces	decimalPlaces	integer
description	description
hardValidation	hardValidation	boolean
isIndexed	isIndexed	boolean
isJoined	isJoined	boolean
kind	kind	string
kindOptions	kindOptions	SelectOptionsLookup
locked	locked	boolean
mortaSynced	mortaSynced	integer
name	name	string
procoreSynced	procoreSynced	integer
publicId	publicId	uuid
required	required	boolean
reviztoIssuesSynced	reviztoIssuesSynced	integer
script	script	string
scriptEnabled	scriptEnabled	boolean
sortOrder	sortOrder	number
stringValidation	stringValidation	string
thousandSeparator	thousandSeparator	boolean
validationMessage	validationMessage	string
validationNoBlanks	validationNoBlanks	boolean
validationNoDuplicates	validationNoDuplicates	boolean
viewpointSynced	viewpointSynced	integer
width	width	integer

TableViewWithTable

Name	Path	Type
allowContributorDelete	allowContributorDelete	boolean
chartSettings	chartSettings	Chart
collapsedGroupView	collapsedGroupView	boolean
colourSettings	colourSettings	array of Colour
columns	columns	array of TableViewColumn
description	description	Draftjs
disableNewRow	disableNewRow	boolean
displayCommentRows	displayCommentRows	integer
displayValidationErrorRows	displayValidationErrorRows	integer
documentTable	documentTable	Table2
filterSettings	filterSettings	array of Filter
frozenIndex	frozenIndex	integer
groupSettings	groupSettings	array of Group
isDefault	isDefault	boolean
name	name	string
publicId	publicId	uuid
rowHeight	rowHeight	integer
sortSettings	sortSettings	array of Sort
type	type	integer
unpackMultiselectGroupView	unpackMultiselectGroupView	boolean

Tag

Name	Path	Type
documentTableId	documentTableId	string
projectPublicId	projectPublicId	uuid
publicId	publicId	uuid
referencePublicId	referencePublicId	string
value	value

Trigger

Name	Path	Type
publicId	publicId	uuid
resource	resource	string
verb	verb	string

User

Name	Path	Type
aconexConnected	aconexConnected	boolean
apiKeys	apiKeys	array of ApiKey
autodeskConnected	autodeskConnected	boolean
bio	bio	string
constructionSoftware	constructionSoftware	array of string
email	email	string
firebaseUserId	firebaseUserId	string
kind	kind	string
linkedin	linkedin	string
location	location	string
name	name	string
organisation	organisation	string
phone	phone	string
procoreConnected	procoreConnected	boolean
profilePicture	profilePicture	string
projectsWorkedOn	projectsWorkedOn	array of string
publicId	publicId	uuid
reviztoConnected	reviztoConnected	boolean
signature	signature	string
specialisms	specialisms	array of string
tags	tags
twitter	twitter	string
university	university	string
universityDegree	universityDegree	string
viewpointConnected	viewpointConnected	boolean
website	website	string

User1

Name	Path	Type	Description
name	name	string

User2

Name	Path	Type
email	email	string
firebaseUserId	firebaseUserId	string
kind	kind	string
name	name	string
profilePicture	profilePicture	string
publicId	publicId	uuid
tags	tags

User3

Name	Path	Type
firebaseUserId	firebaseUserId	string
name	name	string
publicId	publicId	uuid

User4

Name	Path	Type
email	email	string
firebaseUserId	firebaseUserId	string
kind	kind	string
name	name	string
publicId	publicId	uuid

UserWithToken

Name	Path	Type
aconexConnected	aconexConnected	boolean
apiKeys	apiKeys	array of ApiKey
authToken	authToken	string
autodeskConnected	autodeskConnected	boolean
bio	bio	string
constructionSoftware	constructionSoftware	array of string
email	email	string
firebaseUserId	firebaseUserId	string
hasPassword	hasPassword
id	id	integer
is2FaEnabled	is2FaEnabled
isSuperAdmin	isSuperAdmin	boolean
kind	kind	string
lastLoginAt	lastLoginAt	date-time
linkedin	linkedin	string
location	location	string
name	name	string
organisation	organisation	string
phone	phone	string
procoreConnected	procoreConnected	boolean
profilePicture	profilePicture	string
projectsWorkedOn	projectsWorkedOn	array of string
publicId	publicId	uuid
reviztoConnected	reviztoConnected	boolean
signature	signature	string
specialisms	specialisms	array of string
tags	tags
twitter	twitter	string
university	university	string
universityDegree	universityDegree	string
viewpointConnected	viewpointConnected	boolean
website	website	string

binary

This is the basic data type 'binary'.

שתף באמצעות

Morta (Preview)

Prerequisites

How to get credentials

Get started with your connector

Known issues and limitations

Common errors and remedies

FAQ

Creating a connection

Default

Throttling Limits

Actions

Add a column to a view

Parameters

Returns

Add or update rows in a table

Parameters

Returns

Add Row to Table

Parameters

Returns

Add rows to end of table

Parameters

Returns

Add Tag to User

Parameters

Returns

Change a User's Role in a Project

Parameters

Returns

Check Processes Table is Used In

Parameters

Returns

Check Views Column Is Used In

Parameters

Returns

Create a new notification

Parameters

Returns

Create a New Process

Parameters

Returns

Create a New Process Section

Parameters

Returns

Create a New Project

Parameters

Returns

Create a New Project Secret

Parameters

Returns

Create a new view for a table

Parameters

Returns

Create API Key for User

Parameters

Returns

Create Index on Table Column

Parameters

Returns

Create Multiple New Process Sections

Parameters

Returns

Create New Comment

Parameters

Returns

Create New Comment Thread

Parameters

Returns

Create new document table

Parameters

Returns

Create New Process Response

Parameters

Returns

Create New Process Sections

Parameters

Returns

Create New Project Heading Styling

Parameters