環境プロパティ

以下のエンドポイントを使用して、プログラムで環境プロパティを管理できます。

クイックリファレンス

タイプ	リソース	説明
GET	/api/properties	接頭辞と一致する環境プロパティを列挙します。
POST	/api/properties	環境プロパティをアップサートします。

接頭辞別のプロパティの列挙

接頭辞と一致するカスタマーアカウントに属している環境プロパティのリストを返します。たとえば、指定された接頭辞が salesforce_sync. の場合は、名前が「salesforce_sync.」で 始まる すべてのアカウントプロパティが返されます。

GET /api/properties

パラメータ

名前	型	説明
prefix	string 必須	指定された接頭辞を持つプロパティを返します。例 : salesforce_sync.

サンプルリクエスト

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

レスポンス

{
  "salesforce_sync.object_name": "Account",
  "salesforce_sync.object_field": "Id"
}

プロパティのアップサート

環境プロパティをアップサートします。リクエストで指定されたプロパティの名前で照合します。

POST /api/properties

ペイロード

名前	型	説明
properties	Hash 必須	アップサートするプロパティの名前と値を含めます。

サンプルリクエスト

curl  -X POST https://www.workato.com/api/properties \
      -H 'Authorization: Bearer <api_token>'
      -H 'Content-Type: application/json' \
      -d '{ "properties": { "zendesk.object": "Ticket", "zendesk.key": "ticket_id" }}'

レスポンス

{
  "success": true
}