Morta (プレビュー)
Morta API は REST に基づいています。 当社の API は、JSON でエンコードされたリクエスト本文を受け入れ、JSON でエンコードされた応答を返します。 標準の HTTP 応答、認証、動詞を使用します。 すべての API リクエストには、次の形式の認証ヘッダーが必要です: { 'Authorization': 'Bearer <API_KEY>' }
このコネクタは、次の製品および地域で利用可能です:
サービス | クラス | 地域 |
---|---|---|
Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - US Government (GCC) - US Government (GCC High) - 21 Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
お問い合わせ先 | |
---|---|
件名 | Mort サポート |
[URL] | https://morta.io |
メール | support@morta.io |
Connector Metadata | |
---|---|
発行者 | Morta |
Web サイト | https://morta.io |
プライバシー ポリシー | https://morta.io/termsofservice |
カテゴリー | 生産性 ; コンテンツとファイル |
Morta は、使い慣れたソフトウェアと深く統合するクラウドベースのソリューションを提供し、追跡プロセスを効果的にデジタル化、接続、自動化できるようにします。 Morta コネクタを使用すると、Microsoft Power Automate プラットフォームを通じてすべての Morta 機能と対話できます。
前提条件
このコネクタを使用するには、Morta アカウントが必要です
資格情報の入手方法
Morta アカウントにログインし、Morta 統合 に移動して、新しい API キーを追加するだけです。 この API キーは Microsoft Power Automate 内で使用できます。 Microsoft Power Automate プラットフォームで API キーを入力するときは、必ず "Bearer" を先頭に付けてください。入力した API キーは次のようになります: "Bearer YOUR_API_KEY_HERE"
コネクタの使用を開始する
コネクタを使い始めるには、まず Morta プラットフォームからお気に入りのプロジェクト/ワークスペースを取得します。 これをするには、'GetFavouriteProjects' アクションを使用できます。
これに続いて、'CreateProcess' アクションと次のパラメータを使用して、Morta でプロセス/ドキュメントを作成できます。
- 名前: 新規プロセス
- プロジェクト ID: <one_of_your_project_public_ids>
- タイプ: カスタム
既知の問題と制限事項
None
一般的なエラーと解決策
Morta コネクタを使用すると、ユーザーは次のいずれかの HTTP ステータス コードが発生する可能性があります。
- 401: 要求されたアクションは承認されませんでした。 これは、API キーを入力していないか、API キーを間違って入力した (コピーしたAPIキーの前に "Bearer" を追加していないなど) ことが原因である可能性があります
- 403: Morta リソースを要求するためのアクセス許可がありません。 要求されたリソースへのアクセス許可を、そのリソースの所有者に必ず要求してください。
- 404: Morta リソースは存在しません。 Morta プラットフォームにログインして、ID が正しく入力されていることを確認してください。
- 422: リクエストにデータがないか、形式が正しくありません。 リクエストに必要なすべてのデータの説明を読み、仕様に従っていることを確認してください。 たとえば、フィールドとして数値を入力する必要があるのに、代わりに文字列を入力した場合があります。
- 429: 一定期間内に Morta に送信されたリクエストが多すぎます。 Morta プラットフォームに1秒あたり 10 件を超えるリクエストを送信していないことを確認してください。
よくあるご質問
質問: Morta API キーが機能しないのはなぜですか? 回答: API キーの先頭に "Bearer" ("Bearer" という単語とスペース) を追加したことを確認してください。 入力する最終的な API キーは次のようになります (ここではダミーの API キーが使用されています): "Bearer zSujSa_eXxd3b1yVtTQVMw7Ghn18Ja9sOWvj-O4C908"
接続を作成する
このコネクタは、次の認証タイプをサポートしています:
既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
名前 | タイプ | プロパティ | Required |
---|---|---|---|
API Key | securestring | MotaWord 接続の API キー | True |
調整制限
名前 | 呼び出し | 更新期間 |
---|---|---|
接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
API キーの削除 |
現在ログインしているユーザーの API キーを削除する |
API キーの更新 |
現在ログインしているユーザーの API キーを更新する |
Delete a table |
そのUUID による特定のテーブルのレコードを削除します。 |
Passthrough ダウンロードリクエストの作成 |
ファイルをダウンロードするために、外部ソース システムへのパススルー API 呼び出しを行います。 |
すべてのテーブル結合を取得 |
テーブルに関連付けられているすべての結合を取得します。 |
コメント スレッド Statistics の取得 |
参照タイプとメイン参照 ID に基づいてコメント スレッドの統計情報を取得します |
コメント スレッドの再オープン |
過去に解決されたコメント スレッドを再オープンする |
コメント スレッドの削除 |
コメント スレッドの削除 |
コメント スレッドの取得 |
ID で特定のコメントスレッドを取得する |
コメントの削除 |
コメントスレッド内の特定コメントを削除する |
コメントの更新 |
コメントスレッド内の特定コメントを更新する |
サポートされているすべてのイベントの種類の一覧を取得する |
通知のサポートされているすべてのイベントの種類の一覧を取得します。 |
ソースシステムへのパススルー要求の作成 |
外部ソース システムへのパススルー API 呼び出しを行います。 |
チャート画像をダウンロード |
特定のテーブル ビューのデータに基づいてグラフの画像ファイルをダウンロードします。 |
テーブル ジョインを作成する |
2 つのテーブル間にジョインを作成します。 |
テーブルからすべての行を削除する |
指定されたテーブルからすべての行を削除します。 |
テーブルから統合を削除する |
テーブルから特定の統合を削除します。 |
テーブルとその行を取得する |
指定されたパラメータに基づいてテーブルとその行を取得します |
テーブルのすべてのビューを取得する |
特定のテーブルに関連付けられているすべてのビューを取得します。 |
テーブルのすべての行のストリーム |
特定のテーブルのすべての行のデータをストリーミングします。 |
テーブルのでおfると ビューを複製する |
特定のテーブルのデフォルト ビューの複製を作成します。 |
テーブルのセルのファイルを取得 |
テーブルの特定セルに関連付けられているファイルを取得します。 |
テーブルのセルを更新する |
テーブルの特定のセルを更新します。 |
テーブルのビューを削除する |
テーブルの特定ビューを削除します。 |
テーブルのビューを更新する |
特定のテーブルの既存のビューを更新します。 |
テーブルのビューを複製する |
特定のテーブルの既存のビューの複製を作成します。 |
テーブルの単一ビューを取得する |
テーブルの ID によって特定のビューを取得します。 |
テーブルの新しいビューを作成する |
特定のテーブルの新しいビューを作成します。 |
テーブルの既存の行を更新する |
指定されたテーブルの既存の行を更新します。 |
テーブルの最後に行を追加する |
指定されたテーブル ビューの末尾に新しい行を挿入します。 |
テーブルの結合を削除 |
テーブルから結合を削除します。 |
テーブルの行のアップサート |
一意の列の値に基づいて、特定のテーブルの行を追加または更新します。 |
テーブルの複製 |
既存のテーブルとそのデータ、設定、オプションでリンクされたテーブルの複製を作成します。 |
テーブルデータを CSV としてダウンロード |
CSV ファイルとして特定テーブルのデータをダウンロードします。 |
テーブル内の行を追加または更新する |
指定された列に基づいて、テーブル ビュー内の行をアップサート (追加または更新) します。 |
テーブル列のインデックスを作成する |
クエリのパフォーマンスを向上させるために、テーブルの1つ以上の列にインデックスを作成します。 |
テーブル列の作成 |
既存のテーブルに新しい列を追加します。 |
テーブル列の削除 |
テーブルから特定の列を削除します。 |
テーブル列の復元 |
テーブルの依然削除された列を復元します。 |
テーブル列の更新 |
テーブルの特定の列のプロパティを更新します。 |
テーブル列の統計情報を取得する |
特定のテーブル ビュー内の列の統計データを取得します。 |
テーブル列の統計情報を取得する |
指定されたパラメータに基づいてテーブル列の統計を取得します。 |
テーブル列を取得する |
特定のテーブルのすべてのアクティブな列を取得します。 |
テーブル結合を更新する |
テーブルの既存の結合行を更新します。 |
テーブル行を削除する |
テーブルからすべての行または特定の行を削除します。 |
テーブル行を取得する |
提供されたクエリパラメータに基づいてテーブルから行を取得します。 |
トッププロジェクト見出しスタイルの削除 |
トップ プロジェクトの新しい見出しスタイルを削除する |
パブリック ID でタグを取得する |
そのパブリック ID でタグを取得します。 |
パブリック ID によるユーザー詳細の取得 |
パブリック ID で特定のユーザーの情報を取得する |
パブリック プロジェクトを取得する |
ユーザーがメンバーであるすべての公開プロジェクトを取得します |
ビューのすべての行のストリーム |
特定のテーブル ビューのすべての行のデータをストリーミングします。 |
ビューのチャートデータの取得 |
特定のテーブル ビューに基づいてグラフを生成するためのデータを取得します。 |
ビューの列の更新 |
テーブル ビュー内の特定の列を更新します。 |
ビューへの列の追加 |
特定のテーブル ビューに新しい列を追加する |
ビューデータを csv ファイルとしてダウンロードする |
特定のテーブル ビューのデータを CSV 形式でダウンロードします。 |
ビュー列が使用されているか確認する |
特定のテーブル列が使用されているすべてのビューを取得します。 |
ピン留めされたプロジェクトを取得する |
Firebase ID で識別されたユーザーがピン留めしたプロジェクトを取得します |
フォーカス ビューを既定のビューとして設定する |
特定のテーブル ビューをテーブルのデフォルト ビューとして指定します。 |
プロジェクト シークレットの更新 |
プロジェクトの特定のシークレットを更新する |
プロジェクト シークレットを削除する |
プロジェクトから特定のシークレットを削除する |
プロジェクト シークレットを取得 |
指定されたプロジェクトに招待されたすべてのシークレットを取得します |
プロジェクト タグの取得 |
指定されたプロジェクトに関連したすべてのタグを取得する |
プロジェクト テーブルを取得する |
UUID で識別される特定のプロジェクトに関連付けられたテーブルを取得する |
プロジェクト メンバーの取得 |
指定されたプロジェクトに関連したすべてのメンバーを取得する |
プロジェクト リソースの取得 |
UUID で識別される特定のプロジェクトに関連付けられたリソースを取得する |
プロジェクトからユーザーを削除します |
プロジェクトの UUID とユーザーの Firebase ID で識別される、プロジェクトからユーザーを削除する |
プロジェクトのお気に入りステータスを切り替える |
現在ログインしているユーザーのプロジェクトをお気に入りにするかどうかを変更する |
プロジェクトのピンステータスを切り替える |
現在ログインしているユーザーのプロジェクトをピン留めするかどうかを変更する |
プロジェクトのユーザーに招待を再送信する |
プロジェクトのユーザーに招待を再送信します。 これは、新規ユーザーと以前に招待された既存ユーザーの両方に適用されます。 所有者または管理者のアクセス許可が必要です。 |
プロジェクトの変数を取得する |
指定されたプロジェクトに関連したすべての変数を取得する |
プロジェクトの復元 |
以前に削除された、UUID で識別される特定のプロジェクトを復元します |
プロジェクトの招待を更新する |
プロジェクトで既存の招待を更新する |
プロジェクトの招待状を削除する |
プロジェクトへの招待状を削除する |
プロジェクトの複製 |
既存のプロジェクトの複製の作成 |
プロジェクトの送信済み通知を取得する |
指定されたプロジェクトに送信されたすべての通知を取得します |
プロジェクトの通知を受け取る |
特定のプロジェクトに関連付けられているすべての通知を取得します。 この エンドポイント には、プロジェクトの所有者レベルの権限を持つユーザーのみがアクセスできます。 |
プロジェクトへのユーザーの招待 |
メールで 1 人のユーザーをプロジェクトに参加するよう招待します。 ユーザーがすでに存在する場合は直接追加され、そうでない場合は招待が送信されます。 所有者または管理者のアクセス許可が必要です。 |
プロジェクトを削除する |
UUID で識別される特定のプロジェクトを削除する |
プロジェクトメンバーを招待する |
指定されたプロジェクトに招待されたすべてのメンバーを取得します |
プロジェクト内のプロセスを取得する |
UUID で識別される特定のプロジェクトに関連付けられたすべてのプロセスを取得する |
プロジェクト内のユーザーの役割を変更する |
プロジェクトの UUID とユーザーの Firebase ID で識別される特定のプロジェクト内のユーザーの役割を変更します |
プロジェクト内の削除されたテーブルを取得する |
UUID で識別される特定のプロジェクトから、削除されたすべてのテーブルを取得します。 プロジェクト所有者のみがアクセスできます。 |
プロジェクト内の削除されたプロセスを取得する |
UUID で識別される特定のプロジェクトに関連付けられた削除されたプロセスを取得する |
プロジェクト内検索 |
UUID で識別される特定のプロジェクト内で検索操作を実行する |
プロジェクト情報の取得 |
その UUID で識別された特定プロジェクトについて詳細情報を取得する |
プロセス セクションの削除 |
特定のプロセス セクションを削除します。 |
プロセス セクションの取得 |
特定のプロセス セクションを取得します。 |
プロセス セクションの複製 |
特定のプロセス セクションを複製します。 |
プロセス セクションの複製 |
特定のプロセス セクションを非同期で複製します。 |
プロセス セクション注文の更新 |
プロセス内のプロセス セクションの順序を更新します。 |
プロセス レスポンダーの更新 |
UUID で識別される特定のプロセスの応答者リストを更新する |
プロセスのエクスポート |
特定のプロセスを UUID でさまざまな形式 (PDF または DOCX) にエクスポートします |
プロセスの削除 |
UUID で識別されるプロセスの削除 |
プロセスの複製 |
既存のプロセスを複製する (別のプロジェクトで複製することも可能) |
プロセスの複製 |
既存のプロセスを複製する (別のプロジェクトへの複製も可能) |
プロセスの詳細の取得 |
特定のプロセスの UUID による詳細情報を取得します |
プロセスセクションの復元 |
依然削除されたプロセス セクションを復元します。 |
プロセステーブルが使用されているかどうかの確認 |
指定されたテーブルが使用されているプロセス、テーブル結合、および選択のリストを確認して返します。 |
プロセス応答のリセット |
既存のプロセス応答を初期状態にリセットします。 |
プロセス応答の削除 |
特定のプロセス応答を削除します。 |
プロセス応答の復元 |
依然削除されたプロセス応答を復元します。 |
プロセス応答の提出 |
プロセス応答を送信し、完了としてマークします。 |
プロセス応答下書きの提出 |
後で完成させるためにプロセス応答の下書きを送信します。 |
ユーザー アカウントの更新 |
現在ログインしているユーザーのアカウント詳細を更新する |
ユーザー テンプレートを取得する |
現在ログインしているユーザーがアクセス権を持つすべてのテンプレートを取得 |
ユーザー プロジェクトの取得 |
現在ログインしているユーザーが一部であるすべてのプロジェクトを取得する |
ユーザーからタグを削除する |
特定のユーザーからタグを削除する |
ユーザーが所有および管理するプロジェクトを取得する |
ユーザーが所有者または管理者であるすべてのプロジェクトを取得します |
ユーザーのAPIキーを作成する |
現在ログインしているユーザーの API キーを作成する |
ユーザーのお気に入りのプロジェクトを取得する |
現在ログインしているユーザーが一部であるすべてのプロジェクトを取得する |
ユーザーのアチーブメントを取得する |
Firebase ID でユーザーの実績バッジを取得する |
ユーザーのパブリック寄付を取得する |
Firebase ID で識別される、ユーザーによるパブリック寄付を取得します |
ユーザーの寄付を取得する |
Firebase ID で識別される、ユーザーによる1日あたりの投稿数を取得します |
ユーザーへのタグの追加 |
タグを特定のユーザーに追加する |
ユーザーを検索する |
プロジェクトまたはプロセス別にユーザーを検索する |
リソースのすべてのイベントを取得する |
さまざまな基準でフィルタリングされた、特定のリソースに関連付けられたすべてのイベントを取得します。 |
リソースのアクセス許可を作成する |
特定のリソース (テーブル、テーブル ビュー、プロセスなど) に対する権限を作成します。 |
リソースのアクセス許可を削除する |
特定のリソース (テーブル、テーブル ビュー、プロセスなど) に対する権限を削除します。 |
リソースのアクセス許可を取得する |
特定のリソース (テーブル、テーブル ビュー、プロセスなど) に対する権限を取得します。 |
リソースのアクセス許可を更新する |
特定のリソース (テーブル、テーブル ビュー、プロセスなど) に対する権限を更新します。 |
リソースのアクセス許可を要求する |
特定のリソース (テーブル、テーブル ビュー、プロセスなど) に対する権限を要求します。 |
入力からの結果行をプレビューする |
特定のテーブル ビューで、指定された入力からの結果の行をプレビューします。 |
列の一意の値を取得する |
テーブル ビュー内の特定の列の一意の値を取得します。 |
列の一意の値を取得する |
テーブル ビュー内の特定の列の個別の (一意の) 値を取得します。 |
削除されたプロセスセクションを取得する |
特定のプロセスセクションのオプションのフィルターを使用して、特定のプロセスの削除されたセクションをすべて取得します |
削除したテーブルの復元 |
UUID を使用して、以前に削除されたテーブルを復元します。 |
単一の通知を削除する |
ID によって特定の通知を削除します。 |
単一の通知を更新する |
ID によって特定の通知を更新します。 |
参照によるコメントスレッドの取得 |
特定の参照に関連付けられたすべてのコメントスレッドを取得します |
実際のテーブルビューデータを取得する |
特定のテーブル ビューの実際のデータを取得します。 |
復元プロセス |
UUID で識別される削除されたプロセスの復元 |
新しいコメントを作成する |
特定のコメントスレッド内に新しいコメントを作成する |
新しいドキュメント テーブルを作成する |
プロジェクト内に新しいドキュメント テーブルを作成します。 |
新しいプロジェクト シークレットを作成する |
指定したプロジェクトに新しいシークレットを作成する |
新しいプロジェクトを作成する |
指定した名前の新しいプロジェクトを作成する |
新しいプロジェクト見出しスタイルの作成 |
特定のプロジェクトの新しい見出しスタイルを作成する |
新しいプロジェクト見出しスタイルの更新 |
特定のプロジェクトの新しい見出しスタイルを更新する |
新しいプロセス セクションを作成する |
親セクションを設定するオプションのある、指定されたプロセス内に新しいセクションを作成する |
新しいプロセス セクションを作成する |
プロセス内の複数の新しいプロセスセクションを作成する |
新しいプロセスを作成する |
指定したプロジェクトに新しいプロセスを作成する |
新しいプロセス応答を作成する |
プロセス セクションの新しい応答を作成します。 |
新規コメント スレッドを作成する |
新規コメント スレッドを作成する |
新規ユーザーを作成する |
新しいユーザーを作成する |
新規通知を作成する |
特定のプロジェクトに対して新しい通知を作成します。 |
既存のテーブルのセルを更新する |
テーブル ビュー内の特定のセルを更新します。 |
既存のテーブルを更新する |
既存のテーブルのプロパティを更新します。 |
既存のプロジェクトを更新する |
プロジェクト ID で既存のプロジェクトの詳細を更新する |
既存のプロセス セクションの更新 |
プロセス セクション ID で既存のプロセス セクションの詳細を更新する |
既存のプロセスの更新 |
プロセス ID で既存のプロセスの詳細を更新する |
既存のプロセス応答の更新 |
プロセス セクションの既存の応答を更新します。 |
既存の行を更新する |
指定されたテーブル ビュー内の既存の行を更新します。 |
特定のユーザーの詳細を取得する |
特定ユーザーに関する情報を取得します |
特定の行の削除 |
行 ID に基づいてテーブル ビューから特定の行を削除します。 |
現在のユーザー プロファイルを更新する |
現在ログインしているユーザーのプロファイルを更新する |
統合とテーブルを同期する |
指定された統合とテーブルを同期します。 |
行をテーブルに追加する |
新規行を特定のテーブルに追加します。 |
複数のユーザーをプロジェクトに招待する |
メールで複数のユーザーをプロジェクトに参加するよう招待します。 ユーザーがすでに存在する場合、それは直接追加され、そうでない場合は招待が送信されます。 所有者または管理者のアクセス許可が必要です。 |
複数の新しいプロセスセクションを作成する |
それぞれオプションの親セクションを持つ、指定されたプロセス内に複数の新しいセクションを作成する |
複数の新しいプロセスセクションを更新する |
複数の既存のプロセスセクションを更新します。 |
解決コメント スレッド |
コメント スレッドの解決 |
詳細を取得する |
現在のユーザーの情報を取得する |
API キーの削除
現在ログインしているユーザーの API キーを削除する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
API キー ID
|
api_key_id | True | uuid |
削除する API キーの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
metadata
|
metadata | object |
追加のメタデータ |
API キーの更新
現在ログインしているユーザーの API キーを更新する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
API キー ID
|
api_key_id | True | uuid |
更新する API キーの UUID |
名称
|
name | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
apiKey
|
apiKey | string |
更新された API キーの詳細 |
Delete a table
そのUUID による特定のテーブルのレコードを削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
削除するテーブルの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
metadata
|
metadata | object |
Passthrough ダウンロードリクエストの作成
ファイルをダウンロードするために、外部ソース システムへのパススルー API 呼び出しを行います。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
データ
|
data | |||
headers
|
headers | |||
方法
|
method | True | string | |
onBehalfUserId
|
onBehalfUserId | uuid | ||
パス
|
path | True | string | |
sourceSystem
|
sourceSystem | True | string |
戻り値
- 返答
- binary
すべてのテーブル結合を取得
テーブルに関連付けられているすべての結合を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
取得する結合のテーブルの UUID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of TableJoin | |
metadata
|
metadata | object |
コメント スレッド Statistics の取得
参照タイプとメイン参照 ID に基づいてコメント スレッドの統計情報を取得します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
参照の種類
|
reference_type | True | string |
統計を収集する参照のタイプ (process_section、table、または table_view) |
主なリファレンス ID
|
main_reference_id | uuid |
統計情報を収集するメイン参照の UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of CommentThreadStats | |
metadata
|
metadata | object |
コメント スレッドの再オープン
過去に解決されたコメント スレッドを再オープンする
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
コメント スレッド ID
|
comment_thread_id | True | uuid |
再度開くコメント スレッドの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | CommentThread | |
変更
|
metadata.change | object |
コメント スレッドに加えられた変更 |
event
|
metadata.event | string |
この操作のイベント タイプ |
resourceId
|
metadata.resourceId | string |
再度開かれたコメント スレッドの UUID |
コメント スレッドの削除
コメント スレッドの削除
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
コメント スレッド ID
|
comment_thread_id | True | uuid |
削除するコメント スレッドの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | CommentThread | |
変更
|
metadata.change | object |
コメント スレッドに加えられた変更 |
event
|
metadata.event | string |
この操作のイベント タイプ |
resourceId
|
metadata.resourceId | string |
削除されたコメント スレッドの UUID |
コメント スレッドの取得
ID で特定のコメントスレッドを取得する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
コメント スレッド ID
|
comment_thread_id | True | uuid |
取得するコメント スレッドの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | CommentThread | |
metadata
|
metadata | object |
コメントの削除
コメントスレッド内の特定コメントを削除する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
コメント スレッド ID
|
comment_thread_id | True | uuid |
コメントを含むコメントスレッドの UUID |
Comment Id
|
comment_id | True | uuid |
削除するコメントの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | Comment | |
変更
|
metadata.change | object |
コメントに加えられた変更 |
event
|
metadata.event | string |
この操作のイベント タイプ |
resourceId
|
metadata.resourceId | string |
削除されたコメントの UUID |
コメントの更新
コメントスレッド内の特定コメントを更新する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
コメント スレッド ID
|
comment_thread_id | True | uuid |
コメントを含むコメントスレッドの UUID |
Comment Id
|
comment_id | True | uuid |
更新するコメントの UUID |
commentText
|
commentText | True | string | |
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | Comment | |
変更
|
metadata.change | object |
コメントに加えられた変更 |
event
|
metadata.event | string |
この操作のイベント タイプ |
resourceId
|
metadata.resourceId | string |
更新されたコメントの UUID |
サポートされているすべてのイベントの種類の一覧を取得する
通知のサポートされているすべてのイベントの種類の一覧を取得します。
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of string | |
metadata
|
metadata | object |
ソースシステムへのパススルー要求の作成
外部ソース システムへのパススルー API 呼び出しを行います。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
データ
|
data | |||
headers
|
headers | |||
方法
|
method | True | string | |
onBehalfUserId
|
onBehalfUserId | uuid | ||
パス
|
path | True | string | |
sourceSystem
|
sourceSystem | True | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | IntegrationsPassthroughResponse | |
metadata
|
metadata | object |
チャート画像をダウンロード
特定のテーブル ビューのデータに基づいてグラフの画像ファイルをダウンロードします。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ビュー ID
|
view_id | True | uuid |
チャート画像が生成されたテーブル ビューの UUID。 |
グラフの種類
|
chart_type | string |
画像が生成されるグラフの種類。 |
|
凡例の表示
|
show_legend | boolean |
グラフ画像に凡例を含めるかどうかを示すフラグ。 |
|
値の表示
|
show_values | boolean |
グラフ画像に値を含めるかどうかを示すフラグ。 |
|
列の値 ID
|
column_value_id | uuid |
チャート画像の値ソースとして使用される列の UUID。 |
|
列ラベル ID
|
column_label_id | uuid |
チャート画像のラベル ソースとして使用される列の UUID。 |
戻り値
- 返答
- binary
テーブル ジョインを作成する
2 つのテーブル間にジョインを作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
結合を作成するテーブルの UUID。 |
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 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | Table | |
metadata
|
metadata | object |
テーブルからすべての行を削除する
指定されたテーブルからすべての行を削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
すべての行が削除されるテーブルの UUID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
metadata
|
metadata | object |
テーブルから統合を削除する
テーブルから特定の統合を削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
統合が削除されるテーブルの UUID。 |
統合名
|
integration_name | True | string |
削除される統合の名前。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
metadata
|
metadata | object |
テーブルとその行を取得する
指定されたパラメータに基づいてテーブルとその行を取得します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
取得するテーブルの UUID |
ぺージ
|
page | integer |
ページ割り付けのページ番号 |
|
規模
|
size | integer |
ページ割り付けのページごとのアイテムの数 |
|
並び替え
|
sort | string |
テーブル行の並べ替え基準 |
|
フィルター
|
filter | string |
テーブル行のフィルター基準 |
|
最終更新日時
|
last_updated_at | date-time |
この日付以降に更新された行をフィルターする |
|
最終作成日
|
last_created_at | date-time |
この日付以降に作成された行をフィルターする |
|
次のページのトークン
|
next_page_token | string |
結果の次のページを取得するトークン |
|
Columns
|
columns | array |
応答に含める特定の列 |
|
個別の列
|
distinct_columns | array |
個別のフィルタリングを適用する列 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | Table | |
page
|
metadata.page | integer |
現在のページの番号 |
size
|
metadata.size | integer |
ページあたりの項目数 |
total
|
metadata.total | integer |
テーブルが含む行数 |
テーブルのすべてのビューを取得する
特定のテーブルに関連付けられているすべてのビューを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
取得するビューのテーブルの UUID。 |
列を無視
|
ignore_columns | boolean |
応答内の列データを無視するかどうかを示すフラグ。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of TableView | |
metadata
|
metadata | object |
テーブルのすべての行のストリーム
特定のテーブルのすべての行のデータをストリーミングします。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
行をストリームするテーブルの UUID。 |
フィルター
|
filter | string |
データのストリーミングに適用するフィルター。 |
|
並び替え
|
sort | string |
データのストリーミングの並べ替えパラメータ。 |
|
ぺージ
|
page | integer |
ページ割り付けのページ番号 |
|
規模
|
size | integer |
ページ割り付けのページごとのアイテムの数 |
戻り値
- 返答
- binary
テーブルのでおfると ビューを複製する
特定のテーブルのデフォルト ビューの複製を作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
そのビューを複製するデフォルト ビューの UUID。 |
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
名称
|
name | string | ||
タイプ
|
type | integer |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | TableView | |
metadata
|
metadata | object |
テーブルのセルのファイルを取得
テーブルの特定セルに関連付けられているファイルを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
ファイルを含むテーブルの UUID。 |
列 ID
|
column_id | True | uuid |
セルを含む列の UUID。 |
Filename
|
filename | True | string |
取得するファイルの名前。 |
戻り値
- 返答
- binary
テーブルのセルを更新する
テーブルの特定のセルを更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
更新されるセルを含むテーブルの UUID。 |
columnName
|
columnName | True | string | |
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
rowId
|
rowId | True | string | |
価値
|
value | |||
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
metadata
|
metadata | object |
テーブルのビューを削除する
テーブルの特定ビューを削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ビュー ID
|
view_id | True | uuid |
削除するテーブル ビューの UUID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
metadata
|
metadata | object |
テーブルのビューを更新する
特定のテーブルの既存のビューを更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ビュー ID
|
view_id | True | uuid |
更新されるテーブル ビューの UUID。 |
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 | |||
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 | |||
hardValidation
|
hardValidation | boolean | ||
isIndexed
|
isIndexed | boolean | ||
isJoined
|
isJoined | boolean | ||
kind
|
kind | string | ||
manualOptions
|
manualOptions | array of string | ||
tableOptions
|
tableOptions | |||
ロック済み
|
locked | boolean | ||
mortaSynced
|
mortaSynced | integer | ||
名称
|
name | string | ||
procoreSynced
|
procoreSynced | integer | ||
publicId
|
publicId | uuid | ||
required
|
required | boolean | ||
reviztoIssuesSynced
|
reviztoIssuesSynced | integer | ||
スクリプト
|
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 | integer | ||
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
プロパティ
|
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 | |||
frozenIndex
|
frozenIndex | integer | ||
columnId
|
columnId | uuid | ||
columnName
|
columnName | True | string | |
direction
|
direction | True | string | |
名称
|
name | string | ||
rowHeight
|
rowHeight | integer | ||
columnId
|
columnId | uuid | ||
columnName
|
columnName | True | string | |
direction
|
direction | True | string | |
タイプ
|
type | integer | ||
unpackMultiselectGroupView
|
unpackMultiselectGroupView | boolean |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | TableView | |
metadata
|
metadata | object |
テーブルのビューを複製する
特定のテーブルの既存のビューの複製を作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
そのビューを複製するテーブル ビューの UUID。 |
ビュー ID
|
view_id | True | uuid |
複製されるビューの UUID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | TableView | |
metadata
|
metadata | object |
テーブルの単一ビューを取得する
テーブルの ID によって特定のビューを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ビュー ID
|
view_id | True | uuid |
取得するテーブル ビューの UUID。 |
キャッシュされたオプションを無視
|
ignore_cached_options | boolean |
応答内のキャッシュされたオプションを無視するかどうかを示すフラグ。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | TableViewWithTable | |
metadata
|
metadata | object |
テーブルの新しいビューを作成する
特定のテーブルの新しいビューを作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
その列を追加するテーブル ビューの UUID。 |
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 | |||
columnId
|
columnId | uuid | ||
columnName
|
columnName | True | string | |
プロパティ
|
description | |||
ロック済み
|
locked | boolean | ||
required
|
required | boolean | ||
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
プロパティ
|
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 | |||
frozenIndex
|
frozenIndex | integer | ||
columnId
|
columnId | uuid | ||
columnName
|
columnName | True | string | |
direction
|
direction | True | string | |
includeAllColumns
|
includeAllColumns | boolean | ||
isDefault
|
isDefault | boolean | ||
名称
|
name | True | string | |
rowHeight
|
rowHeight | integer | ||
columnId
|
columnId | uuid | ||
columnName
|
columnName | True | string | |
direction
|
direction | True | string | |
タイプ
|
type | integer | ||
unpackMultiselectGroupView
|
unpackMultiselectGroupView | boolean |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | TableView | |
metadata
|
metadata | object |
テーブルの既存の行を更新する
指定されたテーブルの既存の行を更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
行が更新されるテーブルの UUID |
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 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of object | |
publicId
|
data.publicId | string | |
rowData
|
data.rowData | object | |
sortOrder
|
data.sortOrder | number | |
metadata
|
metadata | object |
テーブルの最後に行を追加する
指定されたテーブル ビューの末尾に新しい行を挿入します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ビュー ID
|
view_id | True | uuid |
行が追加されるテーブル ビューの UUID。 |
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 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of object | |
publicId
|
data.publicId | string | |
rowData
|
data.rowData | object | |
sortOrder
|
data.sortOrder | number | |
metadata
|
metadata | object |
テーブルの結合を削除
テーブルから結合を削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
統合が削除されるテーブルの UUID。 |
結合 ID
|
join_id | True | uuid |
削除する結合の UUID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
metadata
|
metadata | object |
テーブルの行のアップサート
一意の列の値に基づいて、特定のテーブルの行を追加または更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
行をアップサートするテーブルの UUID |
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 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of object | |
publicId
|
data.publicId | string | |
rowData
|
data.rowData | object | |
sortOrder
|
data.sortOrder | number | |
metadata
|
metadata | object |
テーブルの複製
既存のテーブルとそのデータ、設定、オプションでリンクされたテーブルの複製を作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
複製されるテーブルの UUID |
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
duplicateLinkedTables
|
duplicateLinkedTables | boolean | ||
duplicatePermissions
|
duplicatePermissions | boolean | ||
targetProjectId
|
targetProjectId | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
metadata
|
metadata | object |
テーブルデータを CSV としてダウンロード
CSV ファイルとして特定テーブルのデータをダウンロードします。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
データをダウンロードするテーブルの UUID |
並び替え
|
sort | string |
テーブル行の並べ替え基準 |
|
フィルター
|
filter | string |
テーブル行のフィルター基準 |
戻り値
- 返答
- binary
テーブル内の行を追加または更新する
指定された列に基づいて、テーブル ビュー内の行をアップサート (追加または更新) します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ビュー ID
|
view_id | True | uuid |
行がアップサートされるテーブル ビューの UUID。 |
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 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of object | |
publicId
|
data.publicId | string | |
rowData
|
data.rowData | object | |
sortOrder
|
data.sortOrder | number | |
metadata
|
metadata | object |
テーブル列のインデックスを作成する
クエリのパフォーマンスを向上させるために、テーブルの1つ以上の列にインデックスを作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
インデックスを作成するテーブルの UUID。 |
publicId
|
publicId | True | uuid |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of TableColumn | |
metadata
|
metadata | object |
テーブル列の作成
既存のテーブルに新しい列を追加します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
行が化追加されるテーブルの UUID |
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 | |||
isIndexed
|
isIndexed | boolean | ||
kind
|
kind | string | ||
manualOptions
|
manualOptions | array of string | ||
tableOptions
|
tableOptions | |||
mortaSynced
|
mortaSynced | integer | ||
名称
|
name | True | string | |
procoreSynced
|
procoreSynced | integer | ||
publicId
|
publicId | uuid | ||
reviztoIssuesSynced
|
reviztoIssuesSynced | integer | ||
スクリプト
|
script | string | ||
scriptEnabled
|
scriptEnabled | boolean | ||
thousandSeparator
|
thousandSeparator | boolean | ||
viewpointSynced
|
viewpointSynced | integer | ||
幅
|
width | integer |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | TableColumn | |
metadata
|
metadata | object |
テーブル列の削除
テーブルから特定の列を削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
列を含むテーブルの UUID |
列 ID
|
column_id | True | uuid |
削除する列の UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
metadata
|
metadata | object |
テーブル列の復元
テーブルの依然削除された列を復元します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
列が復元されているテーブルの UUID |
列 ID
|
column_id | True | uuid |
復元される列の UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | TableColumn | |
metadata
|
metadata | object |
テーブル列の更新
テーブルの特定の列のプロパティを更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
列を含むテーブルの UUID |
列 ID
|
column_id | True | uuid |
更新する列の UUID |
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 | |||
isIndexed
|
isIndexed | boolean | ||
kind
|
kind | string | ||
manualOptions
|
manualOptions | array of string | ||
tableOptions
|
tableOptions | |||
mortaSynced
|
mortaSynced | integer | ||
名称
|
name | True | string | |
procoreSynced
|
procoreSynced | integer | ||
publicId
|
publicId | uuid | ||
reviztoIssuesSynced
|
reviztoIssuesSynced | integer | ||
スクリプト
|
script | string | ||
scriptEnabled
|
scriptEnabled | boolean | ||
thousandSeparator
|
thousandSeparator | boolean | ||
viewpointSynced
|
viewpointSynced | integer | ||
幅
|
width | integer |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | TableColumn | |
metadata
|
metadata | object |
テーブル列の統計情報を取得する
特定のテーブル ビュー内の列の統計データを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ビュー ID
|
view_id | True | uuid |
取得するステータスのテーブル ビューの UUID。 |
フィルター
|
filter | string |
統計データ取得に適用するフィルター。 |
|
Sum、avg、max、min、count
|
sum, avg, max, min, count | array |
合計、平均、最大、最小、またはカウント操作を実行する列を指定します。 |
|
プロセス ID
|
process_id | uuid |
データをフィルタリングするプロセスのオプションの UUID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of TableColumnWithAggregation | |
metadata
|
metadata | object |
テーブル列の統計情報を取得する
指定されたパラメータに基づいてテーブル列の統計を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
取得される統計のテーブルの UUID |
集計
|
aggregation | string |
列に適用する集計関数 |
|
フィルター
|
filter | string |
列のフィルター条件 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of TableColumnWithAggregation | |
metadata
|
metadata | object |
テーブル列を取得する
特定のテーブルのすべてのアクティブな列を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
取得する列のテーブルの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of TableColumn | |
metadata
|
metadata | object |
テーブル結合を更新する
テーブルの既存の結合行を更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
更新される結合を持つテーブルの UUID。 |
結合 ID
|
join_id | True | uuid |
更新する結合の UUID。 |
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 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | Table | |
metadata
|
metadata | object |
テーブル行を削除する
テーブルからすべての行または特定の行を削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
行が削除されるテーブルの UUID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
metadata
|
metadata | object |
テーブル行を取得する
提供されたクエリパラメータに基づいてテーブルから行を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
行が取得されるテーブルの UUID |
ぺージ
|
page | integer |
ページ割り付けのページ番号 |
|
規模
|
size | integer |
ページ割り付けのページごとのアイテムの数 |
|
並び替え
|
sort | string |
テーブル行の並べ替え基準 |
|
フィルター
|
filter | string |
テーブル行のフィルター基準 |
|
最終更新日時
|
last_updated_at | date-time |
この日付以降に更新された行をフィルターする |
|
最終作成日
|
last_created_at | date-time |
この日付以降に作成された行をフィルターする |
|
次のページのトークン
|
next_page_token | string |
結果の次のページを取得するトークン |
|
Columns
|
columns | array |
応答に含める特定の列 |
|
個別の列
|
distinct_columns | array |
個別のフィルタリングを適用する列 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
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 |
トッププロジェクト見出しスタイルの削除
トップ プロジェクトの新しい見出しスタイルを削除する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
トップ見出しスタイルを削除するプロジェクトの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | SimpleProject | |
metadata
|
metadata | object |
パブリック ID でタグを取得する
そのパブリック ID でタグを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
パブリック ID のタグ
|
tag_id | True | string |
取得するタグのパブリック ID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | Tag | |
metadata
|
metadata | object |
パブリック ID によるユーザー詳細の取得
パブリック ID で特定のユーザーの情報を取得する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
パブリック ID
|
public_id | True | uuid |
ユーザーが取得するパブリック UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | User | |
metadata
|
metadata | object |
メタデータ オブジェクト |
パブリック プロジェクトを取得する
ユーザーがメンバーであるすべての公開プロジェクトを取得します
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of HomeProject | |
metadata
|
metadata | object |
追加のメタデータ |
ビューのすべての行のストリーム
特定のテーブル ビューのすべての行のデータをストリーミングします。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ビュー ID
|
view_id | True | uuid |
要求されたデータ ストリーミングのテーブル ビューの UUID。 |
フィルター
|
filter | string |
データのストリーミングに適用するフィルター。 |
|
並び替え
|
sort | string |
データのストリーミングの並べ替えパラメータ。 |
|
プロセス ID
|
process_id | uuid |
データをフィルタリングするプロセスのオプションの UUID。 |
|
ぺージ
|
page | integer |
ページ割り付けのページ番号 |
|
規模
|
size | integer |
ページ割り付けのページごとのアイテムの数 |
戻り値
- 返答
- binary
ビューのチャートデータの取得
特定のテーブル ビューに基づいてグラフを生成するためのデータを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ビュー ID
|
view_id | True | uuid |
要求されたチャート データのテーブル ビューの UUID。 |
グラフの種類
|
chart_type | string |
取得されたデータのチャートの種類。 |
|
凡例の表示
|
show_legend | boolean |
チャートに凡例を表示するかどうかを示すフラグ。 |
|
値の表示
|
show_values | boolean |
チャートに値を表示するかどうかを示すフラグ。 |
|
列の値 ID
|
column_value_id | uuid |
チャート画像の値ソースとして使用される列の UUID。 |
|
列ラベル ID
|
column_label_id | uuid |
チャート画像のラベル ソースとして使用される列の UUID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of object | |
アイテム
|
data | object | |
metadata
|
metadata | object |
ビューの列の更新
テーブル ビュー内の特定の列を更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ビュー ID
|
view_id | True | uuid |
更新する列を含むテーブル ビューでの UUID。 |
列 ID
|
column_id | True | uuid |
更新するテーブル ビューの列の UUID。 |
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 | |||
hardValidation
|
hardValidation | boolean | ||
isIndexed
|
isIndexed | boolean | ||
isJoined
|
isJoined | boolean | ||
kind
|
kind | string | ||
manualOptions
|
manualOptions | array of string | ||
tableOptions
|
tableOptions | |||
ロック済み
|
locked | boolean | ||
mortaSynced
|
mortaSynced | integer | ||
名称
|
name | string | ||
procoreSynced
|
procoreSynced | integer | ||
publicId
|
publicId | uuid | ||
required
|
required | boolean | ||
reviztoIssuesSynced
|
reviztoIssuesSynced | integer | ||
スクリプト
|
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 | integer |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | TableViewColumn | |
metadata
|
metadata | object |
ビューへの列の追加
特定のテーブル ビューに新しい列を追加する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ビュー ID
|
view_id | True | uuid |
その列を追加するテーブル ビューの UUID。 |
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 | |||
hardValidation
|
hardValidation | boolean | ||
isIndexed
|
isIndexed | boolean | ||
isJoined
|
isJoined | boolean | ||
kind
|
kind | string | ||
manualOptions
|
manualOptions | array of string | ||
tableOptions
|
tableOptions | |||
ロック済み
|
locked | True | boolean | |
mortaSynced
|
mortaSynced | integer | ||
名称
|
name | True | string | |
procoreSynced
|
procoreSynced | integer | ||
publicId
|
publicId | uuid | ||
required
|
required | True | boolean | |
reviztoIssuesSynced
|
reviztoIssuesSynced | integer | ||
スクリプト
|
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 | integer |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | TableViewColumn | |
metadata
|
metadata | object |
ビューデータを csv ファイルとしてダウンロードする
特定のテーブル ビューのデータを CSV 形式でダウンロードします。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ビュー ID
|
view_id | True | uuid |
CSV としてダウンロードされたテーブル ビューの UUID。 |
フィルター
|
filter | string |
CSV データに適用するフィルター |
|
並び替え
|
sort | string |
CSV データの並べ替えパラメータ。 |
|
プロセス ID
|
process_id | uuid |
データをフィルタリングするプロセスのオプションの UUID。 |
戻り値
- 返答
- binary
ビュー列が使用されているか確認する
特定のテーブル列が使用されているすべてのビューを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
列を含むテーブルの UUID |
列 ID
|
column_id | True | uuid |
ビューをチェックインする列の UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of TableView | |
metadata
|
metadata | object |
ピン留めされたプロジェクトを取得する
Firebase ID で識別されたユーザーがピン留めしたプロジェクトを取得します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Firebase Id
|
firebase_id | True | string |
ピン留めされたプロジェクトが取得されたユーザーの Firebase ID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of object | |
共同作成者
|
data.contributors | integer |
プロジェクトへの共同作成者の数 |
名称
|
data.name | string |
プロジェクトの名前 |
primaryColour
|
data.primaryColour | string |
プロジェクトのプライマリ色 |
publicId
|
data.publicId | uuid |
プロジェクトのパブリック ID |
ビュー
|
data.views | integer |
プロジェクトのビュー数 |
metadata
|
metadata | object |
メタデータ オブジェクト |
フォーカス ビューを既定のビューとして設定する
特定のテーブル ビューをテーブルのデフォルト ビューとして指定します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ビュー ID
|
view_id | True | uuid |
既定として設定されるテーブル ビューの UUID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | TableView | |
metadata
|
metadata | object |
プロジェクト シークレットの更新
プロジェクトの特定のシークレットを更新する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
シークレットがあるプロジェクトの UUID |
シークレット ID
|
secret_id | True | uuid |
更新されたシークレットの UUID |
名称
|
name | True | string | |
価値
|
value | True | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | ProjectSecret | |
metadata
|
metadata | object |
プロジェクト シークレットを削除する
プロジェクトから特定のシークレットを削除する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
シークレットを削除するプロジェクトの UUID |
シークレット ID
|
secret_id | True | uuid |
削除するシークレットの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
metadata
|
metadata | object |
プロジェクト シークレットを取得
指定されたプロジェクトに招待されたすべてのシークレットを取得します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
取得されたシークレットのプロジェクトの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of ProjectSecret | |
metadata
|
metadata | object |
プロジェクト タグの取得
指定されたプロジェクトに関連したすべてのタグを取得する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
取得されたタグのプロジェクトの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of object | |
セル
|
data.cells | array of object | |
名称
|
data.cells.column.name | string | |
publicId
|
data.cells.column.publicId | uuid | |
id
|
data.cells.id | string | |
価値
|
data.cells.value | string | |
名称
|
data.name | string | |
publicId
|
data.publicId | uuid | |
metadata
|
metadata | object |
プロジェクト テーブルを取得する
UUID で識別される特定のプロジェクトに関連付けられたテーブルを取得する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
テーブルを取得するプロジェクトの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of Table | |
metadata
|
metadata | object |
プロジェクト メンバーの取得
指定されたプロジェクトに関連したすべてのメンバーを取得する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
取得されたメンバーが取得されたプロジェクトの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of ProjectListWithUserTags | |
metadata
|
metadata | object |
プロジェクト リソースの取得
UUID で識別される特定のプロジェクトに関連付けられたリソースを取得する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
リソースを取得するプロジェクトの UUID |
adminView
|
adminView | boolean | ||
excludeProcesses
|
excludeProcesses | boolean | ||
excludeTables
|
excludeTables | boolean | ||
onlyDeleted
|
onlyDeleted | boolean | ||
projectPermissions
|
projectPermissions | boolean | ||
typeId
|
typeId | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of object | |
名称
|
data.name | string |
リソースの名前 |
process
|
data.process | PermissionedProcess | |
テーブル
|
data.table | SimpleDocumentTable | |
タイプ
|
data.type | string |
リソースの種類 (プロセスまたはテーブル) |
metadata
|
metadata | object |
プロジェクトからユーザーを削除します
プロジェクトの UUID とユーザーの Firebase ID で識別される、プロジェクトからユーザーを削除する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
プロジェクトの UUID |
Firebase Id
|
firebase_id | True | string |
削除するユーザーのFirebase ID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | SimpleProject | |
metadata
|
metadata | object |
プロジェクトのお気に入りステータスを切り替える
現在ログインしているユーザーのプロジェクトをお気に入りにするかどうかを変更する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
お気に入りステータスを切り替えるプロジェクトのパブリック ID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of object | |
isDeleted
|
data.isDeleted | boolean |
プロジェクトが削除済みの場合に指定する |
名称
|
data.name | string |
プロジェクトの名前 |
projectRole
|
data.projectRole | string |
プロジェクトのユーザーのロール |
publicId
|
data.publicId | uuid |
プロジェクトのパブリック ID |
metadata
|
metadata | object |
追加のメタデータ |
プロジェクトのピンステータスを切り替える
現在ログインしているユーザーのプロジェクトをピン留めするかどうかを変更する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
ピン留めステータスを切り替えるプロジェクトのパブリック ID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of object | |
共同作成者
|
data.contributors | integer |
プロジェクトへの共同作成者の数 |
名称
|
data.name | string |
プロジェクトの名前 |
primaryColour
|
data.primaryColour | string |
プロジェクトのプライマリ色 |
publicId
|
data.publicId | uuid |
プロジェクトのパブリック ID |
ビュー
|
data.views | integer |
プロジェクトのビュー数 |
metadata
|
metadata | object |
追加のメタデータ |
プロジェクトのユーザーに招待を再送信する
プロジェクトのユーザーに招待を再送信します。 これは、新規ユーザーと以前に招待された既存ユーザーの両方に適用されます。 所有者または管理者のアクセス許可が必要です。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
招待が再送されているプロジェクトの UUID |
招待 ID
|
invite_id | True | uuid |
再送する招待状の UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
metadata
|
metadata | object |
プロジェクトの変数を取得する
指定されたプロジェクトに関連したすべての変数を取得する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
取得された変数のプロジェクトの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of object | |
セル
|
data.cells | array of object | |
名称
|
data.cells.column.name | string | |
publicId
|
data.cells.column.publicId | uuid | |
id
|
data.cells.id | string | |
価値
|
data.cells.value | string | |
名称
|
data.name | string | |
publicId
|
data.publicId | uuid | |
metadata
|
metadata | object |
プロジェクトの復元
以前に削除された、UUID で識別される特定のプロジェクトを復元します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
復元されるプロジェクトの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
metadata
|
metadata | object |
プロジェクトの招待を更新する
プロジェクトで既存の招待を更新する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
招待があるプロジェクトの UUID |
招待 ID
|
invite_id | True | uuid |
更新された招待状の UUID |
tags
|
tags | array of string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | InvitedMember | |
metadata
|
metadata | object |
プロジェクトの招待状を削除する
プロジェクトへの招待状を削除する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
招待を削除するプロジェクトの UUID |
招待 ID
|
invite_id | True | uuid |
削除する招待状の UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
metadata
|
metadata | object |
プロジェクトの複製
既存のプロジェクトの複製の作成
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
複製されるプロジェクトの UUID |
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
duplicatePermissions
|
duplicatePermissions | boolean |
プロジェクトの送信済み通知を取得する
指定されたプロジェクトに送信されたすべての通知を取得します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
取得された送信された通知のプロジェクトの UUID |
ぺージ
|
page | integer |
通知の実行のページ番号 |
|
規模
|
size | integer |
ページごとの通知の実行の番号 |
|
通知 ID
|
notification_id | uuid |
実行をフィルタリングするための特定の通知の UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of NotificationExecution | |
metadata
|
metadata | object |
プロジェクトの通知を受け取る
特定のプロジェクトに関連付けられているすべての通知を取得します。 この エンドポイント には、プロジェクトの所有者レベルの権限を持つユーザーのみがアクセスできます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
取得された通知のプロジェクトの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of Notification | |
metadata
|
metadata | object |
プロジェクトへのユーザーの招待
メールで 1 人のユーザーをプロジェクトに参加するよう招待します。 ユーザーがすでに存在する場合は直接追加され、そうでない場合は招待が送信されます。 所有者または管理者のアクセス許可が必要です。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
ユーザーが招待されているプロジェクトの UUID |
メールアドレス
|
True | |||
tags
|
tags | array of string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
metadata
|
metadata | object |
プロジェクトを削除する
UUID で識別される特定のプロジェクトを削除する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
削除するプロジェクトの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
metadata
|
metadata | object |
プロジェクトメンバーを招待する
指定されたプロジェクトに招待されたすべてのメンバーを取得します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
招待されたメンバーが取得されたプロジェクトの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of InvitedMember | |
metadata
|
metadata | object |
プロジェクト内のプロセスを取得する
UUID で識別される特定のプロジェクトに関連付けられたすべてのプロセスを取得する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
取得されたプロセスのプロジェクトの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of SimpleProcess | |
metadata
|
metadata | object |
プロジェクト内のユーザーの役割を変更する
プロジェクトの UUID とユーザーの Firebase ID で識別される特定のプロジェクト内のユーザーの役割を変更します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
プロジェクトの UUID |
ファイアベース ID
|
firebase_id | True | string |
タイムラインを取得する必要があるユーザーの Firebase ID |
role
|
role | True | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | SimpleProject | |
metadata
|
metadata | object |
プロジェクト内の削除されたテーブルを取得する
UUID で識別される特定のプロジェクトから、削除されたすべてのテーブルを取得します。 プロジェクト所有者のみがアクセスできます。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
削除されたテーブルを取得するプロジェクトの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of Table | |
metadata
|
metadata | object |
プロジェクト内の削除されたプロセスを取得する
UUID で識別される特定のプロジェクトに関連付けられた削除されたプロセスを取得する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
取得された削除されたプロセスのプロジェクトの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of SimpleProcess | |
metadata
|
metadata | object |
プロジェクト内検索
UUID で識別される特定のプロジェクト内で検索操作を実行する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
検索を実行するプロジェクトの UUID |
検索する
|
search | True | string |
クエリ文字列の検索 |
プロセス パブリック ID
|
process_public_id | uuid |
特定のプロセス内での検索を制限するためのプロセスのオプションの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | Answer | |
metadata
|
metadata | object |
プロジェクト情報の取得
その UUID で識別された特定プロジェクトについて詳細情報を取得する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
取得するプロジェクトの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
フォルダー
|
data.folders | array of object | |
childFolders
|
data.folders.childFolders | array of object | |
名称
|
data.folders.childFolders.name | string | |
名称
|
data.folders.name | string | |
projectDetails
|
data.projectDetails | SimpleProject | |
role
|
data.role | string |
プロジェクトのユーザーのロール |
metadata
|
metadata | object |
プロセス セクションの削除
特定のプロセス セクションを削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
プロセスの UUID。 |
プロセス セクション ID
|
process_section_id | True | uuid |
削除するプロセス セクションの UUID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | MortaProcessSection | |
metadata
|
metadata | object |
プロセス セクションの取得
特定のプロセス セクションを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
プロセスの UUID。 |
プロセス セクション ID
|
process_section_id | True | uuid |
プロセス セクションの UUID。 |
メインの親セクション
|
main_parent_section | boolean |
プロセスセクションのメイン親セクションを取得するためのフラグ |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | MortaProcessSection | |
metadata
|
metadata | object |
プロセス セクションの複製
特定のプロセス セクションを複製します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
プロセスの UUID。 |
プロセス セクション ID
|
process_section_id | True | uuid |
複製するプロセス セクションの UUID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | MortaProcessSection | |
metadata
|
metadata | object |
プロセス セクションの複製
特定のプロセス セクションを非同期で複製します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
プロセスの UUID。 |
プロセス セクション ID
|
process_section_id | True | uuid |
複製するプロセス セクションの UUID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
metadata
|
metadata | object |
プロセス セクション注文の更新
プロセス内のプロセス セクションの順序を更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
プロセスの UUID。 |
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
parentId
|
parentId | uuid | ||
職位
|
position | integer | ||
sectionId
|
sectionId | uuid |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | MortaProcess | |
metadata
|
metadata | object |
プロセス レスポンダーの更新
UUID で識別される特定のプロセスの応答者リストを更新する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
更新するレスポンダーのプロセス答の UUID |
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
レスポンダー
|
responders | array of string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | MortaProcess | |
metadata
|
metadata | object |
プロセスのエクスポート
特定のプロセスを UUID でさまざまな形式 (PDF または DOCX) にエクスポートします
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
エクスポートするプロセスの UUID |
エクスポート形式
|
export_format | string |
エクスポートの形式 (PDF または DOCX) |
|
テーブル リンク
|
table_links | boolean |
エクスポートにテーブル リンクを含める |
|
プロパティ
|
description | boolean |
エクスポートにプロセスの説明を含める |
|
ページの形式
|
page_format | string |
エクスポートのページ形式 |
|
ページの向き
|
page_orientation | string |
エクスポートの印刷の向き |
|
フォントの種類
|
font_type | string |
エクスポートのフォントタイプ |
|
フォント サイズ
|
font_size | integer |
エクスポートのフォント サイズ |
戻り値
- 返答
- binary
プロセスの削除
UUID で識別されるプロセスの削除
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
削除するプロセスの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | MortaProcess | |
metadata
|
metadata | object |
プロセスの複製
既存のプロセスを複製する (別のプロジェクトで複製することも可能)
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
複製されるプロセスの UUID |
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
duplicateLinkedTables
|
duplicateLinkedTables | boolean | ||
duplicatePermissions
|
duplicatePermissions | boolean | ||
targetProjectId
|
targetProjectId | string |
プロセスの複製
既存のプロセスを複製する (別のプロジェクトへの複製も可能)
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
processId
|
processId | True | uuid | |
projectId
|
projectId | uuid |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | MortaProcess | |
metadata
|
metadata | object |
プロセスの詳細の取得
特定のプロセスの UUID による詳細情報を取得します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
取得するプロセスの UUID |
子供を除外する
|
exclude_children | boolean |
プロセス応答から子要素を除外するフラグ |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | MortaProcess | |
metadata
|
metadata | object |
プロセスセクションの復元
依然削除されたプロセス セクションを復元します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
プロセスの UUID。 |
プロセス セクション ID
|
process_section_id | True | uuid |
復元されるプロセス セクションの UUID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | MortaProcessSection | |
metadata
|
metadata | object |
プロセステーブルが使用されているかどうかの確認
指定されたテーブルが使用されているプロセス、テーブル結合、および選択のリストを確認して返します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
使用を確認するテーブルの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of object | |
link
|
data.link | string |
プロセスへの直接リンク、参加または選択 |
名称
|
data.name | string |
テーブルが使用されるプロセス、結合、または選択の名前 |
タイプ
|
data.type | string |
使用タイプ (プロセス、sourceJoin、targetJoin、sourceSelect など) |
metadata
|
metadata | object |
プロセス応答のリセット
既存のプロセス応答を初期状態にリセットします。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
プロセスの UUID。 |
プロセス セクション ID
|
process_section_id | True | uuid |
プロセス セクションの UUID。 |
プロセス応答 ID
|
process_response_id | True | uuid |
リセットするプロセス応答の UUID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | MortaProcessSection | |
metadata
|
metadata | object |
プロセス応答の削除
特定のプロセス応答を削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
プロセスの UUID。 |
プロセス セクション ID
|
process_section_id | True | uuid |
プロセス セクションの UUID。 |
プロセス応答 ID
|
process_response_id | True | uuid |
削除するプロセス応答の UUID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | MortaProcessSection | |
metadata
|
metadata | object |
プロセス応答の復元
依然削除されたプロセス応答を復元します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
プロセスの UUID。 |
プロセス セクション ID
|
process_section_id | True | uuid |
プロセス セクションの UUID。 |
プロセス応答 ID
|
process_response_id | True | uuid |
復元されるプロセス応答の UUID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | ProcessResponse | |
metadata
|
metadata | object |
プロセス応答の提出
プロセス応答を送信し、完了としてマークします。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
プロセスの UUID。 |
プロセス セクション ID
|
process_section_id | True | uuid |
プロセス セクションの UUID。 |
プロセス応答 ID
|
process_response_id | True | uuid |
送信されるプロセス応答の UUID。 |
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
返答
|
response |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | MortaProcessSection | |
metadata
|
metadata | object |
プロセス応答下書きの提出
後で完成させるためにプロセス応答の下書きを送信します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
プロセスの UUID。 |
プロセス セクション ID
|
process_section_id | True | uuid |
プロセス セクションの UUID。 |
プロセス応答 ID
|
process_response_id | True | uuid |
下書きとして送信されるプロセス応答の UUID。 |
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
返答
|
response |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | ProcessSection | |
metadata
|
metadata | object |
ユーザー アカウントの更新
現在ログインしているユーザーのアカウント詳細を更新する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
oldPassword
|
oldPassword | True | string | |
password
|
password | True | string | |
passwordConfirm
|
passwordConfirm | True | string | |
twoFactorCode
|
twoFactorCode | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | UserWithToken | |
metadata
|
metadata | object |
ユーザー テンプレートを取得する
現在ログインしているユーザーがアクセス権を持つすべてのテンプレートを取得
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of object | |
createdBy
|
data.createdBy | SummaryUser | |
metadata
|
metadata | object |
ユーザー プロジェクトの取得
現在ログインしているユーザーが一部であるすべてのプロジェクトを取得する
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of HomeProject | |
metadata
|
metadata | object |
追加のメタデータ |
ユーザーからタグを削除する
特定のユーザーからタグを削除する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ユーザー Id
|
user_id | True | uuid |
タグが削除されるユーザーのパブリック UUID |
タグ ID
|
tag_id | True | uuid |
削除するタグのパブリック UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
metadata
|
metadata | object |
ユーザーが所有および管理するプロジェクトを取得する
ユーザーが所有者または管理者であるすべてのプロジェクトを取得します
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of HomeProject | |
metadata
|
metadata | object |
追加のメタデータ |
ユーザーのAPIキーを作成する
現在ログインしているユーザーの API キーを作成する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
名称
|
name | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | ApiKey | |
metadata
|
metadata | object |
ユーザーのお気に入りのプロジェクトを取得する
現在ログインしているユーザーが一部であるすべてのプロジェクトを取得する
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of object | |
isDeleted
|
data.isDeleted | boolean |
プロジェクトが削除済みの場合に指定する |
名称
|
data.name | string |
プロジェクトの名前 |
projectRole
|
data.projectRole | string |
プロジェクトのユーザーのロール |
publicId
|
data.publicId | uuid |
プロジェクトのパブリック ID |
metadata
|
metadata | object |
追加のメタデータ |
ユーザーのアチーブメントを取得する
Firebase ID でユーザーの実績バッジを取得する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Firebase Id
|
firebase_id | True | string |
アチーブメントが取得されたユーザーの Firebase ID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
createdProcesses
|
data.createdProcesses | integer |
ユーザーによって作成されたプロセスの数 |
createdTables
|
data.createdTables | integer |
ユーザーによって作成されたテーブルの数 |
metadata
|
metadata | object |
メタデータ オブジェクト |
ユーザーのパブリック寄付を取得する
Firebase ID で識別される、ユーザーによるパブリック寄付を取得します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Firebase Id
|
firebase_id | True | string |
パブリック寄付が取得されたユーザーの Firebase ID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of Event | |
metadata
|
metadata | object |
メタデータ オブジェクト |
ユーザーの寄付を取得する
Firebase ID で識別される、ユーザーによる1日あたりの投稿数を取得します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Firebase Id
|
firebase_id | True | string |
寄付金が取得されたユーザーの Firebase ID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | object |
日付でキー付けされた 1 日あたりの寄付 |
metadata
|
metadata | object |
メタデータ オブジェクト |
ユーザーへのタグの追加
タグを特定のユーザーに追加する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ユーザー Id
|
user_id | True | uuid |
タグに追加するユーザーの UUID |
tagReferenceId
|
tagReferenceId | True | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | Tag | |
metadata
|
metadata | object |
追加のメタデータ |
ユーザーを検索する
プロジェクトまたはプロセス別にユーザーを検索する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | uuid |
検索を制限するプロジェクト ID |
|
プロセス ID
|
process_id | uuid |
検索を制限するプロセス ID |
|
テーブル ビュー ID
|
table_view_id | uuid |
検索を制限するテーブルビューID |
|
クエリ
|
query | True | string |
ユーザーの検索に使用するクエリ文字列 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of SummaryUser | |
metadata
|
metadata | object |
追加のメタデータ |
リソースのすべてのイベントを取得する
さまざまな基準でフィルタリングされた、特定のリソースに関連付けられたすべてのイベントを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
リソース ID
|
resource_id | True | uuid |
イベントが取得されたリソースの UUID。 |
タイプ
|
type | True | string |
リソースのタイプ (ユーザー、プロセス、テーブル、プロジェクトなど)。 |
ぺージ
|
page | integer |
ページ割り付けのページ番号。 |
|
Userユーザー
|
user | uuid |
イベントをフィルタリングするユーザーのオプションの UUID。 |
|
動詞
|
verb | array |
イベントをフィルタリングする動詞のオプションのリスト。 |
|
Start Date
|
start_date | date-time |
イベントをフィルタリングするオプションの開始日。 |
|
終了日付
|
end_date | date-time |
イベントをフィルタリングするオプションの終了日。 |
|
検索する
|
search | string |
イベントをフィルタリングするオプションの検索用語。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of Event | |
metadata
|
metadata | object |
リソースのアクセス許可を作成する
特定のリソース (テーブル、テーブル ビュー、プロセスなど) に対する権限を作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
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 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | AccessPolicy | |
metadata
|
metadata | object |
リソースのアクセス許可を削除する
特定のリソース (テーブル、テーブル ビュー、プロセスなど) に対する権限を削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Id
|
id | True | uuid |
削除するポリシーの UUID。 |
リソースのアクセス許可を取得する
特定のリソース (テーブル、テーブル ビュー、プロセスなど) に対する権限を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
リソース
|
resource | True | string |
権限を取得するリソースの種類。 有効なオプションは、'process'、'table'、または 'table_view' です。 |
リソース ID
|
resource_id | True | uuid |
権限を取得するリソースの UUID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of AccessPolicy | |
metadata
|
metadata | object |
リソースのアクセス許可を更新する
特定のリソース (テーブル、テーブル ビュー、プロセスなど) に対する権限を更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Id
|
id | True | uuid |
更新するポリシーの UUID。 |
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
role
|
role | True | integer |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | AccessPolicy | |
metadata
|
metadata | object |
リソースのアクセス許可を要求する
特定のリソース (テーブル、テーブル ビュー、プロセスなど) に対する権限を要求します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
リソースが属するプロジェクトの UUID。 |
タイプ
|
type | True | string |
権限を要求するリソースの種類。 有効なオプションは、'project'、'process'、'table'、または 'view' です。 |
Id
|
id | True | uuid |
権限を要求するリソースの UUID。 |
入力からの結果行をプレビューする
特定のテーブル ビューで、指定された入力からの結果の行をプレビューします。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ビュー ID
|
view_id | True | uuid |
行プレビューが生成されたテーブル ビューの UUID。 |
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
rowData
|
rowData | True | object |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
publicId
|
data.publicId | string | |
rowData
|
data.rowData | object | |
sortOrder
|
data.sortOrder | number | |
metadata
|
metadata | object |
列の一意の値を取得する
テーブル ビュー内の特定の列の一意の値を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ビュー ID
|
view_id | True | uuid |
テーブル ビューの UUID。 |
列 ID
|
column_id | True | uuid |
取得された個別の値の列の UUID。 |
フィルター
|
filter | string |
データ取得に適用するフィルター。 |
|
列のグループ化
|
group_columns | array |
個別の値をグループ化するためのオプションの列。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of string | |
metadata
|
metadata | object |
列の一意の値を取得する
テーブル ビュー内の特定の列の個別の (一意の) 値を取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
列を含むテーブルの UUID |
列 ID
|
column_id | True | uuid |
個別の値を種痘kするための列の UUID |
フィルター
|
filter | string |
(フィルター条件については、ドキュメントを参照してください) |
|
列のグループ化
|
group_columns | array |
グループ化の値に対して列を指定する |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of string | |
metadata
|
metadata | object |
削除されたプロセスセクションを取得する
特定のプロセスセクションのオプションのフィルターを使用して、特定のプロセスの削除されたセクションをすべて取得します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
削除されたセクションから取得するプロセスの UUID |
プロセス セクション ID
|
process_section_id | uuid |
削除されたセクションをフィルタリングするための特定のプロセスセクションのオプションの UUID |
戻り値
削除したテーブルの復元
UUID を使用して、以前に削除されたテーブルを復元します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
復元されるテーブルの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | Table | |
metadata
|
metadata | object |
単一の通知を削除する
ID によって特定の通知を削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Id
|
id | True | uuid |
削除する通知の UUID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
metadata
|
metadata | object |
単一の通知を更新する
ID によって特定の通知を更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Id
|
id | True | uuid |
更新される通知の UUID。 |
プロパティ
|
description | string | ||
プロセス
|
processes | array of uuid | ||
tables
|
tables | array of uuid | ||
publicId
|
publicId | uuid | ||
resource
|
resource | True | string | |
動詞
|
verb | True | string | |
webhookUrl
|
webhookUrl | True | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | Notification | |
metadata
|
metadata | object |
参照によるコメントスレッドの取得
特定の参照に関連付けられたすべてのコメントスレッドを取得します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
参照の種類
|
reference_type | True | string |
コメント スレッドに関連付けられた参照のタイプ (process_section、table、または table_view) |
参照 ID
|
reference_id | True | uuid |
コメントスレッドに関連付けられた参照の UUID |
メイン参照
|
main_reference | string |
追加のフィルタリングのためのオプションのメイン参照 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of CommentThread | |
metadata
|
metadata | object |
実際のテーブルビューデータを取得する
特定のテーブル ビューの実際のデータを取得します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ビュー ID
|
view_id | True | uuid |
データが取得されたテーブル ビューの UUID。 |
フィルター
|
filter | string |
データ取得に適用するフィルター。 |
|
並び替え
|
sort | string |
データ取得の並べ替えパラメータ。 |
|
ぺージ
|
page | integer |
ページ割り付けのページ番号。 |
|
規模
|
size | integer |
ページ割り付けのページごとのアイテムの数 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
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 |
復元プロセス
UUID で識別される削除されたプロセスの復元
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
復元するプロセスの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | MortaProcess | |
metadata
|
metadata | object |
新しいコメントを作成する
特定のコメントスレッド内に新しいコメントを作成する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
コメント スレッド ID
|
comment_thread_id | True | uuid |
コメントが追加されるコメントスレッドの UUID |
commentText
|
commentText | True | string | |
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | Comment | |
変更
|
metadata.change | object |
この操作で行われた変更 |
event
|
metadata.event | string |
この操作のイベント タイプ |
resourceId
|
metadata.resourceId | string |
新しく作成されたコメントの UUID |
新しいドキュメント テーブルを作成する
プロジェクト内に新しいドキュメント テーブルを作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
aconexSynced
|
aconexSynced | integer | ||
aggregate
|
aggregate | integer | ||
alterOptions
|
alterOptions | |||
autodeskBim360Synced
|
autodeskBim360Synced | integer | ||
dateFormat
|
dateFormat | string | ||
decimalPlaces
|
decimalPlaces | integer | ||
プロパティ
|
description | |||
isIndexed
|
isIndexed | boolean | ||
isJoined
|
isJoined | boolean | ||
kind
|
kind | string | ||
manualOptions
|
manualOptions | array of string | ||
tableOptions
|
tableOptions | |||
mortaSynced
|
mortaSynced | integer | ||
名称
|
name | True | string | |
procoreSynced
|
procoreSynced | integer | ||
publicId
|
publicId | uuid | ||
reviztoIssuesSynced
|
reviztoIssuesSynced | integer | ||
スクリプト
|
script | string | ||
scriptEnabled
|
scriptEnabled | boolean | ||
thousandSeparator
|
thousandSeparator | boolean | ||
viewpointSynced
|
viewpointSynced | integer | ||
幅
|
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 | True | string | |
projectId
|
projectId | True | uuid | |
タイプ
|
type | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | Table | |
metadata
|
metadata | object |
新しいプロジェクト シークレットを作成する
指定したプロジェクトに新しいシークレットを作成する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
シークレットが作成されるプロジェクトの UUID |
名称
|
name | True | string | |
価値
|
value | True | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | ProjectSecret | |
metadata
|
metadata | object |
新しいプロジェクトを作成する
指定した名前の新しいプロジェクトを作成する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
名称
|
name | True | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | SimpleProject | |
metadata
|
metadata | object |
新しいプロジェクト見出しスタイルの作成
特定のプロジェクトの新しい見出しスタイルを作成する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
見出しスタイルを作成するプロジェクトの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | SimpleProject | |
metadata
|
metadata | object |
新しいプロジェクト見出しスタイルの更新
特定のプロジェクトの新しい見出しスタイルを更新する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
見出しスタイルを更新するプロジェクトの UUID |
スタイル ID
|
style_id | True | uuid |
更新されたスタイルの UUID |
太字
|
bold | boolean | ||
色
|
colour | string | ||
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
fontSize
|
fontSize | number | ||
斜体
|
italic | boolean | ||
numberingStyle
|
numberingStyle | integer | ||
startAt0
|
startAt0 | boolean | ||
下線
|
underline | boolean |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | SimpleProject | |
metadata
|
metadata | object |
新しいプロセス セクションを作成する
親セクションを設定するオプションのある、指定されたプロセス内に新しいセクションを作成する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
新しいセクションを作成するプロセスの UUID |
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
プロパティ
|
description | |||
名称
|
name | True | string | |
parentId
|
parentId | uuid | ||
plaintextDescription
|
plaintextDescription | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | MortaProcessSection | |
metadata
|
metadata | object |
新しいプロセス セクションを作成する
プロセス内の複数の新しいプロセスセクションを作成する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
新規セクションが作成されるプロセスの UUID |
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 | |||
名称
|
name | True | string | |
parentId
|
parentId | uuid | ||
plaintextDescription
|
plaintextDescription | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of MortaProcessSection | |
metadata
|
metadata | object |
新しいプロセスを作成する
指定したプロジェクトに新しいプロセスを作成する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
名称
|
name | True | string | |
projectId
|
projectId | True | uuid | |
タイプ
|
type | True | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | Process | |
変更
|
metadata.change | object |
プロセス作成中に行われた変更 |
event
|
metadata.event | string |
イベントタイプ (例: 'process.created') |
resourceId
|
metadata.resourceId | uuid |
新しく作成されたプロセスの UUID |
新しいプロセス応答を作成する
プロセス セクションの新しい応答を作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
プロセスの UUID。 |
プロセス セクション ID
|
process_section_id | True | uuid |
プロセス セクションの UUID。 |
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
タイプ
|
type | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | ProcessResponse | |
metadata
|
metadata | object |
新規コメント スレッドを作成する
新規コメント スレッドを作成する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
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 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | CommentThread | |
変更
|
metadata.change | object |
この操作で行われた変更 |
event
|
metadata.event | string |
この操作のイベント タイプ |
resourceId
|
metadata.resourceId | string |
新しく作成されたコメント スレッドの UUID |
新規ユーザーを作成する
新しいユーザーを作成する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
メールアドレス
|
True | |||
名称
|
name | True | string | |
password
|
password | True | string | |
projectId
|
projectId | uuid |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | User | |
metadata
|
metadata | object |
新規通知を作成する
特定のプロジェクトに対して新しい通知を作成します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロパティ
|
description | True | string | |
プロセス
|
processes | array of uuid | ||
projectId
|
projectId | True | uuid | |
tables
|
tables | array of uuid | ||
resource
|
resource | True | string | |
動詞
|
verb | True | string | |
webhookUrl
|
webhookUrl | True | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | Notification | |
metadata
|
metadata | object |
既存のテーブルのセルを更新する
テーブル ビュー内の特定のセルを更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ビュー ID
|
view_id | True | uuid |
更新されるセルのテーブル ビューの UUID。 |
columnName
|
columnName | True | string | |
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
rowId
|
rowId | True | string | |
価値
|
value | |||
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of object | |
publicId
|
data.publicId | string | |
rowData
|
data.rowData | object | |
sortOrder
|
data.sortOrder | number | |
metadata
|
metadata | object |
既存のテーブルを更新する
既存のテーブルのプロパティを更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
更新するテーブルの UUID |
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 | string | ||
名称
|
name | string | ||
syncHourlyFrequency
|
syncHourlyFrequency | integer | ||
タイプ
|
type | string | ||
variables
|
variables | array of string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | Table | |
metadata
|
metadata | object |
既存のプロジェクトを更新する
プロジェクト ID で既存のプロジェクトの詳細を更新する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
更新するプロジェクトの UUID |
defaultProcessId
|
defaultProcessId | uuid | ||
hideProcessCreated
|
hideProcessCreated | boolean | ||
ロゴ
|
logo | string | ||
mfaRequired
|
mfaRequired | boolean | ||
名称
|
name | string | ||
primaryColour
|
primaryColour | string | ||
processTitleBold
|
processTitleBold | boolean | ||
processTitleColour
|
processTitleColour | string | ||
processTitleFontSize
|
processTitleFontSize | number | ||
processTitleItalic
|
processTitleItalic | boolean | ||
processTitleUnderline
|
processTitleUnderline | boolean | ||
公衆
|
public | boolean |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | SimpleProject | |
metadata
|
metadata | object |
既存のプロセス セクションの更新
プロセス セクション ID で既存のプロセス セクションの詳細を更新する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
プロセスの UUID。 |
プロセス セクション ID
|
process_section_id | True | uuid |
更新するプロセス セクションの UUID。 |
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
プロパティ
|
description | |||
名称
|
name | string | ||
pageBreakBefore
|
pageBreakBefore | boolean | ||
pdfIncludeDescription
|
pdfIncludeDescription | boolean | ||
pdfIncludeSection
|
pdfIncludeSection | boolean | ||
plaintextDescription
|
plaintextDescription | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | MortaProcessSection | |
metadata
|
metadata | object |
既存のプロセスの更新
プロセス ID で既存のプロセスの詳細を更新する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
更新するプロセスの UUID |
allowComments
|
allowComments | boolean | ||
allowDuplication
|
allowDuplication | boolean | ||
processPublicId
|
processPublicId | uuid | ||
processResponsePublicId
|
processResponsePublicId | uuid | ||
processSectionPublicId
|
processSectionPublicId | uuid | ||
projectId
|
projectId | uuid | ||
プロパティ
|
description | |||
expandByDefault
|
expandByDefault | boolean | ||
isTemplate
|
isTemplate | boolean | ||
ロゴ
|
logo | string | ||
名称
|
name | string | ||
plaintextDescription
|
plaintextDescription | string | ||
templateCategory
|
templateCategory | string | ||
タイプ
|
type | string | ||
variables
|
variables | array of string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | SimpleProcess | |
metadata
|
metadata | object |
既存のプロセス応答の更新
プロセス セクションの既存の応答を更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
プロセスの UUID。 |
プロセス セクション ID
|
process_section_id | True | uuid |
プロセス セクションの UUID。 |
プロセス応答 ID
|
process_response_id | True | uuid |
更新するプロセス応答の UUID。 |
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 | array of string | ||
タイプ
|
type | string | ||
typeOptions
|
typeOptions |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | MortaProcessResponse | |
metadata
|
metadata | object |
既存の行を更新する
指定されたテーブル ビュー内の既存の行を更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ビュー ID
|
view_id | True | uuid |
行が更新されるテーブル ビューの UUID。 |
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 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of object | |
publicId
|
data.publicId | string | |
rowData
|
data.rowData | object | |
sortOrder
|
data.sortOrder | number | |
metadata
|
metadata | object |
特定のユーザーの詳細を取得する
特定ユーザーに関する情報を取得します
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
Firebase Id
|
firebase_id | True | string |
取得するユーザーの Firebase ID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | User | |
metadata
|
metadata | object |
メタデータ オブジェクト |
特定の行の削除
行 ID に基づいてテーブル ビューから特定の行を削除します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
ビュー ID
|
view_id | True | uuid |
行が削除されるテーブル ビューの UUID。 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
metadata
|
metadata | object |
現在のユーザー プロファイルを更新する
現在ログインしているユーザーのプロファイルを更新する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
bio
|
bio | string | ||
linkedin
|
string | |||
location
|
location | string | ||
名称
|
name | string | ||
organisation
|
organisation | string | ||
profilePicture
|
profilePicture | string | ||
署名
|
signature | string | ||
Twitter
|
string | |||
university
|
university | string | ||
universityDegree
|
universityDegree | string | ||
web サイト
|
website | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | User | |
metadata
|
metadata | object |
統合とテーブルを同期する
指定された統合とテーブルを同期します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
同期するテーブルの UUID。 |
統合名
|
integration_name | True | string |
削除される統合の名前。 |
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 | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
metadata
|
metadata | object |
行をテーブルに追加する
新規行を特定のテーブルに追加します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
テーブル ID
|
table_id | True | uuid |
行化追加されるテーブルの UUID |
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 |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of object | |
publicId
|
data.publicId | string | |
rowData
|
data.rowData | object | |
sortOrder
|
data.sortOrder | number | |
metadata
|
metadata | object |
複数のユーザーをプロジェクトに招待する
メールで複数のユーザーをプロジェクトに参加するよう招待します。 ユーザーがすでに存在する場合、それは直接追加され、そうでない場合は招待が送信されます。 所有者または管理者のアクセス許可が必要です。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロジェクト ID
|
project_id | True | uuid |
ユーザーが招待されているプロジェクトの UUID |
メール
|
emails | array of email | ||
tags
|
tags | array of string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
metadata
|
metadata | object |
複数の新しいプロセスセクションを作成する
それぞれオプションの親セクションを持つ、指定されたプロセス内に複数の新しいセクションを作成する
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
新規セクションが作成されるプロセスの UUID |
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 | |||
名称
|
name | True | string | |
parentId
|
parentId | uuid | ||
plaintextDescription
|
plaintextDescription | string |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | string | |
resourceIds
|
metadata.resourceIds | array of string |
新しく作成されたプロセスセクションの UUID のリスト |
複数の新しいプロセスセクションを更新する
複数の既存のプロセスセクションを更新します。
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
プロセス ID
|
process_id | True | uuid |
プロセスの UUID。 |
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 | |||
名称
|
name | string | ||
pageBreakBefore
|
pageBreakBefore | boolean | ||
pdfIncludeDescription
|
pdfIncludeDescription | boolean | ||
pdfIncludeSection
|
pdfIncludeSection | boolean | ||
plaintextDescription
|
plaintextDescription | string | ||
publicId
|
publicId | True | uuid |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | array of MortaProcessSection | |
metadata
|
metadata | object |
解決コメント スレッド
コメント スレッドの解決
パラメーター
名前 | キー | 必須 | 型 | 説明 |
---|---|---|---|---|
コメント スレッド ID
|
comment_thread_id | True | uuid |
解決するコメント スレッドの UUID |
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | CommentThread | |
変更
|
metadata.change | object |
コメント スレッドに加えられた変更 |
event
|
metadata.event | string |
この操作のイベント タイプ |
resourceId
|
metadata.resourceId | string |
解決されたコメント スレッドの UUID |
詳細を取得する
現在のユーザーの情報を取得する
戻り値
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | User | |
metadata
|
metadata | object |
メタデータ オブジェクト |
定義
AccessAttribute
名前 | パス | 型 | 説明 |
---|---|---|---|
documentTable
|
documentTable | Table3 | |
kind
|
kind | string | |
プロジェクト
|
project | Project | |
publicId
|
publicId | uuid | |
tag
|
tag | Tag | |
user
|
user | User3 |
AccessPolicy
名前 | パス | 型 | 説明 |
---|---|---|---|
accessAttribute
|
accessAttribute | AccessAttribute | |
accessResource
|
accessResource | AccessResource | |
publicId
|
publicId | uuid | |
role
|
role | integer | |
roleLabel
|
roleLabel | string |
AccessResource
名前 | パス | 型 | 説明 |
---|---|---|---|
documentTable
|
documentTable | Table3 | |
kind
|
kind | string | |
process
|
process | Process | |
publicId
|
publicId | uuid |
Action
名前 | パス | 型 | 説明 |
---|---|---|---|
kind
|
kind | string | |
publicId
|
publicId | uuid | |
webhookUrl
|
webhookUrl | string |
Answer
名前 | パス | 型 | 説明 |
---|---|---|---|
回答
|
answers | array of SearchProjectAnswerResources | |
resources
|
resources | array of SearchProjectResources |
ApiKey
名前 | パス | 型 | 説明 |
---|---|---|---|
ハッシュ
|
hash | string | |
名称
|
name | string | |
prefix
|
prefix | string | |
publicId
|
publicId | uuid |
グラフ
名前 | パス | 型 | 説明 |
---|---|---|---|
chartType
|
chartType | string | |
columnLabelId
|
columnLabelId | uuid | |
columnValueId
|
columnValueId | uuid | |
showLegend
|
showLegend | boolean | |
showValues
|
showValues | boolean |
色
名前 | パス | 型 | 説明 |
---|---|---|---|
backgroundColour
|
backgroundColour | string | |
columnId
|
columnId | uuid | |
columnName
|
columnName | string | |
filterType
|
filterType | string | |
fontColour
|
fontColour | string | |
multipleValues
|
multipleValues | array of | |
価値
|
value |
Comment
名前 | パス | 型 | 説明 |
---|---|---|---|
commentText
|
commentText | string | |
createdAt
|
createdAt | date-time | |
deletedAt
|
deletedAt | date-time | |
isOwner
|
isOwner | ||
publicId
|
publicId | uuid | |
updatedAt
|
updatedAt | date-time | |
user
|
user | SummaryUser |
CommentThread
名前 | パス | 型 | 説明 |
---|---|---|---|
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
名前 | パス | 型 | 説明 |
---|---|---|---|
コメントスレッドを開く
|
openCommentThreads | integer | |
referenceId
|
referenceId | uuid | |
resolvedCommentThreads
|
resolvedCommentThreads | integer |
Draftjs
名前 | パス | 型 | 説明 |
---|---|---|---|
コンテント
|
content | DraftjsContent |
DraftjsBlock
名前 | パス | 型 | 説明 |
---|---|---|---|
データ
|
data | ||
depth
|
depth | integer | |
entityRanges
|
entityRanges | array of | |
inlineStyleRanges
|
inlineStyleRanges | array of | |
key
|
key | string | |
text
|
text | string | |
タイプ
|
type | string |
DraftjsContent
名前 | パス | 型 | 説明 |
---|---|---|---|
ブロック
|
blocks | array of DraftjsBlock | |
entityMap
|
entityMap |
イベント
名前 | パス | 型 | 説明 |
---|---|---|---|
変更
|
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 | string |
フィルター
名前 | パス | 型 | 説明 |
---|---|---|---|
columnId
|
columnId | uuid | |
columnName
|
columnName | string | |
filterType
|
filterType | string | |
multipleValues
|
multipleValues | array of | |
orGroup
|
orGroup | string | |
価値
|
value |
Group
名前 | パス | 型 | 説明 |
---|---|---|---|
columnId
|
columnId | uuid | |
columnName
|
columnName | string | |
direction
|
direction | string |
HeadingStyle
名前 | パス | 型 | 説明 |
---|---|---|---|
太字
|
bold | boolean | |
色
|
colour | string | |
fontSize
|
fontSize | number | |
斜体
|
italic | boolean | |
level
|
level | integer | |
numberingStyle
|
numberingStyle | integer | |
publicId
|
publicId | uuid | |
startAt0
|
startAt0 | boolean | |
下線
|
underline | boolean |
HomeProject
名前 | パス | 型 | 説明 |
---|---|---|---|
deletedAt
|
deletedAt | date-time | |
hideProcessCreated
|
hideProcessCreated | boolean | |
isDeleted
|
isDeleted | boolean | |
mfaRequired
|
mfaRequired | boolean | |
名称
|
name | string | |
primaryColour
|
primaryColour | string | |
publicId
|
publicId | string |
IntegrationsPassthroughResponse
名前 | パス | 型 | 説明 |
---|---|---|---|
body
|
body | ||
contentType
|
contentType | string | |
headers
|
headers | ||
ステータス
|
status | string |
InvitedMember
名前 | パス | 型 | 説明 |
---|---|---|---|
createdAt
|
createdAt | date-time | |
メールアドレス
|
string | ||
invitedBy
|
invitedBy | SummaryUser | |
publicId
|
publicId | uuid | |
tags
|
tags | array of Tag |
MortaProcess
名前 | パス | 型 | 説明 |
---|---|---|---|
allowComments
|
allowComments | boolean | |
allowDuplication
|
allowDuplication | boolean | |
子
|
children | array of ProcessSection1 | |
createdAt
|
createdAt | date-time | |
deletedAt
|
deletedAt | date-time | |
プロパティ
|
description | ||
expandByDefault
|
expandByDefault | boolean | |
isDeleted
|
isDeleted | boolean | |
isTemplate
|
isTemplate | boolean | |
ロゴ
|
logo | string | |
名称
|
name | string | |
publicId
|
publicId | uuid | |
templateCategory
|
templateCategory | string | |
タイプ
|
type | string | |
updatedAt
|
updatedAt | date-time | |
variableValues
|
variableValues | array of string | |
variables
|
variables | array of string |
MortaProcessResponse
名前 | パス | 型 | 説明 |
---|---|---|---|
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 | integer | |
publicId
|
publicId | uuid | |
resetAfterResponse
|
resetAfterResponse | boolean | |
responders
|
responders | array of string | |
返答
|
response | ||
responseDate
|
responseDate | date-time | |
タイプ
|
type | string | |
typeOptions
|
typeOptions | ||
updatedAt
|
updatedAt | date-time | |
user
|
user | SummaryUser | |
userResponders
|
userResponders | array of SummaryUser |
MortaProcessSection
名前 | パス | 型 | 説明 |
---|---|---|---|
子
|
children | array of MortaProcessSection | |
createdAt
|
createdAt | date-time | |
deletedAt
|
deletedAt | date-time | |
プロパティ
|
description | Draftjs | |
isDeleted
|
isDeleted | boolean | |
名称
|
name | string | |
openCommentThreads
|
openCommentThreads | integer | |
pageBreakBefore
|
pageBreakBefore | boolean | |
parentId
|
parentId | uuid | |
pdfIncludeDescription
|
pdfIncludeDescription | boolean | |
pdfIncludeSection
|
pdfIncludeSection | boolean | |
職位
|
position | integer | |
publicId
|
publicId | uuid | |
応答
|
responses | array of ProcessResponse | |
ステータス
|
status | integer |
通知
名前 | パス | 型 | 説明 |
---|---|---|---|
アクション
|
actions | array of Action | |
createdAt
|
createdAt | date-time | |
プロパティ
|
description | string | |
プロセス
|
processes | array of Process | |
publicId
|
publicId | uuid | |
tables
|
tables | array of Table1 | |
トリガー
|
triggers | array of Trigger | |
user
|
user | SummaryUser |
Notification1
名前 | パス | 型 | 説明 |
---|---|---|---|
アクション
|
actions | array of Action | |
createdAt
|
createdAt | date-time | |
プロパティ
|
description | string | |
プロセス
|
processes | array of Process | |
publicId
|
publicId | uuid | |
tables
|
tables | array of Table1 | |
トリガー
|
triggers | array of Trigger |
NotificationExecution
名前 | パス | 型 | 説明 |
---|---|---|---|
createdAt
|
createdAt | date-time | |
プロパティ
|
description | string | |
IsSuccess
|
isSuccess | boolean | |
通知
|
notification | Notification1 | |
publicId
|
publicId | uuid | |
updatedAt
|
updatedAt | date-time |
PermissionedProcess
名前 | パス | 型 | 説明 |
---|---|---|---|
createdAt
|
createdAt | date-time | |
deletedAt
|
deletedAt | date-time | |
ロゴ
|
logo | string | |
名称
|
name | string | |
publicId
|
publicId | uuid | |
タイプ
|
type | string | |
updatedAt
|
updatedAt | date-time |
プロセス
名前 | パス | 型 | 説明 |
---|---|---|---|
名称
|
name | string | |
publicId
|
publicId | uuid |
ProcessResponse
名前 | パス | 型 | 説明 |
---|---|---|---|
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 | integer | |
publicId
|
publicId | uuid | |
resetAfterResponse
|
resetAfterResponse | boolean | |
responders
|
responders | array of string | |
返答
|
response | ||
responseDate
|
responseDate | date-time | |
タイプ
|
type | string | |
typeOptions
|
typeOptions | ||
updatedAt
|
updatedAt | date-time | |
user
|
user | SummaryUser | |
userResponders
|
userResponders | array of SummaryUser |
ProcessSection
名前 | パス | 型 | 説明 |
---|---|---|---|
名称
|
name | string | |
publicId
|
publicId | uuid | |
ステータス
|
status | integer |
ProcessSection1
名前 | パス | 型 | 説明 |
---|---|---|---|
子
|
children | array of ProcessSection1 | |
createdAt
|
createdAt | date-time | |
deletedAt
|
deletedAt | date-time | |
プロパティ
|
description | Draftjs | |
isDeleted
|
isDeleted | boolean | |
名称
|
name | string | |
openCommentThreads
|
openCommentThreads | integer | |
pageBreakBefore
|
pageBreakBefore | boolean | |
parentId
|
parentId | uuid | |
pdfIncludeDescription
|
pdfIncludeDescription | boolean | |
pdfIncludeSection
|
pdfIncludeSection | boolean | |
職位
|
position | integer | |
publicId
|
publicId | uuid | |
応答
|
responses | array of ProcessResponse | |
ステータス
|
status | integer |
Project
名前 | パス | 型 | 説明 |
---|---|---|---|
名称
|
name | string | |
publicId
|
publicId | string |
ProjectList
名前 | パス | 型 | 説明 |
---|---|---|---|
createdAt
|
createdAt | date-time | |
favourite
|
favourite | boolean | |
projectRole
|
projectRole | string | |
updatedAt
|
updatedAt | date-time | |
user
|
user | User4 |
ProjectListWithUserTags
名前 | パス | 型 | 説明 |
---|---|---|---|
createdAt
|
createdAt | date-time | |
favourite
|
favourite | boolean | |
projectRole
|
projectRole | string | |
updatedAt
|
updatedAt | date-time | |
user
|
user | User2 |
ProjectSecret
名前 | パス | 型 | 説明 |
---|---|---|---|
createdAt
|
createdAt | date-time | |
名称
|
name | string | |
publicId
|
publicId | uuid | |
updatedAt
|
updatedAt | date-time | |
価値
|
value | string |
SearchProjectAnswerResources
名前 | パス | 型 | 説明 |
---|---|---|---|
label
|
label | string | |
link
|
link | string | |
originalText
|
originalText | string | |
類似性
|
similarity | number | |
text
|
text | string |
SearchProjectResources
名前 | パス | 型 | 説明 |
---|---|---|---|
link
|
link | string | |
text
|
text | string | |
タイプ
|
type | string |
SelectOptionsLookup
名前 | パス | 型 | 説明 |
---|---|---|---|
manualOptions
|
manualOptions | array of string | |
tableOptions
|
tableOptions |
SimpleDocumentTable
名前 | パス | 型 | 説明 |
---|---|---|---|
createdAt
|
createdAt | date-time | |
defaultViewId
|
defaultViewId | string | |
deletedAt
|
deletedAt | date-time | |
isDeleted
|
isDeleted | boolean | |
joins
|
joins | array of TableJoin | |
ロゴ
|
logo | string | |
名称
|
name | string | |
publicId
|
publicId | uuid | |
タイプ
|
type | string | |
updatedAt
|
updatedAt | date-time |
SimpleProcess
名前 | パス | 型 | 説明 |
---|---|---|---|
allowComments
|
allowComments | boolean | |
allowDuplication
|
allowDuplication | boolean | |
子
|
children | array of ProcessSection | |
createdAt
|
createdAt | date-time | |
deletedAt
|
deletedAt | date-time | |
プロパティ
|
description | ||
expandByDefault
|
expandByDefault | boolean | |
isDeleted
|
isDeleted | boolean | |
isTemplate
|
isTemplate | boolean | |
ロゴ
|
logo | string | |
名称
|
name | string | |
publicId
|
publicId | uuid | |
templateCategory
|
templateCategory | string | |
タイプ
|
type | string | |
updatedAt
|
updatedAt | date-time | |
variableValues
|
variableValues | array of string | |
variables
|
variables | array of string |
SimpleProject
名前 | パス | 型 | 説明 |
---|---|---|---|
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 | string | |
isDeleted
|
isDeleted | boolean | |
ロゴ
|
logo | string | |
mfaRequired
|
mfaRequired | boolean | |
名称
|
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 | boolean | |
publicId
|
publicId | string | |
updatedAt
|
updatedAt | date-time |
並び替え
名前 | パス | 型 | 説明 |
---|---|---|---|
columnId
|
columnId | uuid | |
columnName
|
columnName | string | |
direction
|
direction | string |
SummaryUser
名前 | パス | 型 | 説明 |
---|---|---|---|
メールアドレス
|
string | ||
firebaseUserId
|
firebaseUserId | string | |
名称
|
name | string | |
profilePicture
|
profilePicture | string | |
publicId
|
publicId | uuid |
テーブル
名前 | パス | 型 | 説明 |
---|---|---|---|
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 | string | |
名称
|
name | string | |
プロジェクト
|
projects | array of Project | |
publicId
|
publicId | uuid | |
syncHourlyFrequency
|
syncHourlyFrequency | integer | |
タイプ
|
type | string | |
updatedAt
|
updatedAt | date-time | |
variables
|
variables | array of string |
Table1
名前 | パス | 型 | 説明 |
---|---|---|---|
defaultViewId
|
defaultViewId | string | |
名称
|
name | string | |
publicId
|
publicId | uuid |
Table2
名前 | パス | 型 | 説明 |
---|---|---|---|
createdAt
|
createdAt | date-time | |
名称
|
name | string | |
publicId
|
publicId | uuid | |
タイプ
|
type | string | |
updatedAt
|
updatedAt | date-time |
Table3
名前 | パス | 型 | 説明 |
---|---|---|---|
名称
|
name | string | |
publicId
|
publicId | uuid |
TableColumn
名前 | パス | 型 | 説明 |
---|---|---|---|
aconexSynced
|
aconexSynced | integer | |
aggregate
|
aggregate | integer | |
alterOptions
|
alterOptions | ||
autodeskBim360Synced
|
autodeskBim360Synced | integer | |
dateFormat
|
dateFormat | string | |
decimalPlaces
|
decimalPlaces | integer | |
プロパティ
|
description | ||
isIndexed
|
isIndexed | boolean | |
isJoined
|
isJoined | boolean | |
kind
|
kind | string | |
kindOptions
|
kindOptions | SelectOptionsLookup | |
mortaSynced
|
mortaSynced | integer | |
名称
|
name | string | |
procoreSynced
|
procoreSynced | integer | |
publicId
|
publicId | uuid | |
reviztoIssuesSynced
|
reviztoIssuesSynced | integer | |
スクリプト
|
script | string | |
scriptEnabled
|
scriptEnabled | boolean | |
thousandSeparator
|
thousandSeparator | boolean | |
viewpointSynced
|
viewpointSynced | integer | |
幅
|
width | integer |
TableColumnAggregationResult
名前 | パス | 型 | 説明 |
---|---|---|---|
名称
|
name | string | |
価値
|
value | number |
TableColumnJoin
名前 | パス | 型 | 説明 |
---|---|---|---|
sourceColumnId
|
sourceColumnId | string | |
targetColumnId
|
targetColumnId | string |
TableColumnWithAggregation
名前 | パス | 型 | 説明 |
---|---|---|---|
集計
|
aggregation | TableColumnAggregationResult | |
名称
|
name | string | |
publicId
|
publicId | uuid |
TableJoin
名前 | パス | 型 | 説明 |
---|---|---|---|
dataColumns
|
dataColumns | array of TableJoinImportedColumns | |
isOneToMany
|
isOneToMany | boolean | |
joinColumns
|
joinColumns | array of TableColumnJoin | |
joinTableId
|
joinTableId | string | |
joinViewId
|
joinViewId | string | |
publicId
|
publicId | uuid |
TableJoinImportedColumns
名前 | パス | 型 | 説明 |
---|---|---|---|
sourceColumnId
|
sourceColumnId | string | |
targetColumnId
|
targetColumnId | string |
TableView
名前 | パス | 型 | 説明 |
---|---|---|---|
allowContributorDelete
|
allowContributorDelete | boolean | |
chartSettings
|
chartSettings | Chart | |
collapsedGroupView
|
collapsedGroupView | boolean | |
colourSettings
|
colourSettings | array of Colour | |
columns
|
columns | array of TableViewColumn | |
プロパティ
|
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 | string | |
publicId
|
publicId | uuid | |
rowHeight
|
rowHeight | integer | |
sortSettings
|
sortSettings | array of Sort | |
タイプ
|
type | integer | |
unpackMultiselectGroupView
|
unpackMultiselectGroupView | boolean |
TableViewColumn
名前 | パス | 型 | 説明 |
---|---|---|---|
aconexSynced
|
aconexSynced | integer | |
aggregate
|
aggregate | integer | |
alterOptions
|
alterOptions | ||
autodeskBim360Synced
|
autodeskBim360Synced | integer | |
dateFormat
|
dateFormat | string | |
decimalPlaces
|
decimalPlaces | integer | |
プロパティ
|
description | ||
hardValidation
|
hardValidation | boolean | |
isIndexed
|
isIndexed | boolean | |
isJoined
|
isJoined | boolean | |
kind
|
kind | string | |
kindOptions
|
kindOptions | SelectOptionsLookup | |
ロック済み
|
locked | boolean | |
mortaSynced
|
mortaSynced | integer | |
名称
|
name | string | |
procoreSynced
|
procoreSynced | integer | |
publicId
|
publicId | uuid | |
required
|
required | boolean | |
reviztoIssuesSynced
|
reviztoIssuesSynced | integer | |
スクリプト
|
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 | integer |
TableViewWithTable
名前 | パス | 型 | 説明 |
---|---|---|---|
allowContributorDelete
|
allowContributorDelete | boolean | |
chartSettings
|
chartSettings | Chart | |
collapsedGroupView
|
collapsedGroupView | boolean | |
colourSettings
|
colourSettings | array of Colour | |
columns
|
columns | array of TableViewColumn | |
プロパティ
|
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 | string | |
publicId
|
publicId | uuid | |
rowHeight
|
rowHeight | integer | |
sortSettings
|
sortSettings | array of Sort | |
タイプ
|
type | integer | |
unpackMultiselectGroupView
|
unpackMultiselectGroupView | boolean |
Tag
名前 | パス | 型 | 説明 |
---|---|---|---|
documentTableId
|
documentTableId | string | |
projectPublicId
|
projectPublicId | uuid | |
publicId
|
publicId | uuid | |
referencePublicId
|
referencePublicId | string | |
価値
|
value |
トリガー
名前 | パス | 型 | 説明 |
---|---|---|---|
publicId
|
publicId | uuid | |
resource
|
resource | string | |
動詞
|
verb | string |
Userユーザー
名前 | パス | 型 | 説明 |
---|---|---|---|
aconexConnected
|
aconexConnected | boolean | |
apiKeys
|
apiKeys | array of ApiKey | |
autodeskConnected
|
autodeskConnected | boolean | |
bio
|
bio | string | |
constructionSoftware
|
constructionSoftware | array of string | |
メールアドレス
|
string | ||
firebaseUserId
|
firebaseUserId | string | |
kind
|
kind | string | |
linkedin
|
string | ||
location
|
location | string | |
名称
|
name | string | |
organisation
|
organisation | string | |
電話番号
|
phone | string | |
procoreConnected
|
procoreConnected | boolean | |
profilePicture
|
profilePicture | string | |
projectsWorkedOn
|
projectsWorkedOn | array of string | |
publicId
|
publicId | uuid | |
reviztoConnected
|
reviztoConnected | boolean | |
署名
|
signature | string | |
specialisms
|
specialisms | array of string | |
tags
|
tags | ||
Twitter
|
string | ||
university
|
university | string | |
universityDegree
|
universityDegree | string | |
viewpointConnected
|
viewpointConnected | boolean | |
web サイト
|
website | string |
User1
名前 | パス | 型 | 説明 |
---|---|---|---|
名称
|
name | string |
User2
名前 | パス | 型 | 説明 |
---|---|---|---|
メールアドレス
|
string | ||
firebaseUserId
|
firebaseUserId | string | |
kind
|
kind | string | |
名称
|
name | string | |
profilePicture
|
profilePicture | string | |
publicId
|
publicId | uuid | |
tags
|
tags |
User3
名前 | パス | 型 | 説明 |
---|---|---|---|
firebaseUserId
|
firebaseUserId | string | |
名称
|
name | string | |
publicId
|
publicId | uuid |
User4
名前 | パス | 型 | 説明 |
---|---|---|---|
メールアドレス
|
string | ||
firebaseUserId
|
firebaseUserId | string | |
kind
|
kind | string | |
名称
|
name | string | |
publicId
|
publicId | uuid |
UserWithToken
名前 | パス | 型 | 説明 |
---|---|---|---|
aconexConnected
|
aconexConnected | boolean | |
apiKeys
|
apiKeys | array of ApiKey | |
authToken
|
authToken | string | |
autodeskConnected
|
autodeskConnected | boolean | |
bio
|
bio | string | |
constructionSoftware
|
constructionSoftware | array of string | |
メールアドレス
|
string | ||
firebaseUserId
|
firebaseUserId | string | |
hasPassword
|
hasPassword | ||
id
|
id | integer | |
is2FaEnabled
|
is2FaEnabled | ||
isSuperAdmin
|
isSuperAdmin | boolean | |
kind
|
kind | string | |
lastLoginAt
|
lastLoginAt | date-time | |
linkedin
|
string | ||
location
|
location | string | |
名称
|
name | string | |
organisation
|
organisation | string | |
電話番号
|
phone | string | |
procoreConnected
|
procoreConnected | boolean | |
profilePicture
|
profilePicture | string | |
projectsWorkedOn
|
projectsWorkedOn | array of string | |
publicId
|
publicId | uuid | |
reviztoConnected
|
reviztoConnected | boolean | |
署名
|
signature | string | |
specialisms
|
specialisms | array of string | |
tags
|
tags | ||
Twitter
|
string | ||
university
|
university | string | |
universityDegree
|
universityDegree | string | |
viewpointConnected
|
viewpointConnected | boolean | |
web サイト
|
website | string |
binary
これは基本的なデータ型 'バイナリ' です。