Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial
Embedded API
リソース

Environment properties ​

このページは機械翻訳により提供されています。翻訳内容と英語版に相違がある場合は、英語版が優先されます。

次のエンドポイントを使用して、Environmentをプログラムで管理します:

レート制限 ​

Environment propertyリソースには、次のレート制限があります:

タイプリソース制限
GETプリフィックス別にプロパティを一覧表示:
/api/managed_users/:managed_user_id
/properties		1分あたり1,000リクエスト
すべてその他すべてのEnvironment propertiesエンドポイント1分あたり60リクエスト

クイックリファレンス ​

タイプリソース説明
GET/api/managed_users/:managed_user_id/propertiesプレフィックスに一致する顧客に属するEnvironment propertiesのリストを返します。
POST/api/managed_users/:managed_user_id/properties顧客ワークスペースにEnvironment propertiesをアップサートします。

プレフィックス別にプロパティを一覧表示 ​

プレフィックスに一致する顧客に属するEnvironment propertiesのリストを返します。 たとえば、指定されたプレフィックスがsalesforce_sync.の場合、名前が'salesforce_sync.'で始まるアカウントプロパティが返されます。

GET /api/managed_users/:managed_user_id/properties

URLパラメーター ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客ID/外部ID。
外部IDにはEのプレフィックスを付ける必要があり（例: EA2300）、結果のIDはURLエンコードする必要があります。
prefixstring
必須		指定されたプレフィックスを持つプロパティを返します。 例: salesforce_sync.。

サンプルリクエスト ​

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

レスポンス ​

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

プロパティをアップサート ​

顧客ワークスペースにEnvironment propertiesをアップサートします。 リクエストで指定されたプロパティ名で照合します。

POST /api/managed_users/:managed_user_id/properties

プロパティ制限

Environment propertiesには、次の制限があります:

説明制限
EnvironmentあたりのEnvironment propertiesの最大数1,000
Environment properties名の最大長100文字
Environment properties値の最大長1,024文字

パラメーター ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客ID/外部ID。
外部IDにはEのプレフィックスを付ける必要があり（例: EA2300）、結果のIDはURLエンコードする必要があります。

ペイロード ​

名前タイプ説明
propertiesハッシュ
必須		アップサートするプロパティの名前と値が含まれます。

サンプルリクエスト ​

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

レスポンス ​

json
{
  "success": true
}

Last updated: