Environment properties
以下のエンドポイントを使用して、Environment propertiesをプログラムで管理します。
レート制限
Environment propertyリソースには、次のレート制限があります:
| タイプ | リソース | 制限 |
|---|---|---|
| すべて | すべてのEnvironment propertiesエンドポイント | 1分あたり60リクエスト |
クイックリファレンス
| タイプ | リソース | 説明 |
|---|---|---|
| GET | /api/properties | プレフィックスに一致するEnvironment propertiesの一覧を取得します。 |
| POST | /api/properties | Environment propertiesを作成または更新します。 |
プレフィックス別にプロパティを一覧表示
プレフィックスに一致する顧客に属するEnvironment propertiesのリストを返します。 たとえば、指定されたプレフィックスがsalesforce_sync.の場合、名前が'salesforce_sync.'で始まるEnvironment propertiesが返されます。
GET /api/propertiesパラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
| prefix | string 必須 | 指定されたプレフィックスを持つプロパティを返します。 例:salesforce_sync.。 |
サンプルリクエスト
shell
curl -X GET 'https://www.workato.com/api/properties?prefix=salesforce_sync.' \
-H 'Authorization: Bearer <api_token>' \
-H 'Content-Type: application/json' \レスポンス
json
{
"salesforce_sync.object_name": "Account",
"salesforce_sync.object_field": "Id"
}プロパティをアップサート
Environment propertiesを作成または更新します。 リクエストで指定されたプロパティ名で照合します。
POST /api/propertiesプロパティ制限
Environment propertiesには、次の制限があります:
| 説明 | 制限 |
|---|---|
| EnvironmentあたりのEnvironment propertiesの最大数 | 1,000 |
| Environment properties名の最大長 | 100文字 |
| Environment properties値の最大長 | 1,024文字 |
ペイロード
| 名前 | タイプ | 説明 |
|---|---|---|
| properties | ハッシュ 必須 | アップサートするプロパティの名前と値が含まれます。 |
サンプルリクエスト
shell
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" }}'レスポンス
json
{
"success": true
}Last updated: