プロジェクトプロパティ ​

次のエンドポイントを使用して、プロジェクトプロパティをプログラムで管理します。

レート制限 ​

プロジェクトプロパティリソースには、次のレート制限があります:

クイックリファレンス ​

プロジェクトプロパティの一覧表示 ​

指定したproject_idに一致する、顧客ワークスペース内の特定のプロジェクトに属するプロジェクトレベルのプロパティのリストを返します。 プレフィックスも含める必要があります。 たとえば、プレフィックスsalesforce_sync.を指定すると、指定したproject_idを持つ、salesforce_sync.admin_emailなどのsalesforce_sync.で始まる名前のプロジェクトプロパティが返されます。

GET /api/properties

クエリパラメーター ​

サンプルリクエスト ​

curl  -X GET 'https://www.workato.com/api/properties?prefix=salesforce_sync.&project_id=523144' \
      -H 'Authorization: Bearer <token>' \
      -H 'Content-Type: application/json'

レスポンス ​

{
  "public_url": "https://www.example.com",
  "admin_email": "[email protected]"
}

プロジェクトプロパティのアップサート ​

指定したproject_idに一致する、顧客ワークスペース内の特定のプロジェクトに属するプロジェクトプロパティをアップサートします。 このエンドポイントは、リクエストで指定した名前に基づいてプロパティにマッピングされます。

POST /api/properties

クエリパラメータ ​

ペイロード ​

サンプルリクエスト ​

curl  -X POST 'https://www.workato.com/api/properties?project_id=523144' \
      -H 'Authorization: Bearer <token>' \
      -H 'Content-Type: application/json' \
      -d '{ "properties": { "admin_email": "[email protected]", "public_url": "https://www.example.com" }}'

レスポンス ​

{
  "success": true
}