ピックリスト

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

Embedded顧客のピックリスト値を取得するには、次のエンドポイントを使用します。 各コネクターのピックリスト名とパラメーターを取得するには、このドキュメントを参照してください。

レート制限

ピックリストリソースには次のレート制限があります:

タイプリソース制限
すべてすべてのピックリストエンドポイント1分あたり60リクエスト

ピックリスト値の取得

Embedded顧客ワークスペース内の指定したコネクションのピックリスト値の一覧を取得します。

POST /api/managed_users/:id/connections/:connection_id/pick_list

URLパラメーター

名前タイプ説明
managed_user_idstring
必須
Embedded顧客ID/外部ID。
外部IDにはEのプレフィックスを付ける必要があり(例: EA2300)、結果のIDはURLエンコードする必要があります。
connection_idstring
必須
コネクションのID。 これはアプリコネクションのURLで確認できるか、コネクションの一覧表示エンドポイントの結果として返されます。

ボディ

名前タイプ説明
pick_list_namestring
必須
ピックリストの名前。 このドキュメントから取得します。
pick_list_paramsオブジェクト
任意
ピックリストパラメーター。一部のピックリストで必要です。 詳細については、このドキュメントを参照してください。

サンプルリクエスト

このcurlリクエストの例では、SalesforceのInvoice__cカスタムオブジェクトにあるsobject_fieldsピックリストから、Salesforceピックリスト値のリストを取得します。

shell
curl  -X POST https://www.workato.com/api/managed_users/135703/connections/318457/pick_list \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{ "pick_list_name": "sobject_fields", "pick_list_params": {"sobject_name": "Invoice__c"}}'

レスポンス

json
{
    "result": [
        [
            "Record ID",
            "Id"
        ],
        [
            "Owner ID",
            "OwnerId"
        ],
        [
            "Deleted",
            "IsDeleted"
        ],
        [
            "Invoice Name",
            "Name"
        ],
        [
            "Created Date",
            "CreatedDate"
        ],
        [
            "Created By ID",
            "CreatedById"
        ],
        [
            "Last Modified Date",
            "LastModifiedDate"
        ],
        [
            "Last Modified By ID",
            "LastModifiedById"
        ],
        [
            "System Modstamp",
            "SystemModstamp"
        ],
        [
            "Last Viewed Date",
            "LastViewedDate"
        ],
        [
            "Last Referenced Date",
            "LastReferencedDate"
        ],
        [
            "External ID",
            "External_ID__c"
        ],
        [
            "Status",
            "Status__c"
        ],
        [
            "Contact",
            "Contact__c"
        ],
        [
            "Intacct Invoice ID",
            "Intacct_Invoice_ID__c"
        ],
        [
            "Multi-select",
            "Multi_select__c"
        ],
        [
            "Invoiced",
            "Invoiced__c"
        ],
        [
            "Number field",
            "Number_field__c"
        ]
    ]
}

Last updated: