APIドキュメント
ProcessMindのAPIリファレンスです。開発者向けに、エンドポイント、認証、連携ガイドを掲載しています。
このガイドでは、データの取得や情報の送信、ワークフローの自動化にProcessMind APIを呼び出す方法を、例とベストプラクティスとともに説明します。
リクエスト/レスポンス形式を含む全エンドポイントの詳細は、APIリファレンスをご覧ください。
その他の例やクライアントライブラリについては、GitHubのAPI文書をご覧ください。
すべてのAPIリクエストの送信先:
https://api.processmind.com すべてのルートは/v1以下でバージョン管理されています。機械可読形式のAPI仕様(OpenAPI 3.1)は、次の場所で確認できます。
GET https://api.processmind.com/v1/openapi.json 公開OpenAPI文書(/v1/openapi.json)とMCP OAuthエンドポイントを除き、すべてのAPIリクエストでx-api-keyヘッダーにAPIキーが必要です。
x-api-key: your-api-key-here APIキーはProcessMindアカウントの設定から取得できます。手順についてはAPIキーの取得をご覧ください。
ProcessMind APIでは、標準的なHTTPステータスコードを使用します。
| ステータス | 意味 |
|---|---|
200 OK | リクエスト成功 |
201 Created | リソースを作成しました |
204 No Content | リクエスト成功、レスポンス本文なし |
400 Bad Request | リクエストが無効、またはパラメーターがないか無効 |
401 Unauthorized | APIキーがないか無効 |
403 Forbidden | 認証済みですが、この操作は許可されていません |
404 Not Found | リソースが存在しません |
500 Internal Server Error | 予期しないサーバーエラー |
ProcessMind APIでは、次の操作を実行できます。
以下では、ProcessMind APIでよく使う操作の例を紹介します。
データテーブルにファイルをアップロードするには、まず署名付きURLを取得します。
const presignedUrl = await getPresignedUploadUrl({
apiKey,
tenantId: "tenant-123",
datatableId: "table-456"
});
console.log(presignedUrl); // https://s3.amazonaws.com/…?X-Amz-Signature=… テナント内のすべてのデータセットを取得します。
const datasets = await getDatasets({
apiKey,
tenantId: "tenant-123"
});
console.log(datasets); テナントの詳細情報を取得します。
const tenantInfo = await getTenant({
apiKey,
tenantId: "tenant-123"
});
console.log(tenantInfo); テナントに新しいプロセスを作成します。
const process = await createProcess({
apiKey,
tenantId: "tenant-123",
displayName: "Order to Cash"
});
console.log(process.id); // Use this ID for subsequent operations BPMNファイルをアップロードして、プロセスモデルを定義します。
const fs = require("fs");
const bpmnXml = fs.readFileSync("./my-process.bpmn", "utf8");
await uploadBpmn({
apiKey,
tenantId: "tenant-123",
processId: "process-456",
bpmnXml
}); 分析用にデータテーブルをプロセスに接続します。
const mapping = await createProcessMapping({
apiKey,
tenantId: "tenant-123",
processId: "process-456",
dataTableId: "datatable-789",
displayName: "Sales Data 2024",
showByDefault: true
}); テナントにユーザーを追加します。
const result = await addTenantUser({
apiKey,
tenantId: "tenant-123",
id: "user-456",
email: "colleague@example.com",
isAdminInTenant: false,
isActiveInTenant: true,
sendInvitationEmail: true
}); **注:**本文のロールフィールド(
isAdminInTenant、access、isDashboardViewer)は、指定された値のまま適用されます。ユーザー管理エンドポイントでは、テナント管理者向けのすべての操作が可能です。そのため、書き込み権限を持つAPIキーは、管理権限を任せられる呼び出し元にのみ発行してください。システムAPIから招待メールは送信されません。ユーザーのオンボーディングはご自身で行ってください。
ProcessMindにファイルをアップロードする基本的な流れは次のとおりです。
getPresignedUploadUrl呼び出しを使って署名付きURLを取得します。fetchを使った簡単な例を示します。
async function uploadFile({ apiKey, tenantId, datatableId, file }) {
// Step 1: Obtain a presigned URL
const uploadUrl = await getPresignedUploadUrl({ apiKey, tenantId, datatableId });
// Step 2: Upload the file via PUT
await fetch(uploadUrl, {
method: "PUT",
headers: {
"Content-Type": file.type
},
body: file
});
} info
以下に、さまざまな言語でそのままコピーして使えるコード例を示します。
2回のcurl呼び出しでProcessMindにファイルをアップロードする、必要な値をすべてプレースホルダーにした最小限のBashスクリプト
Bashの例をダウンロード署名付きURLを使って、ローカルのCSVファイルをProcessMindにアップロードします。
手順:
設定:
https://api.processmind.comに設定されています。署名付きURLを使って、ローカルのCSVファイルをリモートAPIにアップロードします。
手順:
設定:
一覧取得エンドポイントでは、limitとoffsetのクエリパラメーターを指定できます。レスポンスはJSON配列のみで、ラッパーや合計件数は含まれません。
| パラメーター | 型 | デフォルト | 最大値 |
|---|---|---|---|
limit | 整数 | 100 | 1,000(データテーブル一覧では250) |
offset | 整数 | 0 | なし |
GET /v1/tenant/{tenantId}/processes?limit=50&offset=100 すべての結果をページ単位で取得するには、レスポンス配列が指定したlimitより短くなる(または空になる)まで、offset += limitを指定してリクエストを繰り返します。最大値を超える値を指定すると、400で拒否されます。バージョン管理されたデータエンドポイント(データセット、バージョン、Webhook)も同じ方式です。2つのデータテーブル一覧では、limitの上限は250です。
/v1以下でバージョン管理されています。互換性を損なう変更は、/v1を予告なく変更するのではなく、新しいバージョンで提供します。info
APIについてご質問やサポートが必要な場合は、サポートチームにお問い合わせいただくか、APIサンプルリポジトリで課題を登録してください。
クレジットカード不要、待ち時間なしですぐにご利用いただけます。組織の業務の進め方を、明確につながるプロセス設計として可視化します。
プロセスアーキテクチャを構築し、オーナーシップと統制を定め、あらゆる階層で役割と責任を明確にします。
無料トライアルを開始して、プロセスのガバナンス、管理、継続的な改善を支える信頼できる基盤を築きましょう。
Cookieを使用して、利便性の向上、コンテンツのパーソナライズ、トラフィックの分析を行っています。Cookieを使わずにページの閲覧状況を匿名で計測しています。「Accept All」をクリックすると、Cookieの使用に同意したことになります。