Loading...

お知らせ:

当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

Circuits

Catalyst Circuitsを使用すると、Catalystで自動的に実行される一連のタスクを体系的に定義・整理できます。タスクをオーケストレーションしてワークフローを自動化し、さらに条件、データ、パスをワークフローに含めることで、Circuitsを使用してビジネス成果を達成するための反復可能なアクティビティパターンを定義できます。

Catalystは、Circuitを使用したアプリケーションのBasic I/O関数の自動実行をサポートしています。

注意: Circuitsは現在、EU、AU、IN、JP、SAまたはCAデータセンターからアクセスするCatalystユーザーには利用できません。

Circuitの実行

説明

このAPIを使用すると、一意のCircuit IDを参照して、コンソールで設定されたCatalyst Circuitを実行できます。以下に説明するように、リクエストJSONでCircuitへの入力を渡すことができます。

注意: CatalystコンソールからCircuitの作成、設定、テストができます。

リクエスト詳細

リクエストURL

POST

{api-domain}/baas/v1/project/{project_id}/circuit/{circuit_id}/execute

copy

api-domain
URL
Catalyst APIにアクセスするためのDC固有ドメイン

project_id
Numerical
プロジェクトの一意のID

circuit_id
Numerical
Circuitの一意のID

リクエストヘッダー

Authorization: Zoho-oauthtoken {oauth_token}

任意のヘッダー

CATALYST-ORG: {org_id}

Environment: Development

スコープ

ZohoCatalyst.circuits.EXECUTE

リクエストJSONフォーマット

Circuitへの入力は、次のようにJSON形式のキーと値のペアとして送信する必要があります:

copy

{ “key_1”: “value_1”, “key_2”: “value_2”, “key_3”: “value_3”, . . }

注意: Circuitの入力は必須ではありません。Circuitの目的とロジックに基づいて、入力をスキップするか渡すかを選択できます。

レスポンス詳細

レスポンスには、実行されたCircuitの結果と詳細が含まれ、circuit_name、実行のstart_timeとend_time、instance_id、およびCircuitに渡された入力とCircuitの実行から生成された出力の詳細が含まれます。

リクエスト例
copy

curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/circuit/105000000180234/execute
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-d ‘[ { “email”:“j.parker@zylker.com”, “count”:“20”, “traveller_type”:“Single”, “rating”:“5”, “location”:“New York”, “suite”:“Executive” } ]’

レスポンス例
copy
{
    "status": "success",
    "data": {
        "id": "b3c91799-5c18-4626-9983-a2d6af237e20",
        "name": "Case 1",
        "start_time": "Aug 24, 2020 02:24 PM",
        "end_time": "Aug 24, 2020 02:24 PM",
        "status": "success",
        "status_code": 6,
        "execution_meta": {},
        "circuit_details": {
            "name": "StayFinder",
            "ref_name": "StayFinder",
            "description": "",
            "instance_id": "ef9644a5-123a-438c-94d9-01b1bade8817"
        },
        "input": {
            "email":"j.parker@zylker.com",
            "count":"20",
            "traveller_type":"Single", 
            "rating":"5",
            "location":"New York",
            "suite":"Executive"
        },
        "output": {
            "result": {
                "stay_list":{
                    "message":"Email has been sent successfully to j.parker@zylker.com",
                    "status":"success"
                }
            }    
        }
    }
}