ハウツーガイド - CLIでのピックリストの実行
このセグメントでは、Workato Gemを使用してメソッドのピックリストを実行する方法について説明します。
前提条件
- Workato SDK Gemをインストール済みで、実行できること。 詳細については、はじめにガイドを参照してください。
- 少なくとも1つのメソッドがある動作中のコネクター。 以下に示すサンプルコネクターを使用すること。
- 動作する認証情報のセットがあること。 サンプルコネクタコードを使用している場合は、そのコネクタに適した認証情報があることを確認してください。
サンプルコネクタ - Chargebee
connector.rb内のコード。
{
title: 'Chargebee-demo',
connection: {
fields: [
{
name: 'api_key',
control_type: 'password',
hint: 'You can find your API key final change3' \
"under 'Settings'=>'Configure Chargebee'=>'API Keys and Webhooks'" \
" in Chargebee's web console.",
label: 'Your API Key'
},
{
name: 'domain',
control_type: 'subdomain',
url: 'chargebee.com'
}
],
authorization: {
type: 'basic_auth',
apply: lambda do |connection|
user(connection['api_key'])
end
},
base_uri: lambda do |connection|
"https://#{connection['domain']}.chargebee.com"
end
},
test: lambda do |_connection|
get('/api/v2/plans', limit: 1)
end,
pick_lists: {
static: lambda do
[
%w[Subscription subscription],
%w[Customer customer],
%w[Plans plan]
]
end,
dynamic: lambda do
get('/api/v2/customers')['list'].map do |index|
[
index['customer']['first_name'],
index['customer']['id']
]
end
end,
dependent: lambda do |connection, params|
get('/api/v2/customers', params)['list'].map do |index|
[
index['customer']['first_name'],
index['customer']['id']
]
end
end,
dependent_with_names: lambda do |connection, limit:|
get('/api/v2/customers', limit: limit)['list'].map do |index|
[
index['customer']['first_name'],
index['customer']['id']
]
end
end
},
}settings.yaml.enc内の認証情報。
api_key: valid_api_key
domain: valid_domainTIP
暗号化されたsettings.yamlファイルを使用している場合、ファイルを編集または作成するにはworkato edit <PATH>を使用する必要があります。 暗号化されたファイルの編集の詳細については、workato editを参照してください。
SDK Gemを使用すると、ピックリストを個別に呼び出せます。
例1。 static pick_listの実行
上記の例で最初に取り上げるpick_listは、static pick_listです。 名前が示すように、静的な値のリストを保存し、呼び出されるとその値を返すだけです。
pick_listを実行する例を次に示します:
$ workato exec pick_lists.static
[
[
"Subscription",
"subscription"
],
[
"Customer",
"customer"
],
[
"Plans",
"plan"
]
]例2。 dynamic pick_listの実行
次のpick_listは、リクエストを送信し、レスポンスをpick_list形式に整形するものです。 ここでは、リクエストを認可するために必要なコネクション設定は、デフォルトのsettings.yaml.encファイルであると想定しています。 これが目的に合わない場合は、--settingsを使用して上書きできます。
pick_listを実行する例を次に示します:
$ workato exec pick_lists.dynamic
[
[
"dd",
"AzyuHzSiORQAo1JUb"
],
[
"fdsfdf",
"16Bji8SfZHHDm7v"
]
]例3。 dependent pick_listの実行
次のpick_listは、リクエストを送信し、レスポンスをpick_list形式に整形するものです。 ここでは、リクエストを認可するために必要なコネクション設定は、デフォルトのsettings.yaml.encファイルであると想定しています。 これが目的に合わない場合は、--settingsを使用して上書きできます。
この例のfixtures/pick_lists/dependent/input.jsonファイルには、次の内容が含まれます:
{
"limit": "1"
}pick_listを実行する例を次に示します:
$ workato exec pick_lists.dependent --args='fixtures/pick_lists/dependent/input.json'
[
[
"dd",
"AzyuHzSiORQAo1JUb"
]
]例4。 dependent_with_names pick_listsの実行
その他の場合では、名前付き引数を受け入れるピックリストがあるかもしれません。 この場合、このピックリストには名前付き引数limit:があります。
CLI経由で引数を渡す場合、ファイルfixtures/pick_lists/dependent_with_names/input.jsonの内容は次のようになります:
{
"limit": "1"
}pick_listを実行する例を次に示します:
$ workato exec pick_lists.dependent_with_names --args='fixtures/pick_lists/dependent_with_names/input.json'
[
[
"dd",
"AzyuHzSiORQAo1JUb"
]
]最終更新日: