Catalyst API入門
概要
Catalyst APIは、アプリケーション開発者がアプリケーション内でCatalystコンポーネントをリモートで操作するための幅広い機能を提供します。APIを使用してCatalystアプリケーションを構築・管理したり、Catalyst Webコンソールを使用する場合と同様にリモート操作を実行したりすることができます。
たとえば、各APIを使用して、Data Storeのテーブルへのデータ挿入、File Storeのフォルダー詳細の取得、関数の実行などの操作を行うことができます。
CatalystはREST API標準を実装しており、リソースへのアクセスにHTTPリクエストとレスポンスをサポートしています。CatalystリソースはエンドポイントURLを通じて公開されており、HTTPクライアントは各エンドポイントに対応するAPIを使用してアクセスできます。
Catalystは以下の基本的なREST API原則を実装しています:
- Catalystリソースの各インスタンスのエンドポイントURLは一意です。
- リクエスト内のHTTPメソッドが、リソースに対して実行される操作を決定します。
- 追加のペイロード情報はリクエストのパラメーターとして渡されます。これには実行する操作の詳細が含まれます。
- 各リクエストはCatalystからのレスポンスを開始します。
詳細と例については、リクエスト形式およびレスポンス形式セクションを参照してください。
前提条件
Catalyst APIの使用を開始する前に、以下の前提条件を満たしていることを確認してください:
- 有効なZohoユーザーアカウント: 有効なZohoログインメールアドレスとパスワードを持っていることを確認してください。Zohoアカウントはこちらから登録できます。
- 認証トークン: Catalyst APIにアクセスするには、有効なOAuth access_tokenを取得する必要があります。
OAuth 2.0認証セクションのヘルプページで、認証トークンの理解と取得のプロセスについてご案内します。
すべてのCatalyst APIは、Catalyst App Administratorロールのユーザー（Catalystアプリケーション開発者）がaccess_tokenを取得した後にアクセスできます。特定のプロジェクトのすべてのコラボレーターも、access_tokenを使用してすべてのCatalyst APIを実行できます。
ただし、App Userロールのユーザー（Catalyst認証を持つCatalystアプリケーションのエンドユーザー）がアクセスできるのは、特定の操作のみです。エンドユーザーは、特定のアプリケーションデータへのアクセスに関連する操作のみを実行でき、アプリケーションを変更する操作は実行できません。各APIヘルプページでは、定義された実行権限に関する情報が提供されます。
注意:
-
認証トークンを生成せずにCatalyst操作を実行したい場合は、代わりにCatalyst SDKを使用できます
-
Catalystは現在、Catalystアプリケーションのエンドユーザー向けの個別のAPI認証プロセスをサポートしていません。アプリケーションコードにCatalyst SDKを実装した場合、認証はApp Administrator認証として自動的に処理されます。Catalyst APIを独立して使用するには、OAuth 2.0認証セクションに記載されている手順に従って、OAuth認証トークンを生成する必要があります。
マルチDCサポート
概要
Catalystは現在、7つのデータセンターでホストされています。すべてのCatalyst APIにアクセスするためのベースAPI URIおよびZoho AccountsサーバーURIは、アクセスするデータセンターによって異なります。
CatalystでAPIリクエストを送信する際は、ロケーションに基づいた適切なドメインを使用する必要があります。これにより、ブラウザーとの競合を防ぎ、現在のセッションとのスムーズな統合が可能になります。
CatalystがすべてのAPIに対してサポートする7つのデータセンターとそれぞれのベースAPI URIは以下のとおりです:
- US（アメリカ）: https://api.catalyst.zoho.com
- EU（ヨーロッパ）: https://api.catalyst.zoho.eu
- IN（インド）: https://api.catalyst.zoho.in
- AU（オーストラリア）: https://api.catalyst.zoho.com.au
- CA（カナダ）: https://api.catalyst.zohocloud.ca
- JP（日本）: https://api.catalyst.zoho.jp
- SA（サウジアラビア）: https://api.catalyst.zoho.sa
OAuth 2.0認証を実装する際に使用する、7つのデータセンターに対応するZoho AccountsサーバーURIは以下のとおりです:
- US: https://accounts.zoho.com
- EU: https://accounts.zoho.eu
- IN: https://accounts.zoho.in
- AU: https://accounts.zoho.au
- CA: https://accounts.zohocloud.ca
- JP: https://accounts.zoho.jp
- SA: https://accounts.zoho.sa
使用方法
CatalystのマルチDCサポートを利用するには、以下のアクションを実行してください:
- OAuth 2.0認証を実装するすべてのステップ（grant token、access token、またはrefresh tokenの生成のための認可リクエスト時など）で、適切なZoho AccountsサーバーURIを使用する必要があります。
たとえば、EUデータセンター向けにリダイレクト方式でgrant tokenを生成するために、以下のリクエストを行うことができます:
redirect URIにリダイレクトされた後、grant tokenを含むレスポンスが返されます。以下のようにlocationパラメーターが含まれます:
このlocationパラメーターは、アカウントのドメインを指定します。この場合、locationはeuとして返されます。
- Zoho APIコンソールでクライアントを登録した後、マルチDCサポートを有効にできます。これにより、特定のドメインのユーザーのみにアプリケーションへのアクセスを提供できます。たとえば、INユーザーのアプリケーションへのアクセスを無効にし、他のユーザーのアクセスを有効にできます。詳細については、新規クライアント登録セクションを参照してください。
- 前述のとおり、APIリクエストの送信時に適切なベースAPI URIを使用する必要があります。たとえば、Data Storeのテーブル内のすべての行を取得するには、EUデータセンター向けに以下のリクエストURLを実行する必要があります:
https://api.catalyst.zoho.eu/baas/v1/project/{project_id}/table/{tableIdentifier}/row
マルチOrg対応
概要
Catalystでは、Catalystアカウント内で複数の組織を作成および管理できます。作成した各組織に対して一意のOrg IDが生成されます。各組織内で個別のプロジェクトを作成し、プロジェクトに貢献するメンバーにアクセス権限を割り当てることもできます。
アカウント内でデフォルトとして設定できる組織は1つだけです。デフォルトに設定された組織は、Catalystアカウントにサインインするたびに自動的にログインされます。
CatalystからAPIを実行すると、自動的にデフォルトの組織に対して実行されます。たとえば、APIリクエストでプロジェクトIDを渡すと、Catalystはデフォルトの組織内で同じIDのプロジェクトを自動的に検索します。ただし、デフォルト以外の組織に対してAPIを実行するには、リクエストでその組織の一意のOrg IDを明示的に渡す必要があります。
使用方法
組織内のプロジェクトにアクセスするために、以下の形式でAPIリクエストのヘッダーとしてOrg IDを渡すことができます:
-H CATALYST-ORG: 15090237
完全なリクエスト例は、リクエスト形式セクションで確認できます。
リクエスト形式
リクエストメソッド
Catalyst APIはREST標準に準拠しており、以下の目的に対してクライアントリクエスト用の以下のHTTPメソッドをサポートしています:
- GET : Catalystリソースからレコードを取得する
- POST : Catalystリソースに新しいレコードを挿入する
- PUT : Catalystリソースの既存レコードを更新する
- DELETE : Catalystリソースの既存レコードを削除する
Catalyst APIリクエストを実行する際に、操作のリクエストメソッドを指定する必要があります。
リクエストURL
APIリクエストはCURL形式で送信されます。一般的なリクエストURLの形式は以下のとおりです:
https://api.catalyst.zoho.com/baas/v1/project/{project_id}
/{resource_name}/{additional_resource_details}
注意: 他のデータセンターのベースAPI URLは以下のとおりです:
- EU: https://api.catalyst.zoho.eu
- IN: https://api.catalyst.zoho.in
- AU: https://api.catalyst.zoho.com.au
- CA: https://api.catalyst.zohocloud.ca
- JP: https://api.catalyst.zoho.jp
- SA: https://api.catalyst.zoho.sa
リクエストURLで渡される一般的なパラメーターには、CatalystプロジェクトのプロジェクトIDと、アクセスする特定のリソースインスタンスのリソースIDが含まれます。
リクエストヘッダー
cURLリクエストで渡される必須ヘッダーは以下のとおりです:
- Authorizationヘッダー: OAuthトークン（access_token）
cURLリクエストで渡される推奨ヘッダーは以下のとおりです:
- Content-Type: 渡されるリソースのメディアタイプを示すREST API標準です。たとえば、APIリクエストにJSONペイロードやフォームデータが含まれる場合、このヘッダーを渡すことを強く推奨します。
cURLリクエストで渡される任意のヘッダーは以下のとおりです:
- Org ID: デフォルト以外の組織のOrg ID。Org IDはCatalystコンソールのマルチOrgポータルから取得できます。
- Environment: リクエストが実行される環境を指定する環境ヘッダー。APIリクエストをプロジェクトの開発環境と本番環境のどちらで実行するかを指定できます。
リクエストボディ
リクエストの目的に応じて、API呼び出しのリクエストボディに追加データを渡すことができます。たとえば、テーブルのカラムを更新するためのカラム名と値、フォルダーを作成するためのフォルダー名などです。
ヘッダーやリクエストで渡すJSON属性など、送信するリクエストの詳細は、各APIヘルプページで指定されています。
curl “https://api.catalyst.zoho.com/baas/v1/project/4000000006007/segment/4000000006023/cache"
-X POST
-d ‘{“cache_name”:“City”,“cache_value”:“London”}’
-H “CATALYST-ORG: 15090237”
-H “Environment:Development”
-H “Content-Type:application/json”
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57"”
レスポンス形式
概要
すべてのCatalyst APIレスポンスはJSON形式で返されます。レスポンスは、Catalystサーバーによってリクエストが処理された後に送信されます。
一般的なレスポンスには、リクエスト処理のステータス（successまたはfailure）と、リクエストに基づくデータセットが含まれます。たとえば、リソース内のレコードを削除するリクエストの場合、データには削除されたレコードの詳細が含まれます。各APIのレスポンス詳細は、それぞれのヘルプページで詳しく記載されています。
リクエストが正常に処理されなかった場合、レスポンスには発生したエラーを示す適切なエラーコードが含まれます。次のセクションでは、Catalystが認識するエラーコードとその説明を記載しています。
{
"status": "success",
"data": {
"cache_name": "City",
"cache_value": "London",
"project_details": {
"id": 56000000087108,
"project_name": "ShipmentTracking"
},
"segment_details": {
"id": 56000000112489,
"segment_name": "CustomerLocation"
},
"expires_in": "Mar 28, 2019 02:03 AM",
"expiry_in_hours": 7
}
}
エラーコード
サーバーがクライアントリクエストの処理中にエラーが発生した場合、適切なHTTPステータスコードをレスポンスとしてクライアントに返します。Catalystが認識するエラーは以下のとおりです:
| HTTPステータスコード | エラーコード | 説明 |
|---|---|---|
| 403 | API_LIMIT_REACHED | アカウントのAPI呼び出し上限に達しました。ライセンスプランをアップグレードしてください。 |
| 409 | CONFLICT | 既存の値と矛盾しています。別の値を指定してください。 |
| 409 | DUPLICATE_ENTRY | 入力されたメールIDはすでに存在しています。別のメールIDを指定してください。 |
| 409 | DUPLICATE_ENTRY | ドメイン名はすでに存在しています。別の値を指定してください。 |
| 409 | DUPLICATE_OPERATION | 要求された操作はすでに進行中です。完了するまでお待ちください。 |
| 409 | DUPLICATE_VALUE | 入力された値はすでに存在しています。別の値を指定してください。 |
| 500 | EMAIL_ERROR | メール送信処理が失敗しました。しばらくしてから再試行してください。 |
| 410 | EXPIRED | 要求されたリソースの有効期限が切れています。再度作成してください。 |
| 410 | EXPIRED_LOG | ダウンロードしようとしているレスポンスログの有効期限が切れています。 |
| 202 | FUNCTION_ERROR | 内部サーバーエラーが発生しました。 |
| 500 | INTERNAL_SERVER_ERROR | 内部サーバーエラーが発生しました。 |
| 403 | INVALID_CONTENT | 指定された入力は受け入れ可能な形式ではありません。 |
| 404 | INVALID_ID | 指定されたリソースIDは存在しません。 |
| 400 | INVALID_INPUT | 指定されたテーブル名は存在しません。 |
| 400 | INVALID_INPUT | 指定されたカラム名は存在しません。 |
| 400 | INVALID_INPUT | 指定された外部キーが親テーブルのROWIDと一致しません。 |
| 400 | INVALID_INPUT | 指定された入力は有効ではありません。 |
| 404 | INVALID_NAME | 指定されたメールIDは存在しません。 |
| 404 | INVALID_NAME | 指定されたテーブル名は存在しません。 |
| 403 | INVALID_OPERATION | 要求された操作は無効です。 |
| 405 | INVALID_REQUEST_METHOD | 要求されたメソッドは受け付けられません。 |
| 400 | MISMATCH | 指定された値が期待される値と一致しません。 |
| 400 | MISSING_FUNCTION | 指定された関数IDは存在しません。 |
| 400 | MISSING_VALUE | 期待される入力が不足しています。 |
| 401 | NO_ACCESS | この操作を実行する権限がありません。 |
| 204 | NO_CONTENT_AVAILABLE | リクエストが空のレスポンスを返しました。 |
| 401 | UNAUTHORISED | この操作を実行する権限がありません。 |
| 403 | VERIFICATION_NEEDED | メールアドレスの確認が必要です。 |
| 400 | ZCQL_QUERY_ERROR | クエリの形式が無効です。 |
| 429 | TOO_MANY_REQUESTS | 関数、Webクライアント、またはCatalystコンポーネントの実行の同時実行数制限に達しました。 |
OAuth 2.0認証
概要
OAuth 2.0は、認証と認可のための業界標準プロトコルです。このフレームワークにより、多数のサードパーティクライアントアプリケーションがAPIを通じてZohoの保護されたリソースへの安全な委任アクセスを取得できます。
OAuth 2.0の一般的な特徴:
- クライアントはパスワード認証をサポートしたり、ユーザー資格情報を保存したりする必要がありません。各呼び出しでユーザー資格情報を提供することなく、API呼び出しでリソースにアクセスできます。
- クライアントは、ユーザーが認証したリソースにのみアクセスできます。
- ユーザーはいつでもクライアントの委任アクセスを取り消すことができます。
- OAuth 2.0のaccess tokenは設定された時間後に期限切れとなるため、強力なセキュリティを提供します。
用語
OAuth 2.0の実装手順を学ぶ前に、Catalystにおける以下のOAuth 2.0関連用語を理解する必要があります:
| キーワード | 説明 |
|---|---|
| 保護されたリソース | Cache、Cron、テーブル、フォルダーなどのCatalystリソース |
| リソースサーバー | Catalystの保護されたリソースをホストするCatalystサーバー |
| クライアント | エンドユーザーに代わって保護されたリソースにアクセスするために、リソースサーバーにリクエストを送信するアプリケーション |
| client_id | 登録されたクライアントに対して生成される一意のキー |
| client_secret | 特定の登録済みクライアントのclient_idに対して生成されるシークレット値。Zoho APIコンソールでCatalystアプリケーションを登録すると、client_idとclient_secretが生成されます。 |
| 認証サーバー | access_tokenやrefresh_tokenなどの必要な資格情報をクライアントに提供するCatalyst認可サーバー |
| Grant Tokenまたは code | Catalyst認可サーバーが一時トークンを生成し、ブラウザーを介してクライアントに送信します。クライアントはaccess tokenとrefresh tokenを取得するために、このcodeを認可サーバーに返送します。 |
| access_token | ユーザーの保護されたリソースにアクセスするためにリソースサーバーに送信される一時トークン。クライアントはAPIを使用して関連するアプリケーションにリクエストを行うためにaccess_tokenを使用します。各access_tokenは設定された期間有効であり、スコープで定義された操作のみを実行できます。 |
| refresh_token | 新しいaccess tokenを取得するために使用できるトークン。このトークンはエンドユーザーによって取り消されるまで無期限に有効です。 |
| スコープ | スコープは、クライアントアプリケーションがアクセスできるリソースの種類を制御します。セキュリティ強化のため、各トークンは通常、選択されたスコープで作成されます。たとえば、Data StoreやFile Storeのデータを読み取るだけのスコープでaccess_tokenを生成できます。スコープを定義する標準形式はscope=service_name.scope_name.operation_typeです。次のセクションでは、Catalystで利用可能なスコープを一覧で説明します。 |
Catalystで利用可能なスコープの一覧
| スコープ名 | 利用可能なスコープ |
|---|---|
| projects | ZohoCatalyst.projects.ALL, ZohoCatalyst.project.export.READ, ZohoCatalyst.project.export.CREATE, ZohoCatalyst.project.import.READ, ZohoCatalyst.project.import.CREATE, ZohoCatalyst.project.import.DELETE |
| authentication | ZohoCatalyst.authentication.CREATE |
| tables | ZohoCatalyst.tables.READ, ZohoCatalyst.tables.rows.READ, ZohoCatalyst.tables.rows.CREATE, ZohoCatalyst.tables.rows.UPDATE, ZohoCatalyst.tables.rows.DELETE, ZohoCatalyst.tables.columns.READ |
| folders | ZohoCatalyst.folders.ALL |
| files | ZohoCatalyst.files.CREATE, ZohoCatalyst.files.READ, ZohoCatalyst.files.DELETE |
| cache | ZohoCatalyst.segments.ALL, ZohoCatalyst.cache.READ, ZohoCatalyst.cache.CREATE, ZohoCatalyst.cache.DELETE |
| cron | ZohoCatalyst.cron.ALL |
| zcql | ZohoCatalyst.zcql.CREATE |
| functions | ZohoCatalyst.functions.ALL, ZohoCatalyst.circuits.execution.EXECUTE |
| appsail | ZohoCatalyst.appsail.Read, ZohoCatalyst.appsail.Create, ZohoCatalyst.appsail.Update, ZohoCatalyst.appsail.Delete |
| circuits | ZohoCatalyst.circuits.EXECUTE |
| search | ZohoCatalyst.search.READ |
| ZohoCatalyst.email.CREATE | |
| notifications | ZohoCatalyst.notifications.web, ZohoCatalyst.notifications.mobile |
| mlkit | ZohoCatalyst.mlkit.READ |
| quickml | QuickML.deployment.READ |
| smartbrowz | ZohoCatalyst.pdfshot.execute, ZohoCatalyst.dataverse.execute |
| pipelines | ZohoCatalyst.pipeline.READ, ZohoCatalyst.pipeline.execution.CREATE |
| stratus | Stratus.fileop.CREATE, Stratus.fileop.ALL, Stratus.bucketop.ALL, ZohoCatalyst.buckets.objects.UPDATE, ZohoCatalyst.buckets.objects.READ, ZohoCatalyst.buckets.objects.DELETE, ZohoCatalyst.buckets.READ, ZohoCatalyst.buckets.objects.CREATE |
| IAM | AaaServer.profile.READ |
| tunneling | ZohoCatalyst.tunneling.READ, ZohoCatalyst.tunneling.UPDATE |
| scheduling | ZohoCatalyst.jobpool.READ, ZohoCatalyst.job.ALL |
| logs | ZohoCatalyst.cli.logs.CREATE |
| security_rules | ZohoCatalyst.security.rules.Read, ZohoCatalyst.security.rules.Update |
| event_listeners | ZohoCatalyst.eventlistners.ALL, ZohoCatalyst.eventlisteners.produce |
| NoSQL | ZohoCatalyst.nosql.READ, ZohoCatalyst.nosql.rows.ALL |
| users | ZohoCatalyst.projects.users.READ, ZohoCatalyst.projects.users.CREATE, ZohoCatalyst.projects.users.DELETE, ZohoCatalyst.projects.users.UPDATE |
| webapp | ZohoCatalyst.webapp.ALL |
| queue | ZohoCatalyst.queue.ALL, ZohoCatalyst.queue.data.READ, ZohoCatalyst.queue.data.CREATE |
| api gateway | ZohoCatalyst.apigateway.apis.READ, ZohoCatalyst.apigateway.apis.CREATE, ZohoCatalyst.apigateway.apis.UPDATE, ZohoCatalyst.apigateway.apis.DELETE, ZohoCatalyst.apigateway.READ, ZohoCatalyst.apigateway.UPDATE |
ステップ1: 新規クライアントの登録
クライアントの登録
OAuth認証トークンを取得するための最初のステップは、Zoho APIコンソールにアプリケーションを登録し、client_idとclient_secretを取得することです。
- アプリケーションを登録するには、Zoho APIコンソールにアクセスし、Get Startedをクリックしてください。
- アプリケーションのクライアントタイプを選択してください。
詳細についてはZohoのOAuthドキュメントを参照してください。
- 選択したクライアントタイプに対してアプリケーションを登録するために必要な詳細を入力してください。
- Client Name: Zohoに登録するアプリケーションの名前
- Homepage URL: クライアントのホームページURL
- Authorized Redirect URIs: 認証成功後にZoho Accountsがgrant tokenとともにリダイレクトする、アプリケーションの有効なURL
- Createをクリックしてください。
登録が成功すると、Zohoから一組のOAuth 2.0資格情報（client_idとclient_secret）が提供されます。これらはZohoとアプリケーションの双方が認識する値です。
クライアントのマルチDC有効化
マルチDCサポートセクションで説明したとおり、クライアントを登録した後、APIコンソールの Settings タブからマルチDCサポートを有効にできます。これはテスト専用の Self Client タイプを除く、すべてのクライアントタイプで利用可能です。
この機能により、特定のドメインのユーザーのみにアプリケーションへのアクセスを提供できます。前述のとおり、Catalystは現在EU、AU、IN、JP、SAおよびCAドメインで利用可能です。必要に応じて、特定のDCユーザーのアプリケーションへのアクセスを有効または無効にできます。
クライアントのマルチDC設定にアクセスするには:
- APIコンソールからクライアントを開き、Settingsをクリックしてください。
- 必要なデータセンターのクライアントアクセスを有効または無効にしてください。Catalystがサポートするデータセンターのみ利用できます。
DCを有効にすると、コンソールはデフォルトでそれぞれに異なるclient_secretを生成します。各DCのShow Codeをクリックしてアクセスできます。client_idはすべてのDCで同一です。
Use the same OAuth credentials for all data centersチェックボックスをオンにすることで、すべてのDCで同じclient_secretを使用できます。確認ポップアップでOKをクリックする必要があります。
チェックボックスを再度オフにすると、異なるclient_secretに戻すことができます。同様に操作を確認してください。
ステップ2: Grant Tokenの生成
client_idとclient_secretを生成した後、アプリケーションのGrant Tokenまたはcodeを生成する必要があります。
Self Clientアプリケーションの場合
以前 Self Client タイプを選択した場合、以下の方法でGrant Token（code）を生成する必要があります:
- アプリケーションを登録した後、APIコンソールの Applications リストからSelf Clientを選択し、Generate Codeをクリックしてください。
- 有効なスコープを入力してください。Catalystで利用可能なスコープの一覧はこちらのセクションで確認できます。
- ドロップダウンリストから期間を選択してください。このステップで生成されたGrant Tokenは、この期間後に失効します。
- スコープの説明を入力してください。
- Generateをクリックしてください。
APIコンソールに、Self Client アプリケーション用に生成されたGrant Tokenまたはcodeの値が表示されます。
その他のアプリケーションの場合
以前 Self Client タイプ以外のクライアントタイプを選択した場合、リダイレクト方式でGrant Tokenを生成する必要があります:
- Grant Token（code）を生成するために、以下のURIに指定のパラメーターを付けてリクエストを送信してください:
https://accounts.zoho.com/oauth/v2/auth?
注意: 他のデータセンターについては、それぞれのドメインにアクセスする必要があります:
- EU: https://accounts.zoho.eu/
- AU: https://accounts.zoho.au/
- IN: https://accounts.zoho.in/
- CA: https://accounts.zohocloud.ca/
- JP: https://accounts.zohocloud.jp/
- SA: https://accounts.zohocloud.sa/
| パラメーター | 説明 |
|---|---|
| scope* | Grant Tokenを生成するスコープ。カンマで区切ることで複数のスコープを指定できます。Catalystで利用可能なスコープの一覧は[こちらのセクション](/ja/api/oauth2/scopes/#Scopes)で確認できます。 |
| client_id* | クライアント登録時に生成されたClient ID |
| state | プロトコル内でラウンドトリップされる不透明な文字列。ここで指定した値がそのまま返されます |
| response_type* | code（この文字列リテラルを値として指定してください） |
| redirect_uri* | 前のステップでクライアントを登録する際に指定した認可済みリダイレクトURIの1つ。未登録のredirect URIは指定できません。 |
| access_type | 指定可能な値はofflineとonlineです。onlineのaccess_typeは、1時間有効なAccess Tokenのみをアプリケーションに提供します。offline access_typeは、Access TokenとRefresh Tokenの両方をアプリケーションに提供します。デフォルト値はonlineです。 |
| prompt | Consent（この文字列リテラルを値として指定してください）アプリケーションがユーザー資格情報にアクセスしようとするたびに、ユーザーの同意を求めるプロンプトが表示されます。このパラメーターを指定しない場合、ユーザーにはアプリケーションが初めてアクセスをリクエストした時にのみ資格情報の入力が求められます。 |
注意:
-
*が付いたフィールドは必須です。
-
セキュリティ強化のため、リクエストのボディにform-dataとしてパラメーターを渡すことができます。
リクエスト例
- このリクエストでpromptパラメーターを送信した場合、ユーザー同意ページが開きます。
Acceptをクリックすると、ZohoはcodeパラメーターにGrant Tokenを含めてredirect_uriにリダイレクトします。次のステップのためにcodeの値を保存してください。
ログイン情報に基づいて、システムが自動的にドメインを検出し、ドメイン固有の認証URLを使用してGrant Tokenを生成します。stateパラメーターもURLに含まれます。
Rejectをクリックすると、ブラウザーはerror=access_deniedパラメーター付きでredirect URIにリダイレクトされます。
ステップ3: Access TokenとRefresh Tokenの生成
リクエストの実行
Grant Tokenを取得した後、access_tokenを生成するために、以下のURLに指定のパラメーターを付けてPOSTリクエストを送信してください:
https://accounts.zoho.com/oauth/v2/token?
注意: 他のデータセンターについては、それぞれのドメインにアクセスする必要があります:
- EU: https://accounts.zoho.eu/
- AU: https://accounts.zoho.au/
- IN: https://accounts.zoho.in/
- CA: https://accounts.zohocloud.ca/
- JP: https://accounts.zohocloud.jp/
- SA: https://accounts.zohocloud.sa/
| パラメーター | 説明 |
|---|---|
| code* | 前のステップで取得したGrant Tokenまたはcodeの値。 |
| client_id* | クライアント登録時に生成されたClient ID |
| client_secret* | クライアント登録時に生成されたClient Secret |
| grant_type* | authorization_code（この文字列リテラルを値として指定してください） |
| redirect_uri | 前のステップでクライアントを登録する際に指定した認可済みリダイレクトURIの1つ。未登録のredirect URIは指定できません。 |
| scope |
access_tokenを生成するスコープ。カンマで区切ることで複数のスコープを指定できます。 Catalystで利用可能なスコープの一覧は[こちらのセクション](/ja/api/oauth2/scopes/)で確認できます。 |
| state | プロトコル内でラウンドトリップされる不透明な文字列。ここで指定した値がそのまま返されます。 |
注意:
- *が付いたフィールドは必須です。
- セキュリティ強化のため、リクエストのボディにform-dataとしてパラメーターを渡すことができます。
- access_tokenは、expires_inパラメーターで指定された時間（秒単位）の経過後に失効します。
- ただし、refresh_tokenは永続的であり、現在のaccess tokenが失効した場合に新しいaccess_tokenを再生成するために使用できます。
- api_domainで指定されたドメインをリクエストに使用して、CatalystへのAPI呼び出しを行うことができます。
- token_typeの「Bearer」値は、これがaccess_tokenであることを示しています。
これで認証プロセスは完了です。アプリケーションのaccess_tokenを取得したら、HTTPリクエストの認可ヘッダーに使用してCatalyst APIにアクセスできます。例についてはリクエスト形式セクションを参照してください。
{
"access_token": "{access_token}",
"refresh_token": "{refresh_token}",
"api_domain": "https://www.zohoapis.com",
"token_type": "Bearer",
"expires_in": 3600
}
ステップ4: Access Tokenの更新
リクエストの実行
access_tokenが失効した場合、refresh_tokenを使用してアプリケーション用の新しいaccess_tokenを生成する必要があります。
これを行うには、以下のURLに指定のパラメーターを付けてPOSTリクエストを送信してください:
https://accounts.zoho.com/oauth/v2/token?
注意: 他のデータセンターについては、それぞれのドメインにアクセスする必要があります:
- EU: https://accounts.zoho.eu/
- AU: https://accounts.zoho.au/
- IN: https://accounts.zoho.in/
- CA: https://accounts.zohocloud.ca/
- JP: https://accounts.zohocloud.jp/
- SA: https://accounts.zohocloud.sa/
| パラメーター | 説明 |
|---|---|
| refresh_token* | 前のステップで取得したrefresh_token |
| client_id* | クライアント登録時に生成されたClient ID |
| client_secret* | クライアント登録時に生成されたClient Secret |
| grant_type* | refresh_token（この文字列リテラルを値として指定してください） |
| redirect_uri* | 前のステップでクライアントを登録する際に指定した認可済みリダイレクトURIの1つ。未登録のredirect URIは指定できません。 |
{
"access_token": "{new_access_token}",
"expires_in": 3600,
"api_domain": "https://www.zohoapis.com",
"token_type": "Bearer"
}
ステップ5: Refresh Tokenの取り消し
リクエストの実行
特定のスコープへのアクセスが不要になった場合、refresh_tokenを手動で取り消すことができます。
refresh_tokenを取り消すには、取り消すrefresh_tokenをパラメーターとして、以下のURLにPOSTリクエストを送信してください。
https://accounts.zoho.com/oauth/v2/token/revoke?
注意: 他のデータセンターについては、それぞれのドメインにアクセスする必要があります:
- EU: https://accounts.zoho.eu/
- AU: https://accounts.zoho.au/
- IN: https://accounts.zoho.in/
- CA: https://accounts.zohocloud.ca/
- JP: https://accounts.zohocloud.jp/
- SA: https://accounts.zohocloud.sa/
これにより、refresh tokenは無効になります。
Catalystプロジェクト
Project APIを使用すると、Catalystプロジェクトの作成、更新、削除、および詳細の取得を行うことができます。これらの操作はCatalystコンソールからも実行できます。Catalyst CLIを使用して、リモートでプロジェクトを作成しリソースを初期化することもできます。
新規プロジェクトの作成
説明
このAPIを使用すると、CatalystアカウントにCatalystプロジェクトを新規作成できます。リクエストに必要なプロジェクト名を渡す必要があります。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZOHOCATALYST.projects.CREATE
リクエストJSONプロパティ
最大サイズ: 50文字
レスポンス詳細
レスポンスには、作成されたプロジェクトの詳細が含まれます。project_domain_idやproject_domain_nameなどのプロジェクトドメイン詳細、およびemail_idやuser_idなどのユーザー詳細が含まれます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
-d ‘{
“project_name”:“BillingDesk”
}’
{
"status": "success",
"data": {
"project_name": "BillingDesk",
"created_by": {
"zuid": 3000000006001,
"is_confirmed": true,
"email_id": "amelia.burrows@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930455
},
"created_time": "Jan 29, 2020 11:59 AM",
"redirect_url": "",
"project_domain_details": {
"project_domain_id": 10018095112,
"project_domain_name": "billingdesk-697215025.development",
"project_domain": "billingdesk-697215025.development.zohocatalyst.com",
"user_auth": {},
"mobile_auth": {}
},
"db_type": "SINGLE_DB",
"id": 3000000005090,
"project_type": "Live",
"timezone": "Asia/Kolkata"
}
}
特定プロジェクトの詳細取得
説明
このAPIを使用すると、現在ログインしているCatalystユーザー（開発者やコラボレーターなど）がCatalystアカウントから作成した特定プロジェクトの詳細を取得できます。プロジェクトはproject_idで参照されます。取得されるプロジェクトの詳細は、APIが実行されているCatalystアカウントと同じアカウントのものです。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
scope=ZOHOCATALYST.projects.Read
レスポンス詳細
レスポンスには、project_domain_idやproject_domain_nameなどのプロジェクトドメイン詳細、および作成者のemail_idやuser_idなどのユーザー詳細を含むプロジェクトの詳細が含まれます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"platforms": [],
"project_name": "BillingDesk",
"created_by": {
"zuid": 780776954,
"is_confirmed": false,
"email_id": "amelia-burrows@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_type": "Admin",
"user_id": 11811000000003003
},
"created_time": "Jun 04, 2023 04:19 PM",
"redirect_url": "",
"project_domain_details": {
"project_domain_id": 10060895541,
"project_domain_name": "billingdesk-781316834.development",
"project_domain": "https://billingdesk-781316834.development.catalystserverless.com",
"user_auth": {
"userAuth": {},
"createdTime": null,
"createdBy": null
},
"mobile_auth": {}
},
"db_type": "SINGLE_DB",
"id": 11811000000315013,
"project_type": "Live",
"env_details": [
{
"id": 11811000000315049,
"env_name": "Development",
"env_type": 3,
"env_status": "Active",
"project_details": {
"project_name": "BillingDesk",
"id": 11811000000315013,
"project_type": "Live"
},
"is_default": true,
"env_zgid": "781316834",
"action_required": false
}
],
"timezone": "Asia/Kolkata"
}
}
全プロジェクトの詳細取得
説明
このAPIを使用すると、現在ログインしているCatalystユーザー（開発者やコラボレーターなど）のリモートコンソール内の全プロジェクトの詳細を取得できます。取得されるプロジェクトの詳細は、APIが実行されているCatalystアカウントと同じアカウントのものです。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZOHOCATALYST.projects.Read
レスポンス詳細
レスポンスには、ユーザーがリモートコンソールで作成した全プロジェクトの詳細が含まれます。各プロジェクトのproject_domain_idやproject_domain_nameなどのプロジェクトドメイン詳細、および作成者のemail_idやuser_idなどのユーザー詳細が含まれます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": [
{
"platforms": [],
"project_name": "BillingDesk",
"created_by": {
"zuid": 780776954,
"is_confirmed": false,
"email_id": "amelia.burrows@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_type": "Admin",
"user_id": 11811000000003003
},
"created_time": "Jun 04, 2023 04:19 PM",
"redirect_url": "",
"project_domain_details": {
"project_domain_id": 10060895541,
"project_domain_name": "billingdesk-781316834.development",
"project_domain": "https://billingdesk-781316834.development.catalystserverless.com",
"user_auth": {
"userAuth": {},
"createdTime": null,
"createdBy": null
},
"mobile_auth": {}
},
"db_type": "SINGLE_DB",
"id": 11811000000315013,
"project_type": "Live",
"env_details": [
{
"id": 11811000000315049,
"env_name": "Development",
"env_type": 3,
"env_status": "Active",
"project_details": {
"project_name": "BillingDesk",
"id": 11811000000315013,
"project_type": "Live"
},
"is_default": true,
"env_zgid": "781316834",
"action_required": false
}
],
"timezone": "Asia/Kolkata"
},
{
"platforms": [],
"project_name": "Zia",
"created_by": {
"zuid": 780776954,
"is_confirmed": false,
"email_id": "amelia.burrows@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_type": "Admin",
"user_id": 11811000000003003
},
"created_time": "Jun 02, 2023 11:55 AM",
"redirect_url": "",
"project_domain_details": {
"project_domain_id": 10060816047,
"project_domain_name": "zia-781316834.development",
"project_domain": "https://zia-781316834.development.catalystserverless.com",
"user_auth": {
"userAuth": {},
"createdTime": null,
"createdBy": null
},
"mobile_auth": {}
},
"db_type": "SINGLE_DB",
"id": 11811000000314001,
"project_type": "Live",
"env_details": [
{
"id": 11811000000314037,
"env_name": "Development",
"env_type": 3,
"env_status": "Active",
"project_details": {
"project_name": "Zia",
"id": 11811000000314001,
"project_type": "Live"
},
"is_default": true,
"env_zgid": "781316834",
"action_required": false
}
],
"timezone": "Asia/Kolkata"
}
プロジェクトの削除
説明
このAPIを使用すると、プロジェクトIDを指定して特定のプロジェクトを削除できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZOHOCATALYST.projects.Delete
リクエストJSONプロパティ
最大サイズ: 50文字
curl -X DELETE
https://api.catalyst.zoho.com/baas/v1/project/4000000006007
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json” \
{
"status": "success",
"data": {
"id": 4000000006007
}
}
Functions
Catalyst Functionsを使用すると、アプリケーションにカスタム機能を構築し、他のCatalystコンポーネントとシームレスに統合して強力なバックエンドを提供できます。関数を使用して、タスクの自動化、メモリ集約型の計算、またはサードパーティサービスとの統合が可能です。
Catalystは、Java、Node.js、Pythonのプログラミング環境でサーバーサイド関数の開発をサポートしています。
関数の実行
説明
このAPIを使用すると、一意の関数IDを参照してBasic I/O関数を実行できます。Basic I/O関数は、基本的な入出力操作、計算、および簡単なHTTP操作を実行するために使用されます。
入力パラメータは、APIリクエストでクエリ文字列またはリクエストボディのいずれかで関数に渡すことができます。関数パラメータを渡すには、リクエストボディよりもクエリ文字列が推奨されます。レスポンスには関数の出力が含まれます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/function/{function_id}/execute
リクエストメソッド
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.functions.EXECUTE
レスポンス詳細
レスポンスには、処理された関数の出力が含まれます。Basic I/O関数はJSON形式でレスポンスを返します。キーoutputには、実行した関数によって生成された出力が含まれます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/function/4000000045004/execute?name=Raymond%20McGregor
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"output": "Hello Raymond McGregor"
}
Circuits
Catalyst Circuitsを使用すると、Catalystで自動的に実行される一連のタスクを体系的に定義・整理できます。タスクをオーケストレーションしてワークフローを自動化し、さらに条件、データ、パスをワークフローに含めることで、Circuitsを使用してビジネス成果を達成するための反復可能なアクティビティパターンを定義できます。
Catalystは、Circuitを使用したアプリケーションのBasic I/O関数の自動実行をサポートしています。
Circuitの実行
説明
このAPIを使用すると、一意のCircuit IDを参照して、コンソールで設定されたCatalyst Circuitを実行できます。以下に説明するように、リクエストJSONでCircuitへの入力を渡すことができます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/circuit/{circuit_id}/execute
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.circuits.EXECUTE
リクエストJSONフォーマット
Circuitへの入力は、次のようにJSON形式のキーと値のペアとして送信する必要があります:
{
“key_1”: “value_1”,
“key_2”: “value_2”,
“key_3”: “value_3”,
.
.
}
レスポンス詳細
レスポンスには、実行されたCircuitの結果と詳細が含まれ、circuit_name、実行のstart_timeとend_time、instance_id、およびCircuitに渡された入力とCircuitの実行から生成された出力の詳細が含まれます。
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”
}
]’
{
"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"
}
}
}
}
}
Authentication
Catalyst Authentication機能を使用すると、Catalystサーバーレスアプリケーションにエンドユーザーを追加し、ユーザーアカウントとロールを設定し、アプリケーションのユーザーサインインと認証を管理できます。
新規ユーザーの追加
説明
このAPIを使用すると、特定のプラットフォーム向けにCatalystアプリケーションに新しいエンドユーザーを追加できます。ユーザーがサインアップすると、ZUID、userIDなどの一意の識別値が作成されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/project-user/signup
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.projects.users.CREATE
リクエストJSONプロパティ
最大サイズ: 200
ユーザーの詳細を含むJSON
最大サイズ: 100
最大サイズ: 100
レスポンス詳細
レスポンスには、dataキーに追加されたユーザーの詳細が含まれ、生成されたzaid、user_id、org_idなどのメタデータおよび識別値が含まれます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/3000000002001/project-user/signup
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
-H “PROJECT_ID: 1010309726”
-d ‘{
“user_details”:{
“first_name”:“Rowena”,
“last_name”:“Simmons”,
“email_id”:“r.simmons@zylker.com”
},
“platform_type”:“web”,
“redirect_url”:“https://logistics.zylker.com/app/index.html"
}’
{
"status": "success",
"data": {
"zaid": 1010309726,
"user_details": {
"user_id": 671930455,
"user_type": "App Administrator",
"zuid": 3000000006001,
"zaaid": 1011520995,
"status": "ACTIVE",
"is_confirmed": true,
"email_id": "r.simmons@zylker.com",
"first_name": "Rowena",
"last_name": "Simmons",
"created_time": "May 13, 2019 09:16 PM",
"modified_time": "May 13, 2019 09:16 PM",
"invited_time": "May 13, 2019 09:16 PM",
"role_details": {
"role_id": 1256000000288012,
"role_name": "App Administrator"
}
},
"redirect_url": "https://logistics.zylker.com/app/index.html",
"platform_type": "web",
"org_id": 1011520995
"locale": "us|en_us|America/Los_Angeles"
"time_zone": "America/Los_Angeles"
}
}
既存の組織への新規ユーザーの追加
説明
このAPIを使用すると、新しい組織を作成せずに、既存の組織に新しいエンドユーザーを追加できます。ユーザーを追加する組織のZAAIDを指定することで実行できます。ユーザーの組織は、アカウントに関連付けられた後は変更できません。
ユーザーがサインアップすると、ZUIDおよびUser IDなどの一意の識別値が作成されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/project-user
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.projects.users.CREATE
リクエストJSONプロパティ
最大サイズ: 200
ユーザーの詳細を含むJSON
最大サイズ: 100
最大サイズ: 100
レスポンス詳細
レスポンスには、dataキーに追加されたユーザーの詳細が含まれ、生成されたzaid、user_id、org_idなどのメタデータおよび識別値が含まれます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/3000000002001/project-user
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
-d ‘{
“user_details”:{
“first_name”:“John”,
“last_name”:“Winchester”,
“email_id”:“john.w@zylker.com”,
“zaaid”:4567899
},
“redirect_url”: “https://logistics.zylker.com/app/index.html",
“platform_type”:“web”
}’
{
"status": "success",
"data": {
"zaid": 1011481670,
"user_details": {
"user_id": 671930400,
"user_type": "App User",
"zuid": 3000000006001,
"zaaid": 1011520995,
"status": "ACTIVE",
"is_confirmed": true,
"email_id": "john.w@zylker.com",
"first_name": "John",
"last_name": "Winchester",
"created_time": "May 13, 2019 09:16 PM",
"modified_time": "May 13, 2019 09:16 PM",
"invited_time": "May 13, 2019 09:16 PM",
"role_id": 3000000005015
},
"redirect_url": "https://logistics.zylker.com/app/index.html",
"platform_type": "web",
"org_id": 1011520995
"locale": "us|en_us|America/Los_Angeles"
"time_zone": "America/Los_Angeles"
}
}
現在のユーザーの詳細取得
説明
このAPIを使用すると、関数が実行されているスコープのCatalystアプリケーションにログインしている現在のユーザーの詳細を取得できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/project-user/current
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.projects.users.READ
レスポンス詳細
レスポンスには、zaid、user_id、email_idなどの識別値やロール詳細を含む、現在のユーザーの詳細が含まれます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/3000000005007/project-user/current
-H “Authorization: Zoho-oauthtoken 1000.910*************************6.2f*************************57”
{
"status": "success",
"data": {
"zuid": 3000000006111,
"zaaid": 1019540153,
"status": "ACTIVE",
"user_id": 671930409,
"user_type": "App Administrator",
"is_confirmed": true,
"email_id": "p.boyle@zylker.com",
"first_name": "Patricia",
"last_name": "Boyle",
"created_time": "Jul 09, 2019 04:11 PM",
"modified_time": "Jul 09, 2019 04:11 PM",
"invited_time": "Jul 09, 2019 04:11 PM",
"role_details": {
"role_id": 3000000005090,
"role_name": "App Administrator"
}
"org_id":1019540153
"locale": "us|en_us|America/Los_Angeles"
"time_zone": "America/Los_Angeles"
}
}
特定のユーザーの詳細取得
説明
このAPIを使用すると、リクエストにuser_IDを渡すことで、特定のCatalystアプリケーションユーザーの詳細を取得できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/project-user/{user_id}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.projects.users.READ
レスポンス詳細
レスポンスには、zuid、user_id、email_idなどの識別値やロール詳細を含む、特定のユーザーの詳細が含まれます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/3000000005007/project-user/671930409
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"zuid": 3171930400,
"zaaid": 1019540153,
"status": "ACTIVE",
"user_id": 671930409,
"user_type": "App User",
"is_confirmed": true,
"email_id": "john.w@zylker.com",
"first_name": "John",
"last_name": "Winchester",
"created_time": "Jul 09, 2019 04:11 PM",
"modified_time": "Jul 09, 2019 04:11 PM",
"invited_time": "Jul 09, 2019 04:11 PM",
"role_details": {
"role_id": 3000000005015,
"role_name": "App User"
}
"org_id":1019540153
"locale": "us|en_us|America/Los_Angeles"
"time_zone": "America/Los_Angeles"
}
}
全ユーザーの詳細取得
説明
このAPIを使用すると、ページネーションを通じて特定のアプリケーションのすべてのCatalystアプリケーションユーザーの詳細を取得できます。ページネーションにより、API呼び出しの反復を通じてユーザーリストをページ単位で取得できます。
たとえば、ユーザーレコードを200件ずつ個別のページとして取得する場合、リクエストにstartとendパラメータを含める必要があります。startパラメータを使用して開始インデックスを0に設定し、endパラメータを使用して取得するユーザーの最大数を200に指定できます。次のユーザーレコードセットを取得するには、startインデックスを200に設定し、endパラメータを使用してそのページのユーザーレコード数を適宜指定して、別のAPI呼び出しを実行できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/project-user?start={start_index}&end={number_of_users}
ユーザーレコードの取得を開始する開始インデックス
ページネーションを通じて1ページで返すユーザーレコード数
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.projects.users.READ
レスポンス詳細
レスポンスには、zuid、user_id、email_idなどの識別値やロール詳細を含む、すべてのアプリケーションユーザーの詳細が含まれます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/3000000005007/project-user?start=100&end=3
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": [
{
"zuid": 3171930121,
"zaaid": 1019540153,
"status": "ACTIVE",
"user_id": 671930409,
"user_type": "App User",
"is_confirmed": true,
"email_id": "ron.grisham@zylker.com",
"first_name": "Ronald",
"last_name": "Grisham",
"created_time": "Jul 09, 2019 04:11 PM",
"modified_time": "Jul 09, 2019 04:11 PM",
"invited_time": "Jul 09, 2019 04:11 PM",
"role_details": {
"role_id": 3000000005015,
"role_name": "App User"
}
"org_id":1019540153
"locale": "us|en_us|America/Los_Angeles"
"time_zone": "America/Los_Angeles"
},
{
"zuid": 3171930089,
"zaaid": 1019543293,
"status": "ACTIVE",
"user_id": 671930121,
"user_type": "App User",
"is_confirmed": true,
"email_id": "Lucy.p@zylker.com",
"first_name": "Lucy",
"last_name": "Pettigrew",
"created_time": "Jul 09, 2019 04:26 PM",
"modified_time": "Jul 09, 2019 04:26 PM",
"invited_time": "Jul 09, 2019 04:26 PM",
"role_details": {
"role_id": 3000000005015,
"role_name": "App User"
}
"org_id":1019540153
"locale": "us|en_us|America/Los_Angeles"
"time_zone": "America/Los_Angeles"
},
{
"zuid": 3171937685,
"zaaid": 1019540091,
"status": "ACTIVE",
"user_id": 671930888,
"user_type": "App User",
"is_confirmed": true,
"email_id": "zayn.ahmed@zylker.com",
"first_name": "Zayn",
"last_name": "Ahmed",
"created_time": "Jul 09, 2019 04:26 PM",
"modified_time": "Jul 09, 2019 04:26 PM",
"invited_time": "Jul 09, 2019 04:26 PM",
"role_details": {
"role_id": 3000000005015,
"role_name": "App User"
}
"org_id":1019540153
"locale": "us|en_us|America/Los_Angeles"
"time_zone": "America/Los_Angeles"
}
]
}
ユーザーの削除
説明
このAPIを使用すると、ユーザーを削除し、Catalystアプリケーションへのアクセスを完全に削除できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/project-user/{user_id}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.projects.users.DELETE
レスポンス詳細
レスポンスには、zaid、user_id、email_idなどの識別値やロール詳細を含む、削除されたユーザーの詳細が含まれます。
curl -X DELETE
https://api.catalyst.zoho.com/baas/v1/project/3000000005007/project-user/671930409
-H “Authorization: Zoho-oauthtoken 1000.910*************************6.2f*************************57”
{
"status": "success",
"data": {
"zuid": 3000000006111,
"zaaid": 1019540153,
"status": "ACTIVE",
"user_id": 671930409,
"user_type": "App Administrator",
"is_confirmed": true,
"email_id": "p.boyle@zylker.com",
"first_name": "Patricia",
"last_name": "Boyle",
"created_time": "Jul 09, 2019 04:11 PM",
"modified_time": "Jul 09, 2019 04:11 PM",
"invited_time": "Jul 09, 2019 04:11 PM",
"role_details": {
"role_id": 3000000005090,
"role_name": "App Administrator"
}
"org_id":1019540153
"locale": "us|en_us|America/Los_Angeles"
"time_zone": "America/Los_Angeles"
}
}
ユーザーパスワードのリセット
説明
このAPIを使用すると、Catalystアプリケーションのユーザーのパスワードをリセットできます。このAPIが呼び出されると、パスワードリセットリンクを含むメールがユーザーのメールアドレスに送信されます。ユーザーはリンクをクリックすると、アプリケーションの新しいパスワードを設定して保存できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/project-user/forgotpassword
リクエストヘッダー
Content-Type: application/json
PROJECT_ID: {ZAID}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
リクエストJSONプロパティ
最大サイズ: N/A
最大サイズ: 200
ユーザーの詳細を含むJSON
必須: いいえ
最大サイズ: 100
必須: いいえ
最大サイズ: 100
必須: はい
最大サイズ: N/A
レスポンス詳細
レスポンスには、パスワードリセット操作のステータスが含まれます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/3000000002001/project-user/forgotpassword
-H “Content-Type: application/json” \
-d ‘{
“user_details”:{
“email_id”:“p.boyle@zylker.com”
},
“platform_type”:“web”
}’
{
"status": "success",
"data": "Reset link sent to your p.boyle@zylker.com email address. Please check your email :)"
}
ユーザーのサインアウト
説明
Catalystアプリケーションユーザーは、このAPIリクエストを使用してアプリケーションの現在のアクティブセッションからログアウトできます。CatalystはこのAPIリクエストに対してレスポンスを返しません。
リクエスト詳細
リクエストURL
{application_domain}/baas/logout?logout=true&PROJECT_ID={project_id}
Catalystアプリケーションのドメインアドレス
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
Data Store
Catalyst Data Storeは、アプリケーションの永続データをテーブル形式で保存するクラウドベースのリレーショナルデータベース管理システムです。
Data Store APIを使用すると、プロジェクトのData Store内のテーブルにレコードを挿入・管理したり、テーブルやカラムの詳細を取得したり、一括読み取りや一括書き込みのアクションを実行したりできます。ただし、テーブルとそのスキーマの作成はCatalystコンソールからのみ行えます。
テーブルへの新しい行の挿入
説明
このAPIを使用すると、テーブルの一意のIDまたは名前を指定して、Data Store内のテーブルにデータの新しい行（レコード）を挿入できます。
以下に説明するように、リクエスト内のJSON配列でレコードのカラム名とその対応する値を渡す必要があります。
注意:
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/table/{tableIdentifier}/row
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.tables.rows.CREATE
リクエストJSON配列
以下のようなJSON配列でカラム名とその対応する値を送信する必要があります：
{
"column1_name": "column1_value",
"column2_name": "column2_value",
"column3_name": "column3_value",
.
.
}
ここでcolumn_nameはテーブル内の一意のカラム名、column_valueはレコード内のその対応する値です。
レスポンス詳細
レスポンスには、ROWIDやCREATEDTIMEなどの作成された行のメタデータと、挿入されたカラムのキー名と値が含まれます。
curl -X POST \
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table/EmpDetails/row
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d ‘[
{
“Department_ID”:“IT678”,
“Department_Name”:“Marketing”,
“Employee_Name”:“Robert Page”
}
]’
{
"status": "success",
"data": [
{
"CREATORID": "12096000000003003",
"MODIFIEDTIME": "2023-06-05 11:35:14:332",
"Department_ID": null,
"Employee_Name": "Robert Page",
"Department_Name": "Marketing",
"CREATEDTIME": "2023-06-05 11:35:14:332",
"ROWID": 12096000000642928
}
]
}
テーブル内の全行の取得
説明
このAPIを使用すると、Data Store内の特定のテーブルからすべての行を取得できます。テーブルはIDまたは名前で参照できます。このAPIは、すべての行を取得するためにページネーションを組み込んでいます。ページネーションを使用すると、APIコールの反復を通じてレコードをページ単位で取得できます。
例えば、100件ずつのバッチで個別のページとして行を取得する場合、リクエストにmax_rowsパラメーターを含め、各ページで取得する最大行数を100と指定する必要があります。
さらに、各APIレスポンスには、次の行セットを取得するための次のAPIコールで渡すことができるトークンが含まれます。このトークンは、後続のデータ取得を認可します。前回のAPIコールのレスポンスで取得したトークン文字列を、リクエストのnext_tokenパラメーターで渡す必要があります。最初のAPIコールではnext_tokenパラメーターを渡す必要はありません。このようにして各反復でAPIコールを実行し、すべての行をページ単位で取得できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/table/{tableIdentifier}/row?next_token={token_string}&max_rows={number_of_rows}
（最初のAPIコールでは不要）ページネーションで次の行セットを取得するために渡す、前回のAPIコールから取得したトークン値
（任意）ページネーションで1ページに返される最大行数。この値が指定されない場合、APIはデフォルトで1ページあたり200行を返します。
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.tables.rows.READ
レスポンス詳細
レスポンスには、指定したmax_rows値に基づいてページ単位でAPIコールを通じて取得された行が返されます。リクエストされた件数やmax_rowsの件数を超える行がある場合、次の行セットを取得するために渡す必要があるトークンがnext_tokenとしてレスポンスに含まれます。取得するレコードがこれ以上ない場合、レスポンスにトークンは含まれません。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table/CustomerDetails/row?max_rows=4&next_token=*************
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": [
{
"CREATORID": 56000000002003,
"MODIFIEDTIME": "2019-03-06 10:16:41",
"Department_ID": "IT148",
"Department_Name": "Admin",
"Employee_Name": "Eric Hyde",
"CREATEDTIME": "2019-03-06 10:16:41",
"ROWID": 56000000342025,
"doubleDataType": null
},
{
"CREATORID": 56000000002003,
"MODIFIEDTIME": "2019-03-06 10:18:56",
"Department_ID": "IT170",
"Department_Name": "Sales",
"Employee_Name": "Steven Kelso",
"CREATEDTIME": "2019-03-06 10:18:56",
"ROWID": 56000000342026,
"doubleDataType": null
},
{
"CREATORID": 56000000002003,
"MODIFIEDTIME": "2019-03-06 10:19:00",
"Department_ID": "IT190",
"Department_Name": "Marketing",
"Employee_Name": "Micheal Forman",
"CREATEDTIME": "2019-03-06 10:18:58",
"ROWID": 56000000342027,
"doubleDataType": null
},
{
"CREATORID": 56000000002003,
"MODIFIEDTIME": "2019-03-06 10:45:11",
"Department_ID": "IT111",
"Department_Name": "Support",
"Employee_Name": "Madeline Burkhart",
"CREATEDTIME": "2019-03-06 10:18:34",
"ROWID": 56000000342028,
"doubleDataType": null
},
],
"more_records" : true,
"next_token" : "{{token}}"
}
{
"status": "success",
"data": [
{
"CREATORID": 56000000002003,
"MODIFIEDTIME": "2019-03-06 10:16:41",
"Department_ID": "IT148",
"Department_Name": "Admin",
"Employee_Name": "Eric Hyde",
"CREATEDTIME": "2019-03-06 10:16:41",
"ROWID": 56000000342025,
"doubleDataType": null
},
{
"CREATORID": 56000000002003,
"MODIFIEDTIME": "2019-03-06 10:18:56",
"Department_ID": "IT170",
"Department_Name": "Sales",
"Employee_Name": "Steven Kelso",
"CREATEDTIME": "2019-03-06 10:18:56",
"ROWID": 56000000342026,
"doubleDataType": null
},
{
"CREATORID": 56000000002003,
"MODIFIEDTIME": "2019-03-06 10:19:00",
"Department_ID": "IT190",
"Department_Name": "Marketing",
"Employee_Name": "Micheal Forman",
"CREATEDTIME": "2019-03-06 10:18:58",
"ROWID": 56000000342027,
"doubleDataType": null
},
{
"CREATORID": 56000000002003,
"MODIFIEDTIME": "2019-03-06 10:45:11",
"Department_ID": "IT111",
"Department_Name": "Support",
"Employee_Name": "Madeline Burkhart",
"CREATEDTIME": "2019-03-06 10:18:34",
"ROWID": 56000000342028,
"doubleDataType": null
},
],
"more_records" : false
}
テーブル内の行の更新
説明
このAPIを使用すると、テーブルIDまたはテーブル名を指定して、Catalyst Data Store内のテーブルの特定の行を更新できます。以下に説明するように、リクエストJSONでレコード内の更新するデータを送信する必要があります。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/table/{tableIdentifier}/row
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.tables.rows.UPDATE
リクエストJSONフォーマット
以下のようなJSON配列で、レコードのROWIDとともに、更新するカラム名とその対応する値をリクエストで送信する必要があります：
{
“column1_name”: “column1_value”,
“column2_name”: “column2_value”,
“column3_name”: “column3_value”,
.
.
“ROWID”:{row_id of the record}
}
リクエストJSONプロパティ
レスポンス詳細
レスポンスには、ROWIDやCREATEDTIMEなどの更新された行のメタデータと、更新されたカラムのキー名と値が含まれます。
curl -X PUT
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table/EmpDetails/row
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d ‘[
{
“Department_Name”:“Finance”,
“Employee_Name”:“Morgan Jones”,
“ROWID”:3376000000170191
}
]’
{
"status": "success",
"data": [
{
"CREATORID": 3376000000002099,
"MODIFIEDTIME": "2019-02-26 11:18:49",
"Department_ID":"IT245",
"Department_Name":"Finance",
"Employee_Name": "Morgan Jones",
"CREATEDTIME": "2019-02-26 11:18:49",
"ROWID": 3376000000170191
}
]
}
テーブル内の行の削除
説明
このAPIを使用すると、テーブルの一意のIDまたは名前を指定して、Data Store内のテーブルの特定のレコードまたは行を削除できます。行はそのROWIDで参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/table/{tableIdentifier}/row/{row_id}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.tables.rows.DELETE
レスポンス詳細
レスポンスには、ROWIDやCREATEDTIMEなどの削除された行のメタデータと、行内のカラムのキー名と値が含まれます。
curl -X DELETE
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table/EmpDetails/row/3376000000171021
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"CREATORID": 56000000002003,
"MODIFIEDTIME": "2019-02-26 11:18:49",
"Department_ID": "IT809"
"Department_Name": "Accounting",
"Customer_Name": "Jason Pierre",
"CREATEDTIME": "2019-02-26 11:18:49",
"ROWID": 3376000000171021,
"doubleDataType": null
}
}
特定のテーブルのメタデータの取得
説明
このAPIを使用すると、テーブルの一意のIDまたは名前を指定して、Data Storeから特定のテーブルのメタデータを取得できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/table/{tableIdentifier}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.tables.READ
レスポンス詳細
レスポンスには、table_idやtable_nameなどのテーブル詳細と、各カラムのcolumn_id、column_name、data_typeなどの全カラムのメタデータを含む、テーブルのメタデータが返されます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table/EmpDetails
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"table_id": 56000000111778,
"project_id": {
"id": 4000000006007,
"project_name": "HRApp"
},
"table_name": "EmpDetails",
"modified_by": {
"is_confirmed":true,
"zuid": 1019540152,
"user_id": 671930455,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows"
},
"modified_time": "2019-02-19T02:45:16+05:30",
"column_details": [
{
"table_id": 56000000111778,
"column_sequence": 1,
"column_id": 23400091030,
"column_name": "ROWID",
"category": 1,
"data_type": "bigint",
"is_read_only": false,
"max_length": 50,
"is_mandatory": false,
"default_value": "250",
"decimal_digits": 2,
"is_unique": false,
"search_index_enabled": false
},
{
"table_id": 56000000111778,
"column_sequence": 1,
"column_id": 23400091031,
"column_name": "CREATORID",
"category": 1,
"data_type": "bigint",
"is_read_only": false,
"max_length": 50,
"is_mandatory": false,
"default_value": "250",
"decimal_digits": 2,
"is_unique": false,
"search_index_enabled": true
},
{
"table_id": 56000000111778,
"column_sequence": 1,
"column_id": 23400091032,
"column_name": "CREATEDTIME",
"category": 1,
"data_type": "datetime",
"is_read_only": false,
"max_length": 50,
"is_mandatory": false,
"default_value": "250",
"decimal_digits": 2,
"is_unique": false,
"search_index_enabled": true
},
{
"table_id": 56000000111778,
"column_sequence": 1,
"column_id": 23400091033,
"column_name": "MODIFIEDTIME",
"category": 1,
"data_type": "datetime",
"is_read_only": false,
"max_length": 50,
"is_mandatory": false,
"default_value": "250",
"decimal_digits": 2,
"is_unique": false,
"search_index_enabled": true
}
{
"table_id": 56000000111778,
"column_sequence": 1,
"column_id": 23400091034,
"column_name": "EmpID",
"category": 1,
"data_type": "varchar",
"is_read_only": false,
"max_length": 6,
"is_mandatory": true,
"default_value": "",
"decimal_digits": ,
"is_unique": true,
"search_index_enabled": true
}
{
"table_id": 56000000111778,
"column_sequence": 1,
"column_id": 23400091035,
"column_name": "EmpName",
"category": 1,
"data_type": "varchar",
"is_read_only": false,
"max_length": 30,
"is_mandatory": true,
"default_value": "",
"decimal_digits": ,
"is_unique": false,
"search_index_enabled": false
}
{
"table_id": 56000000111778,
"column_sequence": 1,
"column_id": 23400091036,
"column_name": "DeptName",
"category": 1,
"data_type": "varchar",
"is_read_only": false,
"max_length": 30,
"is_mandatory": true,
"default_value": "",
"decimal_digits": ,
"is_unique": false,
"search_index_enabled": false
}
],
"table_scope": "ORG"
}
}
全テーブルのメタデータの取得
説明
このAPIを使用すると、Data Storeからプロジェクト内の全テーブルのメタデータを取得できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/table
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.tables.READ
レスポンス詳細
レスポンスには、各テーブルのtable_idやtable_nameなどのテーブル詳細と、テーブルを最後に更新したユーザーの詳細を含む、全テーブルのメタデータが返されます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status":"success",
"data":[
{
"project_id":{
"project_name":"ShipmentTracking",
"id":4000000006007
},
"table_name":"CustomerInfo",
"modified_by":{
"zuid":1019540152,
"is_confirmed":true,
"email_id":"emma@zylker.com",
"first_name":"Amelia",
"last_name":"Burrows",
"user_id":671930111
},
"modified_time":"Apr 11, 2020 10:33 PM",
"table_id":3376000000081234
},
{
"project_id":{
"project_name":"ShipmentTracking",
"id":3376000000061190
},
"table_name":"EmpInfo",
"modified_by":{
"zuid":1019540232,
"is_confirmed":true,
"email_id":"p.boyle@zylker.com",
"first_name":"Patricia",
"last_name":"Boyle",
"user_id":671930455
},
"modified_time":"Mar 09, 2020 03:16 AM",
"table_id":3376000000017896
}
]
}
特定のカラムのメタデータの取得
説明
このAPIを使用すると、Data Store内のテーブルの特定のカラムのメタデータを取得できます。テーブルは一意のIDまたは名前で参照され、カラムはカラムIDで参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/table/{tableIdentifier}/column/{column_id}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.tables.columns.READ
レスポンス詳細
レスポンスには、column_id、column_name、data_typeなどの特定のカラムのメタデータが返されます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table/EmpDetails/column/4000000042018
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"table_id": 56000000118,
"column_sequence": 3,
"column_id": 4000000042018,
"column_name": "Department",
"category": 2,
"data_type": "text",
"is_read_only": false,
"max_length": 100,
"is_mandatory": true,
"default_value": "Admin",
"is_unique": false,
"search_index_enabled": false
}
}
全カラムのメタデータの取得
説明
このAPIを使用すると、テーブルの一意のIDまたは名前を指定して、Data Store内のテーブルの全カラムのメタデータを取得できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/table/{tableIdentifier}/column
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.tables.columns.READ
レスポンス詳細
レスポンスには、各カラムのcolumn_id、column_name、data_typeなどの全カラムのメタデータが返されます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table/EmpDetails/column
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status":"success",
"data":[
{
"table_id":829000000037723,
"column_sequence":1,
"column_name":"ROWID",
"category":1,
"data_type":"bigint",
"is_read_only":false,
"max_length":50,
"is_mandatory":false,
"decimal_digits":2,
"is_unique":false,
"search_index_enabled":false,
"column_id":829000000037726
},
{
"table_id":829000000037723,
"column_sequence":2,
"column_name":"CREATORID",
"category":1,
"data_type":"bigint",
"is_read_only":false,
"max_length":50,
"is_mandatory":false,
"decimal_digits":2,
"is_unique":false,
"search_index_enabled":true,
"column_id":829000000037728
},
{
"table_id":829000000037723,
"column_sequence":3,
"column_name":"CREATEDTIME",
"category":1,
"data_type":"datetime",
"is_read_only":false,
"max_length":50,
"is_mandatory":false,
"decimal_digits":2,
"is_unique":false,
"search_index_enabled":true,
"column_id":829000000037730
},
{
"table_id":829000000037723,
"column_sequence":4,
"column_name":"MODIFIEDTIME",
"category":1,
"data_type":"datetime",
"is_read_only":false,
"max_length":50,
"is_mandatory":false,
"decimal_digits":2,
"is_unique":false,
"search_index_enabled":true,
"column_id":829000000037732
},
{
"table_id":829000000037723,
"column_sequence":5,
"column_name":"EmpID",
"category":2,
"data_type":"bigint",
"is_read_only":false,
"max_length":15,
"is_mandatory":true,
"decimal_digits":2,
"is_unique":true,
"search_index_enabled":false,
"column_id":829000000038445
},
{
"table_id":829000000037723,
"column_sequence":6,
"column_name":"EmpName",
"category":2,
"data_type":"text",
"is_read_only":false,
"max_length":50,
"is_mandatory":true,
"decimal_digits":2,
"is_unique":false,
"search_index_enabled":false,
"column_id":829000000038450
}
]
}
テーブルのトランケート
説明
このAPIを使用すると、テーブルの一意のIDまたは名前を指定して、Data Store内の特定のテーブルをトランケートできます。
トランケート操作は、スキーマを保持したままテーブル内のすべてのレコードを削除します。操作の完了後も、テーブルのカラムとテーブルのメタデータは引き続き利用可能です。
操作の更新についてはCatalystコンソールで通知を受け取ります。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/table/{tableIdentifier}/truncate
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.tables.rows.DELETE
レスポンス詳細
レスポンスにはトランケート操作のステータスが返されます。
curl -X DELETE
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table/NewsHeadlines/truncate
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": "The table will be truncated Shortly. Kindly Check Notification bar for updates"
}
レコードの一括読み取り
一括読み取り操作は、Data Store内の特定のテーブルから数千のレコードを読み取り、ジョブが成功した場合、読み取り操作の結果を含むCSVファイルを生成します。このデータ集約型の操作は、単一のAPI実行で実行できます。
Catalystは一括読み取り操作用に3つのAPIをサポートしています：一括読み取り作成API、ジョブ実行のステータスを手動で確認するための一括読み取りステータス確認API、および結果をダウンロードするための一括読み取り結果ダウンロードAPIです。コールバックURLを設定して、ジョブステータスのレスポンスを自動的に送信することもできます。
一括読み取りジョブの作成
説明
このAPIは、入力JSONで指定した条件に一致するData Store内のテーブルからレコードを取得する一括読み取り操作をトリガーします。テーブルは一意のテーブルIDまたはテーブル名で参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{projectId}/bulk/read
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.tables.bulk.READ
リクエストJSONプロパティ
一括読み取りAPIリクエストの入力はJSON形式で送信する必要があります。リクエストパラメーターを以下に説明します。
一括読み取りジョブの条件と基準を定義するセクション
一括読み取り処理の結果として生成されるCSVファイルは、1ページに200,000件のレコードを含みます。
ページ値「1」は、クエリに一致する最初の200,000件のレコードがエクスポートされることを示します。ページ値を増やすことで後続のレコードを取得できます。
例えば、200,001件目から400,000件目までのレコードを取得する場合、ページ値を「2」に指定する必要があります。
デフォルト値: 1
テーブルから取得するレコード内の特定のカラム。カラムを指定しない場合、すべてのカラムが選択され取得されます。
配列に複数のカラムを含めることができます。サンプルリクエストのコードウィンドウを参照してください。
レコードが取得される基準となる条件のセット
条件グループを結合する演算子。
サポートされる演算子: AND、OR
2つ以上の条件グループを定義する場合、リクエストでANDまたはOR演算子を使用できます。例えば、前のセクションで指定した形式で「column1がvalue 1に等しい AND column2がvalue 2を含む」のような条件を指定できます。
このセクションには最大25個の条件セットを含めることができます。例では3つの条件セットを示しています。
カラム名と条件値を照合する比較演算子
サポートされる比較演算子: equal、not_equal、greater_than、greater_equal、less_than、less_equal、starts_with、ends_with、contains、not_contains、in、not_in、between、not_between
注意:
-
inおよびnot_in比較演算子には、カンマで区切って複数の値を指定できます。
-
Catalystは暗号化されたカラムに対してはequal比較演算子のみをサポートしています。暗号化されたカラムの条件として他の比較演算子を使用することはできません。
ジョブステータスの自動JSONレスポンスが送信されるコールバックURLのプロパティを定義するセクション
ジョブステータスが変更されるたびに、HTTP POSTメソッドを使用して自動レスポンスが送信されるURL。ジョブ詳細に関する情報はJSONレスポンスの本文に含まれます。
コールバックURLを設定しない場合、必要な時に一括読み取りステータス確認APIを使用してジョブ処理のステータスを手動で確認する必要があります。
コールバックURLへのJSONレスポンスで渡す必要があるヘッダー。
ヘッダーは以下の形式で指定する必要があります：
{
"{header_name_1}" : “{header_value_1}”,
"{header_name_2}" : “{header_value_2}”
}
以降同様。サンプルリクエストコードを参照してください。
コールバックURLに付加するパラメーター
パラメーターは以下の形式で指定する必要があります：
{
"{param_name_1}" : “{param_value_1}”,
"{param_name_2}" : “{param_value_2}”
}
以降同様。サンプルリクエストコードを参照してください。
レスポンス詳細
ジョブ処理には3つの状態があり、それぞれ異なるレスポンスが生成されます：
-
処理中: APIを実行すると、Catalystはジョブの実行が処理中であることを示すレスポンスを即座に自動的に送信します。リクエストでコールバックURLを設定した場合、レスポンスは定義した形式でそのURLにも送信されます。
レスポンスにはjob_id parameterが含まれ、コールバックURLを設定していない場合に、後続のレスポンスのジョブ実行ステータスの確認に使用できます。
-
成功: 成功状態のレスポンスには、一括読み取りジョブのクエリに一致するレコードを含むCSVファイルをダウンロードできるダウンロードURLが含まれます。コールバックURLを設定していない場合、このレスポンスはCatalystから自動的に送信されません。
-
失敗: 失敗状態のレスポンスには、発生したエラーの説明と詳細が含まれます。コールバックURLを設定していない場合、このレスポンスはCatalystから自動的に送信されません。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/bulk/read
-H “Authorization: Zoho-oauthtoken 1000.91016.2f*57”
-d ‘{
“table_identifier”: “EmpDetails”,
“query” : {
“page” : “1”,
“select_columns” : [
“EmpID”, “EmpName”, “Department”
],
“criteria”: {
“group_operator”: “or”,
“group”: [
{
“column_name”: “Department”,
“comparator”: “equal”,
“value”: “Marketing”
} ,
{
“column_name”: “EmpID”,
“comparator”: “greater_than”,
“value”: “1000”
} ,
{
“column_name”: “EmpName”,
“comparator”: “starts_with”,
“value”: “S”
}
]
}
},
“callback” : {
“url” : “https://hr.zylker.com/ja/EmpRecords/_callback.php",
“headers” : {
“src” : “ZCatalyst”,
“operation” : “bulkreadAPI”
},
“params” : {
“project_name” : “EmployeeDatabase”
}
}
}’
{
"status": "success",
"data": {
"job_id": 2000000118004,
"status": "In-Progress",
"operation": "read",
"project_details": {
"project_name": "ShipmentTracking",
"id": 4000000006007
},
"query": [
{
"table_id": 3376000000165541,
"details": {
"page": "1"
}
}
],
"callback": {
"url": "https://hr.zylker.com/ja/EmpRecords/_callback.php",
"headers": {
"src" : "ZCatalyst",
"operation" : "bulkreadAPI"
},
"params": {
"project_name" : "EmployeeDatabase"
}
},
"created_by": {
"zuid": 1019540152,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 06, 2020 07:06 PM"
}
}
{
"status": "success",
"data": {
"job_id": 2000000118004,
"status": "In-Progress",
"operation": "read",
"project_details": {
"project_name": "ShipmentTracking",
"id": 4000000006007
},
"query": [
{
"table_id": 3376000000165541,
"details": {
"page": "1"
}
}
],
"callback": {
"url": "https://hr.zylker.com/ja/EmpRecords/_callback.php",
"headers": {
"src" : "ZCatalyst",
"operation" : "bulkreadAPI"
},
"params": {
"project_name" : "EmployeeDatabase"
}
},
"created_by": {
"zuid": 1019540152,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 06, 2020 07:06 PM"
}
}
{
"status": "success",
"data": {
"job_id": 2000000117007,
"status": "Failed",
"operation": "read",
"project_details": {
"project_name": "ShipmentTracking",
"id": 4000000006007
},
"query": [
{
"table_id": 3376000000165541,
"details": {
"page": "1"
}
}
],
"callback": {
"url": "https://hr.zylker.com/ja/EmpRecords/_callback.php",
"headers": {
"src" : "ZCatalyst",
"operation" : "bulkreadAPI"
},
"params": {
"project_name" : "EmployeeDatabase"
}
},
"created_by": {
"zuid": 1019540152,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 06, 2020 07:00 PM",
"results": {
"description": "The column ID in select_columns is invalid",
}
}
}
一括読み取りステータスの確認
説明
このAPIを実行すると、以前に開始した一括読み取りジョブのステータスを手動で確認できます。
JSONリクエストでコールバックURLを設定していない場合、このAPIを実行してジョブステータスを自分で確認する必要があります。一括読み取り操作を開始した際に自動的に送信される処理中レスポンスに含まれるjob_idを使用して、その後のジョブステータスを確認する必要があります。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/bulk/read/{job_id}
一括読み取りAPIの実行後に最初の処理中ステータスレスポンスで送信されたジョブの一意のID
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.tables.bulk.READ
レスポンス詳細
成功状態のJSONレスポンスには、実行されたジョブの詳細と、一括読み取りジョブのクエリに一致するレコードのリストを含むCSVファイルをダウンロードできるダウンロードURLが含まれます。
失敗状態のJSONレスポンスには、実行されたジョブの詳細と、ジョブ処理で発生したエラーの説明、およびスキップされた行とその理由などの詳細が含まれます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/bulk/read/2000000118004
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"job_id": 2000000118004,
"status": "In-Progress",
"operation": "read",
"project_details": {
"project_name": "EmployeeDatabase",
"id": 4000000006007
},
"query": [
{
"table_id": 3376000000165541,
"details": {
"page": "1"
}
}
],
"callback": {
"url": "https://hr.zylker.com/ja/EmpRecords/_callback.php",
"headers": {
"src" : "ZCatalyst",
"operation" : "bulkreadAPI"
},
"params": {
"project_name" : "EmployeeDatabase"
}
},
"created_by": {
"zuid": 1019540152,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 06, 2020 07:06 PM"
}
}
{
"status": "success",
"data": {
"job_id": 2000000118004,
"status": "Completed",
"operation": "read",
"project_details": {
"project_name": "EmployeeDatabase",
"id": 4000000006007
},
"query": [
{
"table_id": 3376000000165541,
"details": {
"page": "1"
}
}
],
"callback": {
"url": "https://hr.zylker.com/ja/EmpRecords/_callback.php",
"headers": {
"src" : "ZCatalyst",
"operation" : "bulkreadAPI"
},
"params": {
"project_name" : "EmployeeDatabase"
}
},
"created_by": {
"zuid": 1019540152,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 06, 2020 07:06 PM",
"results": {
"download_url": "https://api.catalyst.zoho.com/baas/v1/bulk/read/2000000117007/download",
"description": "Bulk READ job 2000000117007 completed.",
"details": [
{
"table_id": 3376000000165541,
"records_processed": 21,
"more_records": false
}
]
}
}
}
{
"status": "success",
"data": {
"job_id": 2000000117007,
"status": "Failed",
"operation": "read",
"project_details": {
"project_name": "EmployeeDatabase",
"id": 4000000006007
},
"query": [
{
"table_id": 3376000000165541,
"details": {
"page": "1"
}
}
],
"callback": {
"url": "https://hr.zylker.com/ja/EmpRecords/_callback.php",
"headers": {
"src" : "ZCatalyst",
"operation" : "bulkreadAPI"
},
"params": {
"project_name" : "EmployeeDatabase"
}
},
"created_by": {
"zuid": 1019540152,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 06, 2020 07:00 PM",
"results": {
"description": "The column ID in select_columns is invalid",
}
}
}
一括読み取り結果のダウンロード
説明
このAPIを実行すると、開始した成功済みの一括読み取りジョブの結果をダウンロードできます。このURLは成功状態のJSONレスポンスでも送信されます。
ダウンロードされたCSV結果ファイルには、一括読み取りジョブのクエリに一致するすべてのレコードのリストが含まれます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/bulk/read/{job_id}/download
一括読み取りAPIの実行後に最初の処理中ステータスレスポンスで送信されたジョブの一意のID
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.tables.bulk.READ
レスポンス詳細
このAPIを実行すると、一括読み取りの結果ファイルがシステムの設定されたディレクトリに自動的にダウンロードされます。
ファイル形式: CSV結果ファイルを含むZIPファイル
一括読み取りジョブの詳細を示すサンプル結果ファイル：
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/bulk/read/2000000118004/download
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
レコードの一括書き込み
一括書き込み操作は、StratusのバケットにアップロードされたCSVファイルから数千のレコードを取得し、Data Store内の特定のテーブルに挿入します。このデータ集約型の操作は、単一のAPI実行で実行できます。
一括書き込み操作が正常に実行された後、ジョブ実行の詳細を含むCSVレポートファイルがダウンロードURLに生成されます。
Catalystは一括書き込み操作用に3つのAPIをサポートしています：一括書き込み作成API、ジョブ実行のステータスを手動で確認するための一括書き込みステータス確認API、および結果をダウンロードするための一括書き込み結果ダウンロードAPIです。コールバックURLを設定して、ジョブステータスのレスポンスを自動的に送信することもできます。
一括書き込みジョブの作成
説明
このAPIは、Stratusに保存されたCSVファイルからレコードを取得し、入力JSONで指定した条件に基づいてData Store内のテーブルにエクスポートする一括書き込み操作をトリガーします。CSVファイルはStratusでのオブジェクトURLを使用して参照され、テーブルは一意のテーブルIDまたはテーブル名を使用して参照されます。
注意:
-
この操作の実行を開始する前に、必要なCSVファイルをStratusにアップロードしていることを確認してください。
-
CSVファイルの最初の行はヘッダー行（カラム名がヘッダー行として存在する必要があります）でなければなりません。
-
CSVファイルにはCSVファイル標準に準拠した形式のデータが含まれている必要があります。ファイルが標準形式でない場合、テーブルに書き込まれるデータが破損する可能性があります。
-
このAPIを使用して、開発環境では各プロジェクトのテーブルごとに5,000件のレコードを挿入できます。CSVファイルにそれ以上のレコードが含まれている場合、最初の5,000件のレコードがテーブルに書き込まれます。その他のレコードは開発環境ではスキップされます。本番環境ではテーブルへの挿入に制限はありません。ただし、一括書き込みAPIは本番環境でも1回のAPIコールでCSVファイルから最大100,000件のレコードを挿入できます。それ以上のレコードを書き込む必要がある場合、それに応じて複数の一括書き込みAPIリクエストを送信し、100,000件のレコードごとにバッチで実行できます。
このAPIを使用して実行できる操作は3つあります：
- Insert: CSVファイルからテーブルにデータの新しい行を挿入します
- Update: テーブル内の既存のデータ行を更新します。レコードはテーブル内の一意のカラム、またはData Storeで生成されたROWIDを使用して識別されます。
- Upsert: 挿入と更新の両方の操作を同時に実行できます。レコードが既に存在する場合、行は更新されます。レコードが存在しない場合、そのデータの新しい行が挿入されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{projectId}/bulk/write
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.tables.bulk.CREATE
リクエストJSONプロパティ
一括書き込みAPIリクエストの入力はJSON形式で送信する必要があります。リクエストパラメーターを以下に説明します。
APIを使用して実行する操作を指定します。
許可される値: insert、update、upsert
デフォルトの操作: insert
レコードの識別に使用する一意のカラム。
例えば、「EmployeeID」という一意のカラムをfind_by値として指定すると、CatalystはData Storeテーブル内のレコードをEmployeeID値を使用して検索します。更新操作の場合、CatalystはCSVファイルのEmployeeIDに一致する行を更新します。アップサート操作の場合、Catalystは既存の行を更新し、EmployeeID値が一致するレコードがない場合は新しい行を挿入します。
Update: Data Storeで設定された一意の値を持つカラム、またはCatalystがレコードに対して生成したROWIDを指定できます。
Upsert: Data Storeで設定された一意の値を持つカラムのみ指定できます。ROWIDをfind_by値として指定することはできません。これは、アップサートでは一致するものが見つからない場合に新しい行を挿入するため、Data Storeに存在しない行のROWID値は利用できないためです。
Insert: 挿入操作にfind_byカラムを指定した場合、CSVファイルのカラム値に一致するレコードはスキップされ、Data Storeテーブルに挿入されません。これは、挿入では特定のレコードが既に存在する場合に更新できないためです。
他のテーブルで主キーとなっているカラムの外部キーマッピング。CSVファイルからインポートされたカラムを外部キーとして設定する必要がある場合に指定します。
外部キーは以下の形式でマッピングする必要があります：
{
“local_column” : “local_column_name_1”,
“reference_column” : “reference_column_name_1”
}
ここでlocal_columnは一括書き込み操作が処理されるテーブル内のカラム名、reference_columnはそのカラムが主キーであるテーブル内のカラム名です。
サンプルリクエストコードを参照してください。
ジョブステータスの自動JSONレスポンスが送信されるコールバックURLのプロパティを定義するセクション。
ジョブステータスが変更されるたびに、HTTP POSTメソッドを使用して自動レスポンスが送信されるURL。ジョブ詳細に関する情報はJSONレスポンスの本文に含まれます。
コールバックURLを設定しない場合、必要な時に一括書き込みステータス確認APIを使用してジョブ処理のステータスを手動で確認する必要があります。
コールバックURLへのJSONレスポンスで渡す必要があるヘッダー
ヘッダーは以下の形式で指定する必要があります：
{
"{header_name_1}" : “{header_value_1}”,
"{header_name_2}" : “{header_value_2}”
}
以降同様。サンプルリクエストコードを参照してください。
コールバックURLに付加するパラメーター
パラメーターは以下の形式で指定する必要があります：
{
"{param_name_1}" : “{param_value_1}”,
"{param_name_2}" : “{param_value_2}”
}
以降同様。サンプルリクエストコードを参照してください。
レスポンス詳細
ジョブ処理には3つの状態があり、それぞれ異なるレスポンスが生成されます：
-
処理中: APIを実行すると、Catalystはジョブの実行が処理中であることを示すレスポンスを即座に自動的に送信します。リクエストでコールバックURLを設定した場合、レスポンスは定義した形式でそのURLにも送信されます。
レスポンスにはjob_id parameterが含まれ、コールバックURLを設定していない場合に、後続のレスポンスのジョブ実行ステータスの確認に使用できます。
-
成功: 成功状態のレスポンスには、ジョブ実行の詳細を含むCSVレポートファイルをダウンロードできるダウンロードURLが含まれます。書き込みがスキップされたすべてのレコードとその理由がリストされます。コールバックURLを設定していない場合、このレスポンスはCatalystから自動的に送信されません。
-
失敗: 失敗状態のレスポンスには、発生したエラーの説明と詳細が含まれます。コールバックURLを設定していない場合、このレスポンスはCatalystから自動的に送信されません。
curl -X POST https://api.catalyst.zoho.com/baas/v1/project/4000000006007/bulk/write
-H “Authorization: Zoho-oauthtoken 1000.91016.2f*57”
-d ‘{
“table_identifier”: “3376000000165511”,
“operation”: “insert”,
“object_details”: {
“bucket_name”: “zylker-emp”,
“object_key”: “employees/emp_rec.csv”,
“version_id”: “3546576879809”
},
“callback”: {
“url”: “https://hr.zylker.com/ja/EmpRecords/_callback.php",
“headers”: {
“src”: “ZCatalyst”,
“operation”: “bulkwriteAPI”
},
“params”: {
“project_name”: “EmployeeDatabase”
}
},
“find_by”: “EmpID”,
“fk_mapping”: [
{
“local_column”: “EmployeeID”,
“reference_column”: “EmpID”
},
{
“local_column”: “DepartmentID”,
“reference_column”: “DeptID”
}
]
}’
{
"status": "success",
"data": {
"job_id": 2000000110044,
"status": "In-Progress",
"operation": "insert",
"project_details": {
"project_name": "ShipmentTracking",
"id": 4000000006007
},
"query": [
{
"table_id": 3376000000165511,
"object_details": {
"bucket_name": "zylker-emp",
"object_key" : "employees/emp_rec.csv",
"version_id":"3546576879809"
}
}
],
"callback": {
"url": "https://hr.zylker.com/ja/EmpRecords/_callback.php",
"headers": {
"src": "ZCatalyst",
"operation": "bulkwriteAPI"
},
"params": {
"project_name": "EmployeeDatabase"
}
},
"created_by": {
"zuid": 3000000006111,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 05, 2020 07:33 PM"
}
}
{
"status": "success",
"data": {
"job_id": 2000000110044,
"status": "Completed",
"operation": "insert",
"project_details": {
"project_name": "ShipmentTracking",
"id": 4000000006007
},
"query": [
{
"table_id": 3376000000165511,
"details": {
"object_url" : "https://zylker-emp-development.zohostratus.com/employees/emp_rec.csv"
}
}
],
"callback": {
"url": "https://hr.zylker.com/ja/EmpRecords/_callback.php",
"headers": {
"src": "ZCatalyst",
"operation": "bulkwriteAPI"
},
"params": {
"project_name": "EmployeeDatabase"
}
},
"created_by": {
"zuid": 3000000006111,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 05, 2020 07:25 PM",
"results": {
"download_url": "https://api.catalyst.zoho.com/baas/v1/bulk/write/2000000110013/download",
"description": "Bulk WRITE job completed. ",
"details": [
{
"table_id": 3376000000165511,
"records_processed": 176
}
]
}
}
}
{
"status": "success",
"data": {
"job_id": 2000000110044,
"status": "Failed",
"operation": "insert",
"project_details": {
"project_name": "ShipmentTracking",
"id": 4000000006007
},
"query": [
{
"table_id": 3376000000165511,
"details": {
"object_url" : "https://zylker-emp-development.zohostratus.com/employees/emp_rec.csv"
}
}
],
"callback": {
"url": "https://hr.zylker.com/ja/EmpRecords/_callback.php",
"headers": {
"src": "ZCatalyst",
"operation": "bulkwriteAPI"
},
"params": {
"project_name": "EmployeeDatabase"
}
}
"created_by": {
"zuid": 3000000006111,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 05, 2020 07:25 PM",
"results": {
"description": "The reference_column 'DeptID' in fk_mapping of table 3376000000165511 is not a unique column",
"details": [ ]
}
}
}
一括書き込みステータスの確認
説明
このAPIを実行すると、以前に開始した一括書き込みジョブのステータスを手動で確認できます。
JSONリクエストでコールバックURLを設定していなかった場合は、このAPIを実行してジョブステータスを自分で確認する必要があります。一括書き込み操作を開始した際に自動的に送信される処理中レスポンスに含まれるjob_idを使用して、その後のジョブステータスを確認する必要があります。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/bulk/write/{job_id}
Bulk Write APIの実行後に最初の[処理中ステータスレスポンス](/ja/api/introduction/overview-and-prerequisites/#response-details)で送信されたジョブの一意のID
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.tables.bulk.CREATE
レスポンス詳細
成功状態のJSONレスポンスには、実行されたジョブの詳細とダウンロードURLが含まれます。このURLから、ジョブ実行の詳細を含むCSVレポートファイルをダウンロードできます。書き込みがスキップされたすべてのレコードとその理由が一覧表示されます。
失敗状態のJSONレスポンスには、実行されたジョブの詳細と、ジョブ処理中に発生したエラーの説明およびその詳細が含まれます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/bulk/write/2000000110044
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"job_id": 2000000110044,
"status": "In-Progress",
"operation": "insert",
"project_details": {
"project_name": "EmployeeDatabase",
"id": 4000000006007
}
"query": [
{
"table_id": 3376000000165511,
"details": {
"object_url" : "https://zylker-emp-development.zohostratus.com/employees/emp_rec.csv",
}
}
],
"callback": {
"url": "https://hr.zylker.com/ja/EmpRecords/_callback.php",
"headers": {
"src": "ZCatalyst",
"operation": "bulkwriteAPI"
},
"params": {
"project_name": "EmployeeDatabase"
}
},
"created_by": {
"zuid": 3000000006111,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 05, 2020 07:33 PM"
}
}
{
"status": "success",
"data": {
"job_id": 2000000110044,
"status": "Completed",
"operation": "insert",
"project_details": {
"project_name": "EmployeeDatabase",
"id": 4000000006007
}
"query": [
{
"table_id": 3376000000165511,
"details": {
"object_url" : "https://zylker-emp-development.zohostratus.com/employees/emp_rec.csv"
}
}
],
"callback": {
"url": "https://hr.zylker.com/ja/EmpRecords/_callback.php",
"headers": {
"src": "ZCatalyst",
"operation": "bulkwriteAPI"
},
"params": {
"project_name": "EmployeeDatabase"
}
},
"created_by": {
"zuid": 3000000006111,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 05, 2020 07:25 PM",
"results": {
"download_url": "https://api.catalyst.zoho.com/baas/v1/bulk/write/2000000110013/download",
"description": "Bulk WRITE job completed. ",
"details": [
{
"table_id": 3376000000165511,
"records_processed": 176
}
]
}
}
}
{
"status": "success",
"data": {
"job_id": 2000000110044,
"status": "Failed",
"operation": "insert",
"project_details": {
"project_name": "EmployeeDatabase",
"id": 4000000006007
}
"query": [
{
"table_id": 3376000000165511,
"details": {
"object_url" : "https://zylker-emp-development.zohostratus.com/employees/emp_rec.csv"
}
}
],
"callback": {
"url": "https://hr.zylker.com/ja/EmpRecords/_callback.php",
"headers": {
"src": "ZCatalyst",
"operation": "bulkwriteAPI"
},
"params": {
"project_name": "EmployeeDatabase"
}
},
"created_by": {
"zuid": 3000000006111,
"is_confirmed": true,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_id": 671930409
},
"created_time": "Oct 05, 2020 07:25 PM",
"results": {
"description": "The reference_column 'DeptID' in fk_mapping of table 3376000000165511 is not a unique column",
"details": [ ]
}
}
}
一括書き込み結果のダウンロード
説明
このAPIを実行すると、以前に開始した成功した一括書き込みジョブの結果をダウンロードできます。このURLは、成功状態のJSONレスポンスにも含まれます。
ダウンロードされたCSVファイルには、ジョブ実行の詳細が含まれます。書き込みがスキップされたすべてのレコードとその理由が一覧表示されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/bulk/write/{job_id}/download
Bulk Write APIの実行後に最初の[処理中ステータスレスポンス](/ja/api/introduction/overview-and-prerequisites/#response-details)で送信されたジョブの一意のID
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.tables.bulk.CREATE
レスポンス詳細
このAPIを実行すると、一括書き込み結果ファイルがシステムの設定されたディレクトリに自動的にダウンロードされます。
ファイル形式: CSV結果ファイルを含むZIPファイル
一括書き込みジョブの詳細を示すサンプル結果ファイル：
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/bulk/write/2000000110044/download
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
テーブル内の行の一括削除
説明
このAPIを使用すると、Data Store内の特定のテーブルからレコードまたはデータ行を一括で削除できます。テーブルは一意のIDまたは名前で参照されます。
一括削除操作では、1回のAPIコールで最大200行を削除できます。サンプルリクエストに示すように、削除する行の一意のROWIDをリクエストURLのパラメーターとして渡すことで、削除する行を選択できます。
リクエストには少なくとも1つのROWIDを含める必要があり、最大200件のROWIDを含めることができます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/table/{tableIdentifier}/row?ids={rowID_1},{rowID_2},{rowID_3}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.tables.rows.DELETE
レスポンス詳細
レスポンスには、ROWIDやCREATEDTIMEなどのメタデータを含む、操作で削除されたすべての行のデータと、各行のカラムのキー名と値が含まれます。
curl -X DELETE
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/table/EmpDetails/row?ids=1028000000171815,1028000000171810,1028000000171805,1028000000171617
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": [
{
"CREATORID": "1444000000003001",
"MODIFIEDTIME": "2020-11-19 15:20:21:830",
"Department_ID":"IT245",
"Department_Name":"Finance",
"Employee_Name": "Morgan Jones",
"CREATEDTIME": "2020-11-19 15:20:21:830",
"ROWID": "1028000000171815"
},
{
"CREATORID": "1444000000003001",
"MODIFIEDTIME": "2020-11-19 15:20:34:503",
"Department_ID":"IT121",
"Department_Name":"HR",
"Employee_Name": "Leena Medley",
"CREATEDTIME": "2020-11-19 15:20:34:503",
"ROWID": "1028000000171810"
},
{
"CREATORID": "1444000000003001",
"MODIFIEDTIME": "2020-11-19 15:20:42:314",
"Department_ID":"IT783",
"Department_Name":"Marketing",
"Employee_Name": "Tamira Shah",
"CREATEDTIME": "2020-11-19 15:20:42:314",
"ROWID": "1028000000171805"
},
{
"CREATORID": "1444000000003001",
"MODIFIEDTIME": "2020-11-19 15:20:42:314",
"Department_ID":"IT098",
"Department_Name":"Sales",
"Employee_Name": "Julia McGregor",
"CREATEDTIME": "2020-11-19 15:20:42:314",
"ROWID": "1028000000171617"
}
]
}
NoSQL
Catalyst NoSQLは、アプリケーションの半構造化、非構造化、および異種データを保存できるフルマネージドの非リレーショナルNoSQLデータストレージ機能です。Catalystは、キーバリューペアベースのJSON形式でのドキュメントタイプのデータストレージをサポートしています。
Catalyst NoSQL APIを使用すると、NoSQLテーブルでCRUD操作を実行できます。アイテムの挿入、更新、削除、取得、およびテーブルやテーブルのインデックスに対するクエリの実行が可能です。
アイテムの挿入
説明
このAPIを使用すると、プロジェクト内のNoSQLテーブルに新しいアイテムを挿入できます。テーブルは一意のIDまたは名前で参照されます。
カスタムJSON形式でデータを渡すことで、条件を指定してもしなくてもアイテムを挿入できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{{project_id}}/nosqltable/{{table_identifier}}/item
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.nosql.item.INSERT
リクエストJSONプロパティ
テーブルの既存データが取得され、この条件に対して評価されます。評価がtrueの場合にのみアイテムが挿入されます。既存データがない場合、条件は無視されアイテムが挿入されます。条件を初期化するには3つの方法があります：
レスポンス詳細
レスポンスには、挿入操作のステータスと、設定されている場合はtable_name、partition_key、sort_keyなど挿入されたアイテムの詳細が返されます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/nosqltable/3376000003171728/item
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d ‘{
“item”: {
“EmpID”: {
“N”: “10999”
},
“FirstName”:{
“S”: “Paul”
},
“LastName”:{
“S”: “Smith”
},
“PriorExperience”:{
“BOOL”: false
},
“Location”: {
“M”: {
“Country”: {
“S”: “USA”
},
“City”: {
“S”: “New York”
}
}
}
}
}’
{
"status": "success",
"data": {
"table_name": "employeeDetails",
"project_details": {
"id": 4000000006007,
"project_name": "EmpDatabase",
"project_type": "Live"
}
}
}
アイテムの更新
説明
このAPIを使用すると、プロジェクト内のNoSQLテーブルの既存データからアイテムを更新できます。テーブルは一意のIDまたは名前で参照されます。
カスタムJSON形式で、条件を指定してもしなくても更新する属性を渡すことができます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{{project_id}}/nosqltable/{{table_identifier}}/item
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.nosql.item.UPDATE
リクエストJSONプロパティ
更新する属性とその値を示します。更新にはPUT（アイテム内に新しい属性を追加）とDELETE（アイテムから属性を削除）の2種類があります。attribute_pathは、実際の操作が行われるアイテム内のパスを示します。更新する値には2種類があります：
使用できる4つの関数があります：
if_not_exists - 属性の存在を確認し、存在しない場合に値を宣言します。
append_list - リストにデータを追加します。
add - 既存の値に値を追加するか、セットに要素を追加します。
reduction - 既存の値から値を減算するか、セットから要素を削除します。
テーブルの既存データが取得され、この条件に対して評価されます。評価がtrueの場合にのみアイテムが挿入されます。既存データがない場合、条件は無視されアイテムが挿入されます。条件を初期化するには3つの方法があります：
レスポンス詳細
レスポンスには、挿入操作のステータスと、設定されている場合はtable_name、partition_key、sort_keyなど更新されたアイテムの詳細が返されます。
curl -X PUT
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/nosqltable/3376000003171728/item
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d ‘{
keys:{
partition_key:{
“S”:“Country”
},
sort_key:{
“N”:“EmpID”
},
}
update_attributes:{
“item”: {
“EmpID”: {
“N”: “10999”
},
“FirstName”:{
“S”: “Paul”
},
“LastName”:{
“S”: “Smith”
},
“PriorExperience”:{
“BOOL”: false
},
“Location”: {
“M”: {
“Country”: {
“S”: “USA”
},
“City”: {
“S”: “New York”
}
}
}
}
}
}’
{
"status": "success",
"data": {
"table_name": "employeeDetails",
"project_details": {
"id": 4000000006007,
"project_name": "EmpDatabase",
"project_type": "Live"
}
}
}
アイテムの取得
説明
このAPIを使用すると、プロジェクト内のNoSQLテーブルからアイテムを取得できます。テーブルは一意のIDまたは名前で参照されます。
取得するアイテムの属性を指定でき、マスターまたはスレーブクラスターから取得する必要があるかどうかも指定できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{{project_id}}/nosqltable/{{table_identifier}}/item/fetch
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.nosql.item.READ
リクエストJSONプロパティ
レスポンス詳細
レスポンスには、取得操作のステータスと取得されたアイテムが返されます。アイテムのすべての属性または指定された属性が取得されます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/nosqltable/3376000003171728/item/fetch
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d ‘{
keys:{
partition_key:{
“S”:“Country”
},
sort_key:{
“N”:“EmpID”
},
}
required_attributes: {
“EmpID”,
“FirstName”,
“LastName”,
“PriorExperience”
},
consistent_read: “true”
}’
{
"status": "success",
"data": {
fetched_attributes:{
"item": {
"EmpID": {
"N": "10999"
},
"FirstName":{
"S": "Paul"
},
"LastName":{
"S": "Smith"
},
"PriorExperience":{
"BOOL": false
}
}
}
}
}
アイテムの削除
説明
このAPIを使用すると、プロジェクト内のNoSQLテーブルからアイテムを削除できます。テーブルは一意のIDまたは名前で参照されます。
カスタムJSON形式でデータを渡すことで、条件を指定してもしなくてもアイテムを削除できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{{project_id}}/nosqltable/{{table_identifier}}/item
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.nosql.item.INSERT
リクエストJSONプロパティ
テーブルの既存データが取得され、この条件に対して評価されます。評価がtrueの場合にのみアイテムが挿入されます。既存データがない場合、条件は無視されアイテムが挿入されます。条件を初期化するには3つの方法があります：
レスポンス詳細
レスポンスには、挿入操作のステータスと、設定されている場合はtable_name、partition_key、sort_keyなど挿入されたアイテムの詳細が返されます。
curl -X DELETE
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/nosqltable/3376000003171728/item
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d ‘{
“item”: {
“EmpID”: {
“N”: “10999”
},
“FirstName”:{
“S”: “Paul”
},
“LastName”:{
“S”: “Smith”
},
“PriorExperience”:{
“BOOL”: false
},
“Location”: {
“M”: {
“Country”: {
“S”: “USA”
},
“City”: {
“S”: “New York”
}
}
}
}
}’
{
"status": "success",
"data": {
"table_name": "employeeDetails",
"project_details": {
"id": 4000000006007,
"project_name": "EmpDatabase",
"project_type": "Live"
}
}
}
テーブルのクエリ
説明
このAPIを使用すると、プロジェクト内のNoSQLテーブルをクエリしてデータを取得できます。テーブルは一意のIDで参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{{project_id}}/nosqltable/{{table_identifier}}/item/query
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.nosql.POST
リクエストJSONプロパティ
レスポンス詳細
レスポンスには、クエリ操作のステータスと、クエリで設定された条件に従って取得されたアイテムが返されます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/nosqltable/3376000003171728/item/query
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d -d ‘{
key_condition:{
partition_key:{
“S”:“Country”
},
sort_key:{
“N”:“EmpID”
},
}
required_attributes: {
“EmpID”,
“FirstName”,
“LastName”,
“PriorExperience”
},
consistent_read: “true”
}’
{
“status”: “success”,
“data”: {
fetched_data:{
“item”: {
“EmpID”: {
“N”: “10999”
},
“FirstName”:{
“S”: “Paul”
},
“LastName”:{
“S”: “Smith”
},
“PriorExperience”:{
“BOOL”: false
}
}
}
}
}
インデックスのクエリ
説明
このAPIを使用すると、プロジェクト内のNoSQLインデックスをクエリしてデータを取得できます。インデックスは一意のIDで参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{{project_id}}/nosqltable/{{table_identifier}}//index/{{index_identifier/}}/item/query
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.nosql.POST
リクエストJSONプロパティ
レスポンス詳細
レスポンスには、クエリ操作のステータスと、クエリで設定された条件に従って取得されたアイテムが返されます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/nosqltable/3376000003171728/index/786387162881/item/query
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d -d ‘{
key_condition:{
partition_key:{
“S”:“Country”
},
sort_key:{
“N”:“EmpID”
},
}
required_attributes: {
“EmpID”,
“FirstName”,
“LastName”,
“PriorExperience”
},
consistent_read: “true”
}’
{
“status”: “success”,
“data”: {
fetched_data:{
“item”: {
“EmpID”: {
“N”: “10999”
},
“FirstName”:{
“S”: “Paul”
},
“LastName”:{
“S”: “Smith”
},
“PriorExperience”:{
“BOOL”: false
}
}
}
}
}
Stratus
Stratusは、Catalystの堅牢なクラウドストレージソリューションです。シンプルなアップロード操作で、あらゆるタイプのデータをバケットと呼ばれるコンテナ内にオブジェクトとして保存できます。
すべてのバケットの取得
説明
このAPIは、Stratus内に存在するすべてのバケットの利用可能な詳細をすべて取得できるようにします。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/bucket
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.buckets.READ
レスポンス詳細
レスポンスは、bucket_nameを含むすべてのバケットのメタデータと詳細、およびバケットを作成・最終更新したユーザーの詳細を返します。
curl -X GET https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": [
{
"bucket_name": "fsbucket17",
"project_details": {
"project_name": "Project-Rainfall-4",
"id": 2000000000075,
"project_type": "Live"
},
"created_by": {
"zuid": 18599686,
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia B",
"last_name": "Fstest",
"user_type": "Admin",
"user_id": 2000000000055
},
"created_time": "Sep 27, 2023 05:01 PM",
"modified_by": {
"zuid": 18599686,
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia B",
"last_name": "Fstest",
"user_type": "Admin",
"user_id": 2000000000055
},
"modified_time": "Sep 27, 2023 05:01 PM",
"bucket_meta": {
"versioning": false,
"caching": {
"status": "Disabled"
},
"encryption": false,
"audit_consent": false
},
"bucket_url": "https://fsbucket17-development.zohostratus.com"
},
{
"bucket_name": "fsbucket16",
"project_details": {
"project_name": "Project-Rainfall-4",
"id": 2000000000075,
"project_type": "Live"
},
"created_by": {
"zuid": 18599686,
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia B",
"last_name": "Fstest",
"user_type": "Admin",
"user_id": 2000000000055
},
"created_time": "Sep 27, 2023 04:58 PM",
"modified_by": {
"zuid": 18599686,
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia B",
"last_name": "Fstest",
"user_type": "Admin",
"user_id": 2000000000055
},
"modified_time": "Sep 27, 2023 04:58 PM",
"bucket_meta": {
"versioning": false,
"caching": {
"status": "Disabled"
},
"encryption": true,
"audit_consent": true
},
"bucket_url": "https://fsbucket16-development.zohostratus.com"
},
{
"bucket_name": "fsbucket15",
"project_details": {
"project_name": "Project-Rainfall-4",
"id": 2000000000075,
"project_type": "Live"
},
"created_by": {
"zuid": 18599686,
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia B",
"last_name": "Fstest",
"user_type": "Admin",
"user_id": 2000000000055
},
"created_time": "Sep 27, 2023 04:57 PM",
"modified_by": {
"zuid": 18599686,
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia B",
"last_name": "Fstest",
"user_type": "Admin",
"user_id": 2000000000055
},
"modified_time": "Sep 27, 2023 04:57 PM",
"bucket_meta": {
"versioning": true,
"caching": {
"status": "In-Progress"
},
"encryption": false,
"audit_consent": false
},
"bucket_url": "https://fsbucket15-development.zohostratus.com"
}
]
}
バケットの取得
説明
このAPIは、Stratus内に存在するバケットの利用可能な詳細をすべて取得できるようにします。バケットはその一意のバケット名で参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/bucket/{bucket_name}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.buckets.READ
レスポンス詳細
レスポンスは、bucket_nameを含む特定のバケットのメタデータと詳細、およびバケットを作成・最終更新したユーザーの詳細を返します。
curl -X GET https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket?bucket_name=mybucketname/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": [
{
"bucket_name": "fsbucket17",
"bucket_url": "https://fsbucket17-development.stratus.com",
"objects_count": 21,
"size_in_bytes": 145578,
"project_details": {
"project_name": "Project-Rainfall-4",
"id": 2000000000075,
"project_type": "Live"
},
"created_by": {
"zuid": 18599686,
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia B",
"last_name": "Fstest",
"user_type": "Admin",
"user_id": 2000000000055
},
"created_time": "Sep 27, 2023 05:01 PM",
"modified_by": {
"zuid": 18599686,
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia B",
"last_name": "Fstest",
"user_type": "Admin",
"user_id": 2000000000055
},
"modified_time": "Sep 27, 2023 05:01 PM",
"bucket_meta": {
"versioning": true,
"caching": {
"status": "Enabled"
},
"encryption": true,
"audit_consent": false
}
}
]
}
すべてのオブジェクトの取得
説明
このAPIは、バケットに保存されているすべてのオブジェクトを取得できるようにします。バケットはその一意のバケット名で参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/bucket/objects
クエリパラメータ
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.buckets.objects.READ
レスポンス詳細
正常に実行されると、レスポンスには必要なバケットに保存されているすべてのオブジェクトの一覧が含まれます。
curl -X GET https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/buckets/objects?bucket_name=mybucketname&max_keys=10&continuation_token=Sg43ou34rd2bih223oc8csc&prefix=myfolder/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"key_count": 5,
"max_keys": 5,
"truncated": true,
"next_continuation_token": "n2BjzZo5FvrSQmx7z5LaJk7cvP2Yf2K6AJHw4Sg692TnfwHasUp8DJp8qL24A3TLAGPu8zyEysfjfQpjohEMaej",
"contents": [
{
"key_type": "file",
"key": "server 96.zip",
"version_id": "01hh9hnwxw8r88kzzfnkn67grr",
"size": 3012536,
"content_type": "application/zip",
"etag": "e460808d4190b37c472985a1f1d85720",
"last_modified": "Dec 10, 2023 03:12 PM"
},
{
"key_type": "file",
"key": "oauthscopes.csv",
"version_id": "01hh9hnhypzt63fwf5wyk2ef6f",
"size": 19804,
"content_type": "text/csv",
"etag": "354266606189c30c80f336720102ead6",
"last_modified": "Dec 10, 2023 03:11 PM"
},
{
"key_type": "folder",
"key": "lib 3",
"size": 0,
"last_modified": "Dec 10, 2023 03:11 PM"
},
{
"key_type": "file",
"key": "funcauthtest-Development (1).zip",
"version_id": "01hh9hkv8xvetbxnrhx6c7444y",
"size": 8485,
"content_type": "application/zip",
"etag": "5f868df044e91a4c7e26be26b6e93a64",
"last_modified": "Dec 10, 2023 03:10 PM"
},
{
"key_type": "file",
"key": "Automl_LZ (1).csv",
"version_id": "01hh9hkfdf07y8pnpbwtkt8cf7",
"size": 257,
"content_type": "text/csv",
"etag": "223a363af39a49d4b32f6cdf0c569755",
"last_modified": "Dec 10, 2023 03:10 PM"
}
]
}
}
特定のオブジェクトの取得
説明
このAPIは、バケットに保存されている特定のオブジェクトを取得できるようにします。バケットはその一意のバケット名で参照され、必要なオブジェクトはその名前を使用して参照されます。
バージョニングが有効な場合、必要なオブジェクトはその一意のversion IDを使用しても参照できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/bucket/object
クエリパラメータ
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.buckets.objects.READ
レスポンス詳細
正常に実行されると、レスポンスにはリクエストされたオブジェクトの詳細が含まれます。
curl -X GET https://api.catalyst.zoho.com/baas/v1/project/{projectID}/bucket/object?bucket_name={bucketName}&version_id={versionID}&object_key={objectPath}
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"key": "Automl_LZ (1).csv",
"size": 257,
"content_type": "text/csv",
"last_modified": "Dec 10, 2023 03:10 PM",
"meta_data": {
"automl_metakey": "metavalue"
},
"object_url": "https://gcpimport2-development.csezstratus.com/Automl_LZ%20(1).csv"
}
}
オブジェクトの全バージョン取得
説明
このAPIは、バケットに保存されているオブジェクトのすべてのバージョンを取得できるようにします。バケットはその一意のバケット名で参照され、必要なオブジェクトはその名前を使用して参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/bucket/objects/versions
クエリパラメータ
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.buckets.objects.READ
レスポンス詳細
正常に実行されると、レスポンスには必要なオブジェクトのすべてのバージョンの詳細一覧が含まれます。
curl -X GET https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/objects/versions?bucket_name=zylker-bucket&object_key=sampleimage&max_versions=10&continuation_token=Sg43ou34rd2bih223oc8csc/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"truncated": true,
"key": "Automl_LZ (1).csv",
"versions_count": 2,
"max_versions": 2,
"is_truncated": true,
"next_continuation_token": "97tn3xP3te66VpfVwVJwtDAgouBKVNhGAV6jzGY6DMdX6hcJmwJKbFX3unakGdfKfJ",
"version": [
{
"latest": true,
"version_id": "01hh9hkfdf07y8pnpbwtkt8cf7",
"is_latest": true,
"last_modified": "Dec 10, 2023 03:10 PM",
"size": 257,
"etag": "223a363af39a49d4b32f6cdf0c569755"
},
{
"latest": false,
"version_id": "01hh9hjtge85k1fx2yp1kg8r2q",
"is_latest": false,
"last_modified": "Dec 10, 2023 03:10 PM",
"size": 257,
"etag": "223a363af39a49d4b32f6cdf0c569755"
}
]
}
}
バケットの可用性確認
説明
このAPIは、Stratus内に存在する特定のバケットの可用性を確認できるようにします。バケットはその一意のバケット名を使用して参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/bucket/{bucket_name}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.buckets.READ
レスポンス詳細
レスポンスは以下のいずれかのステータスコードになります:
- 200: バケットが利用可能で、ユーザーがアクセスするための関連する権限を持っている場合。
- 403: バケットは存在するが、ユーザーがバケットにアクセスするための関連する権限を持っていない場合。
- 404: バケットが存在しない場合。
curl -X HEAD https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket?bucket_name=myBucketName/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
オブジェクトの可用性確認
説明
このAPIは、特定のオブジェクトがバケットに保存されているかどうかを確認できるようにします。バケットはその一意のバケット名で参照され、必要なオブジェクトはその名前を使用して参照されます。
バージョニングが有効な場合、必要なオブジェクトはその一意のversion IDを使用しても参照できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/bucket/objects
クエリパラメータ
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.buckets.objects.READ
レスポンス詳細
正常に実行されると、レスポンスにはオブジェクトがバケット内に存在することを示す200ステータスコードが含まれます。オブジェクトが正しくないか、バケット内に存在しない場合は、レスポンスとして404ステータスコードが返されます。
curl -X HEAD https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/object?bucket_name=myBucketName&object_key=image.jpeg&version_id=dfd233fcds2wd223/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
オブジェクトのダウンロード
説明
このAPIは、バケットに保存されている必要なオブジェクトをダウンロードできるようにします。バケットはその一意のバケット名で参照され、必要なオブジェクトはその名前を使用して参照されます。
リクエスト詳細
リクエストURL
{bucket_name}.zohostratus.com/{key}
上記のドメイン名はデータセンターに応じて変わります:
| DC | ドメイン名 |
|---|---|
| US | zohostratus.com |
| EU | zohostratus.eu |
| IN | zohostratus.in |
| AU | zohostratus.com.au |
| CA | zohostratus.ca |
| SA | zohostratus.sa |
| JP | zohostratus.jp |
注意:
-
開発環境でAPIを使用する場合、ドメインは次のような構造になります: https://<bucket_name>-development.zohostratus.com
-
コンソールからバケットURLを取得することをお勧めします。
パスパラメータ
クエリパラメータ
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
Range: オブジェクトの特定のバイト範囲をダウンロードする場合
retrieve-meta: オブジェクトのメタデータを取得する場合 | 指定可能な値: True/False | デフォルト値: False
スコープ
Stratus.fileop.READ
レスポンスをオーバーライドするクエリパラメータ
以下のクエリパラメータを追加してレスポンスを変更し、必要なレスポンスを取得できます。これらはすべてオプションパラメータです。オーバーライドはリクエストが成功した場合にのみ機能します。
attachment; filename=“name”
例: attachment; filename=“logo.svg”
例: public,max-age=3600,no-transform
レスポンス詳細
正常に実行されると、レスポンスにはオブジェクトがダウンロードされ、成功メッセージが表示されます。
失敗レスポンスの可能性
404 オブジェクト/バケットが見つからない場合:
{
"status": 404,
"code": "key_not_found",
"message": "no such key is associated with any object in the bucket"
}
403 未認証。ダウンロード操作を実行するために必要な権限がない場合
{
"status": 403,
"code": "access_forbidden",
"message": "request denied by resource access policy"
}
curl -X GET https://{bucket_name}.zohostratus.com/{key}
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
200 OK
// 生データのバイト
オブジェクトのアップロード
説明
このAPIは、必要なオブジェクトをバケットにアップロードできるようにします。バケットはその一意のバケット名で参照され、必要なオブジェクトはその名前を使用して参照されます。
リクエスト詳細
リクエストURL
{bucket_name}.zohostratus.com/{key}
上記のドメイン名はデータセンターに応じて変わります:
| DC | ドメイン名 |
|---|---|
| US | zohostratus.com |
| EU | zohostratus.eu |
| IN | zohostratus.in |
| AU | zohostratus.com.au |
| CA | zohostratus.ca |
| SA | zohostratus.sa |
| JP | zohostratus.jp |
パスパラメータ
注意: keyの値を指定する際には、以下の点に注意してください:
-
キーの最大長（パス名とオブジェクト名を含む）は255文字までサポートされます。
-
キーにはスペースを含む以下の文字を含めることはできません: ダブルクォート、両方の山括弧、ハッシュタグ、バックスラッシュ、パイプ記号。
クエリパラメータ
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
content-type: application/json
content-length: アップロードされるオブジェクトのバイト単位の生の長さ。
compress: 保存時にオブジェクトを圧縮するかどうか。デフォルトでは常に圧縮が行われます。
cache-control: ブラウザのキャッシュポリシーを指定するためにこのヘッダーを使用します。
overwrite: ソースを上書きする必要があるかどうかを指定します。これはバージョニングされていないバケットのオブジェクトのみサポートされます。
expires-after: オブジェクトのTime-to-Live（TTL）を秒単位で設定するために使用できるオプションです。値は60秒以上である必要があります。
x-user-meta:{1stKey}={1stValue};{2ndKey}={2ndValue};..{NthKey}={NthValue};: オブジェクトのメタデータ。各キーと値のペアはセミコロンで区切られ、前のカラムに示されているように提供されます。このヘッダーの最大許可文字数は2047文字です。
スコープ
Stratus.fileop.CREATE
レスポンス詳細
正常に実行されると、レスポンスには成功メッセージが含まれ、オブジェクトがアップロードされます。
失敗レスポンスの可能性
404 オブジェクト/バケットが見つからない場合:
{
"status": 404,
"code": "bucket_not_found",
"message": "no such bucket exists"
}
403 未認証。アップロード操作を実行するために必要な権限がない場合
{
"status": 403,
"code": "access_forbidden",
"message": "request denied by resource access policy"
}
400 不正なリクエスト。無効なファイル名
{
"status": 400,
"code": "key_name_invalid",
"message": "key name does not support one or more character(s)"
}
409 コンフリクト。同じ名前のオブジェクトが既に存在する
{
"status": 409,
"code": "key_already_exists",
"message": "key is already associated with another object in the bucket"
}
curl -X PUT https://{bucket_name}.zohostratus.com/{key}
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
200 OK
オブジェクトのコピー
説明
このAPIは、バケットに保存されている必要なオブジェクトをコピーできるようにします。バケットはその一意のバケット名で参照され、必要なオブジェクトはその名前を使用して参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/bucket/object/copy
クエリパラメータ
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.buckets.objects.CREATE
レスポンス詳細
正常に実行されると、レスポンスにはコピーされたオブジェクトの名前、コピー先の場所、およびコピー操作を確認する成功メッセージが含まれます。
curl -X POST https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/object/copy?bucket_name=myBucketName&object_key=mappedsample/Archive.zip&destination=mappedsample/Unarchive/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"object_key": "image2.png",
"copy_to": "folder2/",
"message": "Copy successful"
}
}
オブジェクトの名前変更
説明
このAPIは、バケットに保存されている必要なオブジェクトの名前を変更できるようにします。バケットはその一意のバケット名で参照され、必要なオブジェクトはその名前を使用して参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/bucket/object
クエリパラメータ
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.buckets.objects.UPDATE
レスポンス詳細
正常に実行されると、レスポンスには変更前の名前、変更後の名前、および名前変更操作を確認する成功メッセージが含まれます。
curl -X PATCH https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/object/?bucket_name=myBucketName¤t_key=image2.png&rename_to=renamed.png/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"current_key": "image2.png",
"rename_to": "renamed.png",
"message": "Rename successful"
}
}
オブジェクトメタデータの設定
説明
このAPIは、バケットに保存されている必要なオブジェクトにメタデータを追加できるようにします。バケットはその一意のバケット名で参照され、必要なオブジェクトはその名前を使用して参照されます。
注意:
-
メタデータの記述には、英数字、アンダースコア、またはスペース文字、およびハイフンを使用できます。上記以外の特殊文字は使用できません。
-
HEADリクエストメソッドを使用してオブジェクトのメタデータを取得できます。レスポンスでは、メタデータはキー ‘x-user-meta’ に一覧表示されます。
-
メタデータ全体の最大サイズ制限は2047文字です。サイズ制限を決定するために使用される文字数には、キーと値のペアを定義するために使用されるコロン “:“特殊文字も含まれます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/bucket/object/metadata
リクエストJSON
以下に示すように、対応する値を含むJSONを送信する必要があります。
{
"meta_data": {
"key1": "value1",
"key2": "value2"
}
}
このリクエストJSONをリクエストボディにフィードし、以下の値を提供する必要があります:
クエリパラメータ
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.buckets.objects.CREATE
レスポンス詳細
正常に実行されると、レスポンスには必要なオブジェクトにメタデータが追加されたことを示す成功メッセージが含まれます。
curl -X PUT https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/object/metadata?bucket_name=myBucketName&object_key=image2.png/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
--data-raw $’{"{“meta_data” : {“key1” : “value1”,“key2” : “value2”}}"}'
{
"status": "success",
"data": {
"message": "Metadata added successfully"
}
}
ZIPオブジェクトの展開
説明
このAPIは、バケットに保存されているZIP形式のオブジェクトを展開できるようにします。バケットはその一意のバケット名で参照され、必要なオブジェクトはその名前を使用して参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/bucket/object/zip-extract
クエリパラメータ
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.buckets.objects.CREATE
レスポンス詳細
正常に実行されると、レスポンスにはZIPオブジェクトの名前、展開されたオブジェクトが保存された完全なパス名、および展開操作を確認する成功メッセージが含まれます。
curl -X POST https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/object/zip-extract?bucket_name=mybucketname&object_key=image2.png&destination=folder2/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"object_key": "image2.png",
"destination": "folder2",
"message": "Zip extract scheduled",
"task_id": "hh2odww2334nsodno24"
}
}
ZIP展開操作のステータス取得
説明
このAPIは、バケットに保存されているZIPオブジェクトに対して実行されている展開操作のステータスを取得できるようにします。バケットはその一意のバケット名で参照され、必要なオブジェクトはその名前を使用して参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/bucket/object/zip-extract/{taskId}
クエリパラメータ
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.buckets.objects.READ
レスポンス詳細
正常に実行されると、レスポンスにはStratus内のZIPオブジェクトに対して実行されている必要な展開プロセスのステータスが含まれます。
curl -X GET https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/object/zip-extract/hh2odww2334nsodno24?bucket_name=mybucketname&object_key=image2.png/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"task_status": "PENDING | COMPLETED | FAILED"
}
}
バケットの署名作成
説明
このAPIは、必要なバケットの署名を作成できるようにします。バケットはその一意のバケット名で参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/bucket/signature
クエリパラメータ
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.buckets.objects.CREATE
レスポンス詳細
正常に実行されると、レスポンスにはバケットの必要な署名とその有効期間が含まれます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/bucket/signature?bucket_name=zylker-bucket
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"signature": "stsPolicy=eyJzaWduaW5ndGltZSI6MTcyMTk3NDc1NDQ1MiwiZXhwaXJhdGlvbiI6MzYwMCwiYWN0aW9uIjpbIkdldE9iamVjdCIsIlB1dE9iamVjdCJdLCJjcmVkZW50aWFscyI6IjY3MjUxNjQ0LTg1NDM1OTI2IiwicmVzb3VyY2UiOlsic3JuOjo6dGVzdGRzZHMtZGV2ZWxvcG1lbnQvKiJdLCJxdWVyeSI6W10sImhlYWRlcnMiOltdLCJib2R5Ijp7ImNvbnRlbnQtdHlwZSI6IioiLCJjb250ZW50LWxlbmd0aCI6bnVsbH19&stsSignature=Nyr29x7N-CzDSfFaTzzPnwWsL74ga9rIGZJIxWFdNtI",
"expiry_time": 1786382487000
}
}
署名付きURLの取得
説明
このAPIは、署名付きURLを取得できるようにします。署名付きURLは、認証済みユーザーが非認証ユーザーと共有できるセキュアなURLです。このURLにより、非認証ユーザーにオブジェクトへの一時的なアクセス権限が付与されます。リンクの有効期限が切れた場合、このAPIを使用して必要なURLに再度署名する必要があります。
リクエスト詳細
アップロード操作のリクエストURL
{api-domain}/baas/v1/project/{project_id}/bucket/object/signed-url
ダウンロード操作のリクエストURL
{api-domain}/baas/v1/project/{project_id}/bucket/object/signed-url
クエリパラメータ
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
ダウンロードのスコープ
ZohoCatalyst.buckets.objects.READ
アップロードのスコープ
ZohoCatalyst.buckets.objects.CREATE
レスポンス詳細
正常に実行されると、レスポンスには署名付きURLが含まれます。
curl -X GET https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/object/signed-url?bucket_name=myBucketName&object_key=object.pdf&expiry_in_seconds=3600&active_from=1716382375000&version_id=bs22sb2923ey2hds929/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
curl -X PUT https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/object/signed-url?bucket_name=myBucketName&object_key=object.pdf&expiry_in_seconds=3600&active_from=1716382375000/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"signature": "https://mybucket.nimbuspop.com/folder1/folder2/image.jpeg?expires=1642915027000&signature=MEYCIQCcJDTsmZQhfuvFu3l3tsVL02uVwIMhLdlSg~ARI3E1aAIhAJ-rzzjn2gPH9pB3EoU3X~v~qvg5Rdt9OBoldBpVz6xt&key-id=vMUWDURn5DGtokPG",
"expires_in_seconds": 300,
"active_from": 1716382487000
}
}
オブジェクトの削除
説明
このAPIは、バケットに保存されている必要なオブジェクトを削除できるようにします。バケットはその一意のバケット名で参照され、必要なオブジェクトはその名前を使用して参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/bucket/object/
クエリパラメータ
リクエストJSON
以下に示すように、対応する値を含むJSONを送信する必要があります。
{
"objects": [
{
"key": "file1.jpeg",
"version_id": "{version_id}"
},
{
"key": "file2.jpeg"
},
{
"key": "file3.jpeg"
}
],
"ttl_in_seconds": 100
}
このリクエストJSONをリクエストボディにフィードし、以下の値を提供する必要があります:
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.buckets.objects.DELETE
レスポンス詳細
正常に実行されると、レスポンスには削除操作が成功したことを確認する成功メッセージが含まれます。
curl -X PUT https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/object?bucket_name=zylker-bucket/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
--data-raw $’{““status”: “success”,“data”:{“message”: “Deletion successful”}”}'
{
"status": "success",
"data": {
"message": "Deletion successful"
}
}
パスの削除
説明
このAPIは、バケット内のパス全体とそのパスに保存されているすべてのオブジェクトを削除できるようにします。バケットはその一意のバケット名で参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/bucket/object/prefix
クエリパラメータ
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.buckets.objects.DELETE
レスポンス詳細
正常に実行されると、レスポンスには削除操作が成功したことを確認する成功メッセージが含まれます。
curl -X DELETE https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/bucket/object/prefix?bucket_name=zylker-bucket&prefix=myfolder/
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"prefix": "myfolder/",
"message": "Deletion successful"
}
}
File Store
早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。
Catalyst File Storeは、アプリケーションファイルやユーザーデータファイル（画像、動画、CSVファイル、スプレッドシートなど）をフォルダに保存、管理、整理するためのクラウドストレージソリューションを提供します。
特定のフォルダの詳細の取得
説明
このAPIを使用すると、File Store内の特定のフォルダの詳細と、そのフォルダ内のすべてのファイルの詳細を取得できます。フォルダは一意のフォルダIDで参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/folder/{folder_id}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.folders.READ
レスポンス詳細
JSONレスポンスには、folder_name、作成者および最終更新者の詳細などの特定のフォルダのメタデータと、フォルダ内のすべてのファイルのメタデータ（各ファイルのfile_id、file_name、file_sizeなど）が返されます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/folder/3376000000427654
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status":"success",
"data":{
"folder_name":"PricingInfo",
"created_time":"Apr 01, 2020 11:11 AM",
"created_by":{
"zuid":1019540152,
"is_confirmed":true,
"email_id":"emma@zylker.com",
"first_name":"Amelia",
"last_name":"Burrows",
"user_id":671930455
},
"modified_time":"Apr 11, 2020 10:41 PM",
"modified_by":{
"zuid":1019540876,
"is_confirmed":true,
"email_id":"p.boyle@zylker.com",
"first_name":"Patricia",
"last_name":"Boyle",
"user_id":671930321
},
"project_details":{
"project_name":"ShipmentTracking",
"id":4000000006007
},
"file_details":[
{
"id":337600000030123,
"file_location":null,
"file_name":"PO1898908GT.pdf",
"file_size":10,
"created_by":{
"zuid":1019540199,
"is_confirmed":true,
"email_id":"jane.simmons@zylker.com",
"first_name":"Jane",
"last_name":"Simmons",
"user_id":671930000
},
"created_time":"Feb 21, 2020 01:11 PM",
"modified_by":{
"zuid":1019540152,
"is_confirmed":true,
"email_id":"p.boyle@zylker.com",
"first_name":"Patricia",
"last_name":"Boyle",
"user_id":671930321
},
"modified_time":"Jan 13, 2020 08:00 PM",
"project_details":{
"project_name":"ShipmentTracking",
"id":4000000006007
},
"folder_details": 3376000000427654
},
{
"id":337600000030121,
"file_location":null,
"file_name":"ST1898190CR.pdf",
"file_size":9,
"created_by":{
"zuid":1019540152,
"is_confirmed":true,
"email_id":"p.boyle@zylker.com",
"first_name":"Patricia",
"last_name":"Boyle",
"user_id":671930321
},
"created_time":"Jan 01, 2020 09:09 PM",
"modified_by":{
"zuid":1019540152,
"is_confirmed":true,
"email_id":"p.boyle@zylker.com",
"first_name":"Patricia",
"last_name":"Boyle",
"user_id":671930321
},
"modified_time":"Mar 11, 2020 07:09 AM",
"project_details":{
"project_name":"ShipmentTracking",
"id":4000000006007
},
"folder_details":3376000000427654
}
],
"audit_consent": false,
"id":829000000038455
}
}
すべてのフォルダの詳細の取得
説明
早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。
このAPIを使用すると、File Storeからプロジェクト内のすべてのフォルダの詳細を取得できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/folder
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.folders.READ
レスポンス詳細
JSONレスポンスには、folder_name、作成者および最終更新者の詳細、プロジェクト詳細などのすべてのフォルダのメタデータが返されます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/folder
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status":"success",
"data":[
{
"folder_name":"ShipmentOrderForms",
"created_time":"Oct 22, 2019 11:01 AM",
"created_by":{
"zuid":1019540152,
"is_confirmed":true,
"email_id":"emma@zylker.com",
"first_name":"Amelia",
"last_name":"Burrows",
"user_type": "Admin",
"user_id":671930455
},
"modified_time": "Jun 05, 2023 12:26 AM",
"modified_by": {
"zuid": 671930455,
"is_confirmed": false,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_type": "Admin",
"user_id": 671930455
},
"project_details":{
"project_name":"ShipmentTracking",
"id":4000000006007
},
"audit_consent": false,
"id":105000000121098
}
{
"folder_name":"PricingInfo",
"created_time":"Sep 01, 2019 03:33 PM",
"created_by":{
"zuid":1019540152,
"is_confirmed":true,
"email_id":"p.boyle@zylker.com",
"first_name":"Patricia",
"last_name":"Boyle",
"user_type": "Admin",
"user_id":671930765
},
"modified_time": "Jun 05, 2023 12:26 AM",
"modified_by": {
"zuid": 671930455,
"is_confirmed": false,
"email_id": "p.boyle@zylker.com",
"first_name": "Patricia",
"last_name": "Boyle",
"user_type": "Admin",
"user_id": 671930765
},
"project_details":{
"project_name":"ShipmentTracking",
"id":4000000006007
},
"audit_consent": false,
"id":105000000145678
}
]
}
フォルダへのファイルのアップロード
説明
早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。
このAPIを使用すると、フォルダの一意のIDを参照して、ローカルシステムからFile Store内の既存のフォルダにファイルをアップロードできます。画像、テキストドキュメント、CSV、またはその他の必要な種類のファイルをアップロードできます。アップロードできるファイルの最大サイズは100 MBです。
APIリクエストでは、サンプルリクエストに示されているように、ファイルパスとファイル名を指定する必要があります。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/folder/{folder_id}/file
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.files.CREATE
リクエストJSONプロパティ
コンピュータ内のアップロードするファイルのパス
許可される最大ファイルサイズ: 100 MB
レスポンス詳細
JSONレスポンスには、file_name、file_size、ファイルをアップロードしたユーザーの詳細など、アップロードされたファイルのメタデータが返されます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/folder/105000000121098/file
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F code=@/Desktop/EmployeeInfo.csv
-F file_name=EmployeeInfo
{
"status": "success",
"data": {
"id": 56000000368030,
"file_location": null,
"file_name": "EmployeeInfo",
"file_size": 264328,
"created_by": {
"zuid": 1019540152,
"is_confirmed": false,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_type": "Admin",
"user_id": 64635102
},
"created_time": "Jun 05, 2023 12:40 AM",
"modified_by": {
"zuid": 1019540152,
"is_confirmed": false,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows",
"user_type": "Admin",
"user_id": 64635102
},
"modified_time": "Jun 05, 2023 12:40 AM",
"project_details": {
"project_name": "EmployeePortal",
"id": 3376000001796044,
"project_type": "Live"
},
"folder_details": 3376000001925212
}
}
フォルダからのファイルのダウンロード
説明
早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。
このAPIを使用すると、フォルダとファイルの一意のIDを参照して、File Store内の既存のフォルダからファイルをダウンロードできます。
このAPIを実行すると、ファイルはシステムの設定されたディレクトリに自動的にダウンロードされます。Catalystはこのリクエストに対してレスポンスを返しません。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/folder/{folder_id}/file/{file_id}/download
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.files.READ
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/folder/105000000121098/file/332000000044009/download
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
特定のファイルの詳細の取得
説明
早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。
このAPIを使用すると、File Store内のフォルダにある特定のファイルの詳細を取得できます。フォルダとファイルはそれぞれの一意のIDで参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/folder/{folder_id}/file/{file_id}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.files.READ
レスポンス詳細
レスポンスには、file_name、file_size、ファイルの作成者および最終更新者の詳細を含む、特定のファイルのメタデータと詳細が返されます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/folder/105000000121098/file/332000000044009
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status":"success",
"data":{
"id": 332000000044009,
"file_location":null,
"file_name":"Sales2019.csv",
"file_size":264328,
"created_by":{
"zuid":1019540152,
"is_confirmed":true,
"email_id":"emma@zylker.com",
"first_name":"Amelia",
"last_name":"Burrows",
"user_type": "Admin",
"user_id":671930111
},
"created_time":"Apr 09, 2020 01:10 AM",
"modified_by":{
"zuid":1019540009,
"is_confirmed":true,
"email_id":"p.boyle@zylker.com",
"first_name":"Patricia",
"last_name":"Boyle",
"user_type": "Admin",
"user_id":671930989
},
"modified_time":"Mar 01, 2020 06:18 PM",
"project_details":{
"project_name":"ShipmentTracking",
"id":4000000006007,
"project_type": "Live"
},
"folder_details":105000000121098
}
}
複数ファイルの詳細の取得
説明
早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。
このAPIを使用すると、File Store内の特定のフォルダにある複数のファイルの詳細を取得できます。フォルダは一意のフォルダIDで参照されます。
このAPIリクエストは、1回の呼び出しでフォルダ内の最大200ファイルの詳細を取得できます。したがって、フォルダに300ファイルがある場合、2回目のAPI呼び出しを実行して201番目から300番目のファイルの詳細を取得できます。これは、以下に示すようにリクエストのクエリパラメータでstartとendの値を指定することで行えます。クエリパラメータが指定されていない場合、デフォルトで最初の200ファイルが取得されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/folder/{folder_id}/file?start={start_index}&end={number_of_files}
現在のバンドルの開始値
取得するファイル数。許可される最大値は200です。
たとえば、201番目から300番目のファイルの詳細を取得するには、startを「201」、endを「100」と指定します。
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.files.READ
レスポンス詳細
レスポンスには、file_name、file_size、ファイルの作成者および最終更新者の詳細を含む、返されたすべてのファイルのメタデータと詳細が返されます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/folder/3376000000301993/file?start=201&end=2
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status":"success",
"data": [
{
"id":3376000000301234,
"file_location":null,
"file_name":"AuditLog.csv",
"file_size":1621,
"created_by": {
"zuid":10016873924,
"is_confirmed":true,
"email_id":"emma@zylker.com",
"first_name":"Amelia",
"last_name":"Burrows",
"user_type": "Admin",
"user_id":671930400
},
"created_time":"Apr 27, 2020 07:37 PM",
"modified_by": {
"zuid":10016873924,
"is_confirmed":true,
"email_id":"p.boyle@zylker.com",
"first_name":"Patricia",
"last_name":"Boyle",
"user_type": "Admin",
"user_id":671938657
},
"modified_time":"Apr 27, 2020 07:37 PM",
"project_details": {
"project_name":"ShipmentTracking",
"id": 4000000006007,
"project_type": "Live"
},
"folder_details":3376000000301993
},
{
"id":3376000000300987,
"file_location":null,
"file_name":"ZohoCatalyst-Pricing.pdf",
"file_size":346466,
"created_by": {
"zuid":10016873924,
"is_confirmed":true,
"email_id":"emma@zylker.com",
"first_name":"Ameila",
"last_name":"Burrows",
"user_type": "Admin",
"user_id":671930400
},
"created_time":"Apr 27, 2020 07:36 PM",
"modified_by": {
"zuid":10016873924,
"is_confirmed":true,
"email_id":"p.boyle@zylker.com",
"first_name":"Patricia",
"last_name":"Boyle",
"user_type": "Admin",
"user_id":671938657
},
"modified_time":"Apr 27, 2020 07:36 PM",
"project_details": {
"project_name":"ShipmentTracking",
"id":3376000000168765,
"project_type": "Live"
},
"folder_details":3376000000301993
}
]
}
ファイルの削除
早期アクセスモードでStratusコンポーネントを使用するには、support@zohocatalyst.comまでメールでお問い合わせください。
説明
このAPIは、フォルダIDとファイルIDを参照して、File Store内のフォルダから既存のファイルを削除するために使用します。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/folder/{folder_id}/file/{file_id}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.files.DELETE
レスポンス詳細
レスポンスには、file_name、file_size、ファイルの作成者および最終更新者の詳細を含む、削除されたファイルのメタデータと詳細が返されます。
curl -X DELETE
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/folder/105000000121098/file/4000000044001
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
{
"status": "success",
"data": {
"id": 4000000044001,
"file_location": null,
"file_name": "bookingsSept2019.pdf",
"file_size": 458186,
"created_by": {
"zuid": 671787990,
"is_confirmed":true,
"user_type": "Admin",
"user_id": 671930400,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows"
},
"created_time": "2019-03-14T12:35:18+05:30",
"modified_by": {
"zuid": 671787990,
"is_confirmed":true,
"user_type": "Admin",
"user_id": 671930400,
"email_id": "emma@zylker.com",
"first_name": "Amelia",
"last_name": "Burrows"
},
"modified_time": "2019-03-14T12:35:18+05:30",
"project_details": {
"id": 4000000006007,
"project_name": "ShipmentTracking",
"project_type": "Live"
},
"folder_details": 105000000121098
}
}
Cache
Catalyst Cacheは、Catalystアプリケーションで頻繁にアクセスされるデータを保存できる、小容量のインメモリストレージコンポーネントです。
Catalyst Cacheはセグメントと呼ばれるパーティション（キャッシュ単位）に分割されています。各セグメントはキー・バリューのペアの形式でキャッシュアイテムを保存します。
キャッシュセグメントへのキー・バリューペアの挿入
説明
このAPIを使用すると、キャッシュセグメントにキー・バリューのペアをキャッシュアイテムとして挿入できます。セグメントは一意のIDで参照されます。キーは属性を表し、バリューはキャッシュアイテムのデータです。
キャッシュアイテムの有効期限を任意で指定することもできます。キャッシュアイテムのデフォルトおよび最大有効期間は2日間です。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/segment/{segment_id}/cache
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cache.CREATE
リクエストJSONプロパティ
Max Size: 50 characters
Max Size: 16000 characters
Max Size: 48
レスポンス詳細
レスポンスには、cache_name、cache_value、expires_inなどのキャッシュアイテムの詳細と、挿入先のセグメントの詳細が返されます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/segment/3376000000425030/cache
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d ‘{
“cache_name”:“counter”,
“cache_value”:“125”,
“expiry_in_hours”:24
}’
{
"status": "success",
"data": {
"cache_name": "counter",
"cache_value": "125",
"project_details": {
"id": 4000000006007,
"project_name": "ShipmentTracking",
"project_type": "Live"
},
"segment_details": {
"id": 3376000000425030,
"segment_name": "CustomerLocation"
},
"expires_in": "Mar 28, 2019 02:03 AM",
"expiry_in_hours": 24,
"ttl_in_milliseconds": 86400000
}
}
キャッシュキーの値の取得
説明
このAPIを使用すると、キャッシュ内のセグメントからキャッシュアイテムの値を取得できます。セグメントは一意のセグメントIDで参照され、リクエストにはキャッシュアイテムのキーを渡す必要があります。
このAPIを使用すると、キャッシュセグメントにキー・バリューのペアをキャッシュアイテムとして挿入できます。セグメントは一意のIDで参照されます。キーは属性を表し、バリューはキャッシュアイテムのデータです。
キャッシュアイテムの有効期限を任意で指定することもできます。キャッシュアイテムのデフォルトおよび最大有効期間は2日間です。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/segment/{segment_id}/cache?cacheKey={cache_key}
クエリパラメーター
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cache.READ
レスポンス詳細
レスポンスには、cache_name、cache_value、expires_inなどのキャッシュアイテムの詳細と、セグメントの詳細が返されます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/segment/31000000006023/cache?cacheKey=counter
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"cache_name": "counter",
"cache_value": "1344",
"project_details": {
"id": 4000000006007,
"project_name": "ShipmentTracking",
"project_type": "Live"
},
"segment_details": {
"id": 31000000006023,
"segment_name": "MailCounters"
},
"expires_in": "2019-03-13T18:36:02+05:30",
"expiry_in_hours": 3,
"ttl_in_milliseconds": 81187000
}
}
キー・バリューペアの更新
説明
このAPIを使用すると、キャッシュセグメント内のキー・バリューペアを更新できます。セグメントは一意のIDで参照されます。キーは属性を表し、バリューはキャッシュアイテムのデータです。
キャッシュアイテムのキー、バリュー、または有効期限を更新できます。キャッシュアイテムのデフォルトおよび最大有効期間は2日間です。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/segment/{segment_id}/cache
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cache.CREATE
リクエストJSONプロパティ
Max Size: 50 characters
Max Size: 16000 characters
Max Size: 48
レスポンス詳細
レスポンスには、cache_name、cache_value、expires_inなどの更新されたキャッシュアイテムの詳細と、セグメントの詳細が返されます。
curl -X PUT
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/segment/3376000000425030/cache
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type:application/json”
-d ‘{
“cache_name”:“counter”,
“cache_value”:“1472”
}’
{
"status": "success",
"data": {
"cache_name": "counter",
"cache_value": "1472",
"project_details": {
"id": 4000000006007,
"project_name": "ShipmentTracking",
"project_type": "Live"
},
"segment_details": {
"id": 3376000000425030,
"segment_name": "CounterValues"
},
"expires_in": "Mar 28, 2019 02:03 AM",
"expiry_in_hours": 7,
"ttl_in_milliseconds": 172800000
}
}
ZCQL
ZCQLは、Catalyst Data Store内のテーブルに対してデータの取得、挿入、更新、および削除操作を実行できるCatalyst独自のクエリ言語です。
ZCQLを使用してさまざまなDMLクエリを実行し、データの取得や操作を行うことができます。また、SQL Join句、GroupByおよびOrderByステートメント、組み込みSQL関数などのさまざまな句やステートメントを使用できます。
ZCQLクエリの実行
説明
このAPIは、ZCQLクエリを実行してData Store内のテーブルからデータを取得、挿入、更新、または削除できるようにします。サンプルリクエストに示すように、JSONリクエストでZCQLクエリを渡してこのAPIを実行できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/query
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.zcql.CREATE
リクエストJSONプロパティ
レスポンス詳細
データ取得操作: APIは、クエリ実行の結果として取得されたレコードをレスポンスとして返します。
データ挿入および更新操作: APIは、クエリを通じて挿入または更新されたレコードをレスポンスとして返します。
データ削除操作: APIは削除された行数を返します。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/query
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
-d ‘{
“query”:“SELECT EmpID, EmpName, Department, Address from EmpDetails ORDER BY EmpID ASC LIMIT 1000,5”
}’
{
"status": "success",
"data": [
{
"EmpDetails": {
"CREATORID": "3376000000002003",
"MODIFIEDTIME": "2023-06-05 15:09:33:881",
"CREATEDTIME": "2023-06-05 15:09:33:881",
"ROWID": "3376000001924975",
"EmpID": "1001",
"EmpName": "Allison Powell",
"Department":"Marketing",
"Address": "13, Winter Avenue, Philadelphia, PY"
}
},
{
"EmpDetails": {
"CREATORID": "3376000000002003",
"MODIFIEDTIME": "2023-06-05 15:09:33:881",
"CREATEDTIME": "2023-06-05 15:09:33:881",
"ROWID": "3376000001927682",
"EmpID": "1002",
"EmpName": "James Cortez",
"Department":"HR",
"Address": "25, Blossom Street, Austin, TX"
}
},
{
"EmpDetails": {
"CREATORID": "3376000000002003",
"MODIFIEDTIME": "2023-06-02 21:04:11:111",
"CREATEDTIME": "2023-06-02 15:05:21:001",
"ROWID": "3376000001224112",
"EmpID": "1003",
"EmpName": "Han Chan",
"Department":"Sales",
"Address": "112, St.Patrick's Road, Louisville, KY"
}
},
{
"EmpDetails": {
"CREATORID": "337600000003111",
"MODIFIEDTIME": "2023-06-02 21:04:11:111",
"CREATEDTIME": "2023-06-02 15:05:21:001",
"ROWID": "3376000001242012",
"EmpID": "1004",
"EmpName": "Rubella Miguel",
"Department":"Accounts",
"Address": "333, Marine Bay, Salt Lake City, UT"
}
},
{
"EmpDetails": {
"CREATORID": "3376000000115254",
"MODIFIEDTIME": "2023-04-12 21:04:10:521",
"CREATEDTIME": "2023-06-11 15:05:02:541",
"ROWID": "3376000001241341",
"EmpID": "1005",
"EmpName": "Ronwick Boseman",
"Department":"Support",
"Address": "61, Gringott's Avenue, Herfordshire, CO"
}
}
]
}
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/query
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57
-H “Content-Type: application/json”
-d ‘{
“query”:“INSERT INTO EmpDetails VALUES (1007,‘Randy Marsh’,‘Sales’,‘42, Tenth Street, Jacksonville, FL’, ‘14 MAR 2017’)”
}’
{
"status": "success",
"data": [
{
"EmpDetails": {
"CREATORID": "3813000000002003",
"EmpID": "1007",
"EmpName": "Randy Marsh",
"Department":"Sales",
"Address": "42, Tenth Street, Jacksonville, FL",
"DOJ": "14 MAR 2017",
"MODIFIEDTIME": "2021-08-04 09:10:14:752",
"CREATEDTIME": "2021-08-04 09:10:14:752",
"ROWID": "3813000000214001"
}
}
]
}
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/query
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57
-H “Content-Type: application/json”
-d ‘{
“query”:“UPDATE EmpDetails SET Department=‘Operations’ WHERE EmpID=1007”
}’
{
"status": "success",
"data": [
{
"EmpDetails": {
"CREATORID": "3813000000002003",
"EmpID": "1007",
"EmpName": "Randy Marsh",
"Department":"Operations",
"Address": "42, Tenth Street, Jacksonville, FL",
"DOJ": "14 MAR 2017",
"MODIFIEDTIME": "2021-08-04 09:11:54:318",
"CREATEDTIME": "2021-08-04 09:10:14:752",
"ROWID": "3813000000214001"
}
}
]
}
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/query
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57
-H “Content-Type: application/json”
-d ‘{
“query”:“DELETE FROM EmpDetails WHERE EmpID=1007”
}’
{
"status": "success",
"data": [
{
"EmpDetails": {
"DELETED_ROWS_COUNT": 1
}
}
]
}
キー・バリューペアの削除
説明
このAPIを使用すると、指定したキャッシュセグメントから既存のキー・バリューペアを削除できます。セグメントは一意のIDで参照されます。キーは属性を表し、バリューはキャッシュアイテムのデータです。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/segment/{segment_id}/cache?cacheKey={cache_key}
クエリパラメーター
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cache.DELETE
レスポンス詳細
レスポンスには、cache_name、cache_value、expires_inを含む、削除されたキャッシュアイテムの詳細が返されます。キャッシュエントリは削除されたため、cache_valueと有効期限フィールドはnullとして返されます。
curl -X DELETE
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/segment/31000000006023/cache?cacheKey=counter
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
{
"status": "success",
"data": {
"cache_name": "NEW",
"cache_value": null,
"project_details": {
"project_name": "ShipmentTracking",
"id": 4000000006007,
"project_type": "Live"
},
"segment_details": {
"segment_name": "MailCounters",
"id": 31000000006023
},
"expires_in": null,
"expiry_in_hours": null,
"ttl_in_milliseconds": null
}
}
Search
Catalyst Searchは、Catalyst Data Storeのテーブルのインデックス付きカラムでのデータ検索を可能にします。アプリケーションにSearchを統合すると、エンドユーザーは単一の検索クエリでData Store内の大量のデータを強力に検索できるようになります。
検索クエリの実行
説明
このAPIは、Data Store内のすべてのテーブルのインデックス付きカラムで検索操作を実行できるようにします。リクエストJSONで検索パラメータを渡すことができます。検索クエリに一致するレコードがレスポンスとして取得されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/search
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.search.READ
リクエストJSONプロパティ
検索するキーワードを含む検索パターン
複数のキーワードをカンマで区切って指定できます。
テーブル内で検索するインデックス付きカラム
以下の形式で指定する必要があります:
{“table_name_1”: [“column_name_1”, “column_name_2”, “column_name_3”..], “table_name_2”: [“column_name_1”, “column_name_2”, “column_name_3”..]..}
検索結果に基づいて選択・表示するカラム
以下の形式で指定する必要があります:
{“table_name_1”: [“column_name_1”, “column_name_2”, “column_name_3”..], “table_name_2”: [“column_name_1”, “column_name_2”, “column_name_3”..]..}
検索結果で取得したレコードを昇順または降順でソートします
許可される値: ASC、DESC
検索を開始する行の開始インデックス
デフォルト値: 0
検索を終了する行のオフセット値
デフォルト値: 500
レスポンス詳細
レスポンスは、検索クエリに一致するレコードを返します。CREATORIDやCREATEDTIMEなどのメタデータを含む行の詳細、およびカラムのキー名と値が返されます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/search
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
-d ‘{
“search” : “Mary”,
“search_table_columns” : {
“CustomerInfo”: [
“CustomerName”,
“TrainerName”
]
},
“start”:1000,
“end”:200
}’
{
"status": "success",
"data": {
"CustomerInfo": [
{
"CREATORID": "56000000002003",
"MODIFIEDTIME": "2019-02-08 13:13:44",
"CustomerName": "Mary Johnson",
"TrainerName": "Helena Stewart",
"CustomerID":"PL1213234",
"CREATEDTIME": "2019-02-08 13:13:44"
},
{
"CREATORID": "56000000002003",
"MODIFIEDTIME": "2019-02-08 20:11:10",
"CustomerName": "Mary Palmer",
"TrainerName": "Ronald Wazlib",
"CustomerID":"SY091834",
"CREATEDTIME": "2019-02-08 20:11:10"
},
{
"CREATORID": "56000000002003",
"MODIFIEDTIME": "2019-11-09 10:00:12",
"CustomerName": "Herbert Spielberg",
"TrainerName": "Mary Amber Rogers",
"CustomerID":"AL987627",
"CREATEDTIME": "2019-11-08 00:12:40"
}
]
}
}
Catalyst Mailを使用すると、Catalystアプリケーションからエンドユーザーにメールを送信するために使用するビジネスのメールアドレスを追加できます。パブリックドメインまたは組織独自のドメインのメールアドレスを設定できます。また、Catalyst組み込みのメールクライアントの代わりに、任意の外部メールクライアントを使用し、そのSMTP設定をCatalystで構成することもできます。これらの設定はコンソールから実行できます。
メールの送信
説明
このAPIを使用すると、Catalystアプリケーションから検証済みのメールアドレスを使用して、指定した受信者にメールを送信できます。
Catalystでは、1回のメール送信操作で、複数のメールアドレスを受信者、CC、BCC、および返信先として設定できます。また、メールにファイルを添付することもできます。1回のメール送信操作でのメール受信者とファイル添付のサポートされる上限は以下のとおりです：
- Toアドレス: 10
- CC: 10
- BCC: 5
- 返信先: 5
- ファイル添付数: 5
- ファイル添付サイズ: 15 MB（1つのファイルまたは最大5ファイルの複数ファイル）
送信者と受信者のメールアドレス、件名、内容、およびメールの添付ファイルをAPIリクエストのform-dataとして渡す必要があります。form-dataとして渡すキーとサンプル値は、以下の「Form-Dataプロパティ」セクションで説明されています。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/email/send
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.email.CREATE
Form-Dataプロパティ
レスポンス詳細
レスポンスには、送信されたメールのステータス、プロジェクト詳細、from_email、to_email、およびcontentなど、送信されたメールの詳細が返されます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/email/send
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW” \
-F from_email=emma@zylker.com \
-F to_email=vanessa.hyde@zoho.com,r.owens@zoho.com,chang.lee@zoho.com
-F cc=p.boyle@zylker.com,robert.plant@zylker.com
-F bcc=ham.gunn@zylker.com,rover.jenkins@zylker.com
-F reply_to=peter.d@zoho.com,arnold.h@zoho.com
-F attachments=kycform.pdf
-F subject=“Greetings from Zylker Corp!”
-F content="
Hello,
We’re glad to welcome you at Zylker Corp. To begin your journey with us, please download the attached KYC form and fill in your details. You can send us the completed form to this same email address. We cannot wait to get started!
Cheers!
Team Zylker
"
-F html_mode=true
-F display_name=“Amelia Burrows” \
{
"status": "success",
"data": {
"isAsync": false,
"project_details": {
"project_name": "Onboarding",
"id": 2648000000235047,
"project_type": "Live"
},
"display_name": "Amelia Burrows",
"from_email": "emma@zylker.com",
"to_email": [
"vanessa.hyde@zoho.com",
"r.owens@zoho.com",
"chang.lee@zoho.com"
],
"cc": [
"p.boyle@zylker.com",
"robert.plant@zylker.com"
],
"bcc": [
"ham.gunn@zylker.com",
"rover.jenkins@zylker.com"
],
"html_mode": true,
"subject": "Greetings from Zylker Corp!",
"content": "<p>Hello,</p><p>We're glad to welcome you at Zylker Corp. To begin your journey with us, please download thattached KYC form and fill in your details. You can send us the completed form to this same email address. We cannowait to get started!<p>Cheers!</p><p>Team Zylker </p>",
"reply_to": [
"peter.d@zoho.com",
"arnold.h@zoho.com"
]
}
}
プッシュ通知
プッシュ通知は、アプリケーションがユーザーのデバイスでアクティブに実行されていない場合でも、アプリケーションプロバイダーがアプリケーションのユーザーに送信できるリモート通知です。Catalystは、CatalystのWebおよびiOSアプリケーションにプッシュ通知を簡単に統合する方法を提供します。
Webプッシュ通知の送信
説明
このAPIは、プッシュ通知を有効にした後に、Webアプリケーションのユーザーにテスト用のテキストプッシュ通知を送信するために使用されます。このWeb SDKヘルプページに記載されているWebスクリプトを実装することで、プッシュ通知を有効にし、プッシュ通知を受信するためのクライアントデバイスを登録することもできます。その後、このAPIを使用してプッシュ通知を送信できます。
プッシュ通知メッセージと受信者のリストを、サンプルリクエストに示すようにAPIリクエストで渡すことができます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/project-user/notify
リクエストヘッダー
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.notifications.web.CUSTOM
リクエストJSONプロパティ
レスポンス詳細
レスポンスは、送信された通知のステータスをsuccessまたはfailedとして返します。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/3000000002001/project-user/notify
-H “Content-Type: application/json”
-d ‘{
“recipients”:[“rhonda.wilkins@zylker.com”,“isabella.j@zylker.com”,“harry.sandman@zylker.com”],
“message”:“Attention, new employees! Update your profile information in Zylker team app”
}’
{
"status": "success",
"data": true
}
iOSプッシュ通知の送信
説明
このAPIは、Appleにアプリを登録し、Catalystプッシュ通知に登録し、デバイスを登録した後に、iOSアプリからユーザーデバイスにテスト用のテキストプッシュ通知を送信するために使用されます。デバイスにプッシュ通知を送信する前に、プッシュ通知 - iOSヘルプセクションで説明されている6つのステップを実装する必要があります。
Catalystでは、それぞれの環境の設定ファイルからappID値を渡すことで、登録済みのテストデバイスまたは本番デバイスにプッシュ通知を送信できます。テストデバイスへのプッシュ通知送信と本番デバイスへのプッシュ通知送信では、リクエストURLが異なります。これらはリクエスト詳細セクションに記載されています。
プッシュ通知メッセージと送信先の受信者を、サンプルリクエストに示すようにAPIリクエストで他の詳細とともに渡すことができます。
リクエスト詳細
テスト通知を送信するリクエストURL
{api-domain}/baas/v1/project/{project_id}/push-notification/{app_id}/test
本番通知を送信するリクエストURL
{api-domain}/baas/v1/project/{project_id}/push-notification/{app_id}/project-user/notify
リクエストヘッダー
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.notifications.mobile.CUSTOM
リクエストJSONプロパティ
プッシュ通知のコンテンツとメタデータの詳細を含むJSON
最大サイズ: 100文字
最大サイズ: 100文字
レスポンス詳細
レスポンスは、送信された通知のステータスをsuccessまたはfailedとして返し、messageやexpiry_timeを含む渡されたデータを返します。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/204000000024010/push-notification/204000000036005/project-user/notify
-H “Content-Type: application/json”
-d ‘{
“recipients”:“amanda.boyle@zylker.com”,
“push_details”:{
“message”:“Welcome to Zylker App!”,
“badge_count”:10,
“expiry_time”:12,
“additional_info”:{
“sample_key” : “sample_value”
}
}
}’
{
"status": "success",
"data": {
"recipients": "amanda.boyle@zylker.com",
"push_details": {
"message": "Welcome to Zylker App!",
"additional_info": {
"sample_key": "sample_value"
},
"badge_count": 10,
"reference_id": null,
"expiry_time": 12
}
}
}
Send Push Notifications- Node.js SDK
Send Push Notifications- Python SDK
Register Device for Push Notifications- iOS SDK
Register Device for Push Notifications- Android SDK
Register Device for Push Notifications- Flutter SDK
Register Device for Push Notifications- Web SDK
Androidプッシュ通知の送信
説明
このAPIは、Firebase Cloud Messagingにアプリを登録し、Catalystプッシュ通知に登録し、デバイスを登録した後に、Androidアプリからユーザーデバイスにテスト用のテキストプッシュ通知を送信するために使用されます。プッシュ通知を送信する前に、プッシュ通知 - Androidヘルプセクションで説明されている4つのステップを実装する必要があります。
Catalystでは、それぞれの環境の設定ファイルからappID値を渡すことで、登録済みのテストデバイスまたは本番デバイスにプッシュ通知を送信できます。テストデバイスへのプッシュ通知送信と本番デバイスへのプッシュ通知送信では、リクエストURLが異なります。これらはリクエスト詳細セクションに記載されています。
プッシュ通知メッセージと送信先の受信者を、サンプルリクエストに示すようにAPIリクエストで他の詳細とともに渡すことができます。
リクエスト詳細
テスト通知を送信するリクエストURL
{api-domain}/baas/v1/project/{project_id}/push-notification/{app_id}/test
本番通知を送信するリクエストURL
{api-domain}/baas/v1/project/{project_id}/push-notification/{app_id}/project-user/notify
クエリパラメータ
isAndroid: true
リクエストヘッダー
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.notifications.mobile.CUSTOM
リクエストJSONプロパティ
プッシュ通知のコンテンツとメタデータの詳細を含むJSON
最大サイズ: 100文字
最大サイズ: 100文字
レスポンス詳細
レスポンスは、送信された通知のステータスをsuccessまたはfailedとして返し、messageやexpiry_timeを含む渡されたデータを返します。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/204000000024010/push-notification/204000000036005/project-user/notify?isAndroid=true
-H “Content-Type: application/json”
-d ‘{
“recipients”:“amanda.boyle@zylker.com”,
“push_details”:{
“message”:“Welcome to Zylker App!”,
“badge_count”:10,
“expiry_time”:12,
“additional_info”:{
“sample_key” : “sample_value”
}
}
}’
{
"status": "success",
"data": {
"recipients": "amanda.boyle@zylker.com",
"push_details": {
"message": "Welcome to Zylker App!",
"additional_info": {
"sample_key": "sample_value"
},
"badge_count": 10,
"reference_id": null,
"expiry_time": 12
}
}
}
Send Push Notifications- Node.js SDK
Send Push Notifications- Python SDK
Register Device for Push Notifications- iOS SDK
Register Device for Push Notifications- Android SDK
Register Device for Push Notifications- Flutter SDK
Register Device for Push Notifications- Web SDK
Optical Character Recognition
Zia Optical Character Recognitionは、画像やデジタルドキュメント内のテキスト文字を電子的に検出し、機械エンコードされたテキストに変換します。Zia OCRは10の主要言語のテキストを認識できます。
OCRの実行
説明
このAPIは、画像やドキュメント内のテキスト文字を検出し、認識されたテキストをJSONレスポンスとして返すために使用されます。レスポンスには、検出の精度を定義する信頼度スコアも含まれます。
サンプルリクエストに示すように、APIリクエストで画像またはドキュメントファイルのパスを指定する必要があります。オプションで、より迅速な処理のためにテキストに含まれる言語を指定できます。OCRは、以下の表に記載されている9つの国際言語と10のインド言語をサポートしています。言語が指定されていない場合、言語は自動的に検出され、テキストが処理されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/ml/ocr
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.mlkit.READ
リクエストJSONプロパティ
処理する入力ファイル。ローカルシステム内のパスを指定する必要があります。
許可される形式: .webp, .jpeg, .png, .bmp, .tiff, .pdf
ファイルサイズ制限: 20 MB
OCRがサポートする国際言語
| 言語 | 言語コード |
|---|---|
| アラビア語 | ara |
| 中国語 | chi_sim |
| フランス語 | fra |
| イタリア語 | ita |
| 日本語 | jpn |
| ポルトガル語 | por |
| ルーマニア語 | ron |
| スペイン語 | spa |
OCRがサポートするインド言語
| 言語 | 言語コード |
|---|---|
| 英語 | eng |
| ヒンディー語 | hin |
| ベンガル語 | ben |
| マラーティー語 | mar |
| テルグ語 | tel |
| タミル語 | tam |
| グジャラート語 | guj |
| ウルドゥー語 | urd |
| カンナダ語 | kan |
| マラヤーラム語 | mal |
| サンスクリット語 | san |
レスポンス詳細
レスポンスは、OCR処理のdataを返します。これには、入力から認識されたテキストがtextキーに、認識の信頼度スコアがconfidenceキーに含まれます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/ocr
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F “image=/Desktop/HelplineCard.webp”
-F “language=eng,spa”
{
"status":"success",
"data": {
"confidence":79.71514892578125,
"text":"Whenever you\nneed to talk,\nwe're open\n\n[—] text eseses\n[J] KidsHelpPhone.ca\n\n(@, call 1—800—663—6868 Kids Help Phone ©"
}
}
AutoML
Zia AutoMLを使用すると、モデルをトレーニングしてトレーニングデータのセットを分析し、そのデータのサブセットの結果を予測できます。二値分類、多クラス分類、および回帰モデルを構築・トレーニングし、洞察に富んだ評価レポートを取得できます。
AutoMLの実行
説明
このAPIは、AutoMLモデルの予測入力をキーバリューペアとして渡すために使用されます。以下に説明するように、リクエストでJSON形式でデータを渡す必要があります。
注意:
- AutoMLモデルは事前に作成されている必要があります。コンソールからモデルを作成および構成できます。
- コンソールからモデルを構成する際に、ターゲット列（データセット内で値を予測する必要がある列）を指定できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/ml/automl/model/{model_id}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
content-type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.mlkit.READ
リクエストJSONフォーマット
列名と対応する列の値を以下のようなJSON形式で送信する必要があります：
{
“column1_name”: “column1_value”,
“column2_name”: “column2_value”,
“column3_name”: “column3_value”
}
ここでcolumn_nameはターゲットの予測に必要なデータセット内のキーであり、column_valueは対応する列に提供するデータです。
注意:
-
日付型に数値を入力するなど、列のデータ型と一致しない形式で値を入力した場合、値は解析されません。正しい形式でデータを提供してください。
-
予測をテストする際に、少なくとも1つの有効な列の値を提供する必要があります。
-
入力フィールドに値を入力しない場合、Ziaによって自動的にデフォルト値が列に入力されます。ただし、これは予測の精度に影響します。
レスポンス詳細
レスポンスはOCR処理のdataを返します。これには、textキーに入力から認識されたテキストと、confidenceキーに認識の信頼度スコアが含まれます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/automl/model/105000000124001
-H “Authorization: Zoho-oauthtoken 1000.8cb99d**********************9be93.9b8***********************f”
-H “Content-Type: application/json”
-d ‘{
“country”: “Armenia”,
“year”: “2016”,
“sex”: “female”,
“age”: “25-34”,
“population”: “277452”,
“GDP_for_year”: “10,546,135,160”
}’
{
"status":"success",
"data":{
"regression_result":3.41
}
}
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/automl/model/105000000124001
-H “Authorization: Zoho-oauthtoken 1000.8cb99d********************9be93.9b8********************f”
-H “Content-Type: application/json”
-d ‘{
“year_film”: “2019”,
“year_award”: “2020”,
“ceremony”: “77”,
“category”: “Best Director - Motion Picture”,
“nominee”: “Todd Phillips”,
“film”: “Joker”
}’
{
"status":"success",
"data":{
"classification_result": {
"True":20,
"False":80
}
}
}
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/automl/model/105000000124001
-H “Authorization: Zoho-oauthtoken 1000.8cb99d******************9be93.9b8******************f”
-H “Content-Type: application/json”
-d ‘{
“Transaction_date”: “1/2/09 4:53”,
“Product”: “RAM”,
“Price”: “120”,
“City”: “Parkville”,
“State”: “MO”,
“Country”: “United States”,
“Account_Created”: “12/4/08 4:42”,
“Last_Login”: “1/2/09 7:49”
}’
{
"status":"success",
"data":{
"classification_result": {
"Amex":10,
"Diner":20,
"Mastercard": 30,
"Visa":40
}
}
}
Face Analytics
Zia Face Analyticsは、画像内の顔検出を実行し、顔の特徴を分析して、検出された顔の性別、年齢、感情などの情報を提供します。
Face Analyticsは、各属性予測の信頼度レベルも提供し、情報に基づいた意思決定を可能にします。画像内で最大10個の顔を検出でき、検出された各顔の属性予測を提供します。
Face Analyticsの実行
説明
このAPIを使用して、画像ファイル内の顔検出と分析を実行し、サンプルリクエストに示すようにAPIリクエストでそのパスを指定できます。
オプションで、顔内で検出される顔のランドマーク数を決定する分析モードを指定できます。また、感情、年齢、性別など、予測する属性の有効・無効を設定することもできます。
このAPIは、Face Analytics予測の入力を渡すために使用されます。以下に説明するように、リクエストで入力画像ファイルとJSON形式のデータを渡す必要があります。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/ml/faceanalytics
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.mlkit.READ
リクエストJSONプロパティ
処理する入力ファイル。ローカルシステム内のパスを指定する必要があります。
許可される形式: .webp, .jpeg, .png
ファイルサイズ制限: 10 MB
顔内で検出される顔のランドマーク数を示します
許可される値: basic, moderate, advanced
デフォルト値: advanced
- basic: 顔の境界のみを検出する0ポイントランドマーク検出器
- moderate: 以下を検出する5ポイントランドマーク検出器 - 目: 両目の中心、鼻: 鼻先、唇: 両唇の中心
- advanced: 以下を検出する68ポイントランドマーク検出器 - 顎のライン: 顔の境界、眉: 左右の眉、目: 左右の目、鼻筋、鼻孔ライン、上唇: 上端と下端、下唇: 上端と下端
許可される値:
false: 感情は検出されません
true: 感情が検出されます
デフォルト値: true
許可される値:
false: 年齢は検出されません
true: 年齢が検出されます
デフォルト値: true
許可される値:
false: 性別は検出されません
true: 性別が検出されます
デフォルト値: true
レスポンス詳細
レスポンスは、検出された顔の顔ランドマークの詳細、およびAPIリクエストで設定されたパラメータとモードに基づく感情、年齢、性別の予測をdataキーで返します。
顔ランドマーク検出の座標の全体的な確率、および感情、年齢、性別パラメータの予測の確率は、confidenceスコアとして返されます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/faceanalytics
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F “file=@attachment1.txt”
-d ‘{
“mode”: “basic”,
“emotion”: “true”,
“age”: “true”,
“gender”: “true”
}’
{
"status": "success",
"data": {
"faces": [
{
"confidence": 1.0,
"id": 0,
"co_ordinates": [
267,
39,
153,
227
],
"emotion": {
"prediction": "not_smiling",
"confidence": {
"smiling": "0.0",
"not_smiling": "1.0"
}
},
"age": {
"prediction": "3-9",
"confidence": {
"0-2": "0.005",
"10-19": "0.33",
"20-29": "0.12",
"3-9": "0.509",
"30-39": "0.032",
"40-49": "0.003",
"50-59": "0.0",
"60-69": "0.0",
">70": "0.0"
}
},
"gender": {
"prediction": "female",
"confidence": {
"female": "0.92",
"male": "0.08"
}
}
}
]
}
}
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/faceanalytics
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F “file=@attachment1.txt”
-d ‘{
“mode”: “moderate”,
“emotion”: “false”,
“age”: “false”,
“gender”: “true”
}’
{
"status": "success",
"data": {
"faces": [
{
"confidence": 1.0,
"id": 0,
"co_ordinates": [
267,
39,
153,
227
],
"landmarks": {
"left_eye": [337,135],
"right_eye": [400,130],
"nose": [
400,
165
],
"mouth_left": [
353,
217
],
"mouth_right": [
404,
211
]
},
"gender": {
"prediction": "female",
"confidence": {
"female": "0.92",
"male": "0.08"
}
}
}
]
}
}
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/faceanalytics
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F “file=@attachment1.txt”
-d ‘{
“mode”: “advanced”,
“emotion”: “true”,
“age”: “false”,
“gender”: “false”
}’
{
"status": "success",
"data": {
"faces": [
{
"co_ordinates" : [ 185, 96, 275, 18],
"confidence" : 0.99
"landmarks" : {
'mouth': [
[259, 440],
[287, 423],
[312, 413],
[325, 418],
[338, 414],
[354, 424],
[368, 442],
[355, 461],
[339, 470],
[325, 472],
[310, 470],
[285, 460],
[269, 440],
[311, 435],
[324, 436],
[338, 436],
[359, 442],
[339, 440],
[326, 441],
[312, 439]
],
'right_eyebrow': [
[189, 245],
[216, 230],
[244, 227],
[273, 234],
[301, 248]
],
'left_eyebrow': [
[356, 249],
[379, 238],
[401, 232],
[422, 235],
[436, 252]
],
'right_eye': [
[225, 288],
[245, 281],
[265, 282],
[280, 295],
[263, 297],
[244, 297]
],
'left_eye': [
[358, 299],
[376, 288],
[393, 290],
[408, 298],
[393, 305],
[376, 304]
],
'nose': [
[329, 287],
[331, 311],
[334, 336],
[337, 360],
[301, 385],
[315, 389],
[329, 392],
[341, 390],
[352, 385]
],
'jaw': [
[131, 283],
[136, 340],
[145, 393],
[158, 442],
[180, 484],
[212, 513],
[250, 530],
[287, 542],
[319, 545],
[347, 535],
[370, 512],
[393, 487],
[411, 456],
[423, 419],
[432, 381],
[437, 342],
[439, 303]
]
},
"emotion": {
"prediction": "not_smiling",
"confidence": {
"smiling": "0.0",
"not_smiling": "1.0"
}
}
}
]
}
}
Image Moderation
Zia Image Moderationは、画像内の不適切で安全でないコンテンツを検出・認識します。基準には、示唆的または露骨な際どいコンテンツ、ヌード、暴力、流血、武器や薬物の存在が含まれます。
Image Moderationの実行
説明
このAPIは、画像内の以下の不適切なコンテンツを認識し、レスポンスで返します: racy, weapon, nudity, gore, drug。レスポンスには、各基準の確率と信頼度スコア、および画像がsafe_to_useまたはunsafe_to_useであるかの予測も含まれます。
サンプルリクエストに示すように、APIリクエストで画像のパスを指定する必要があります。また、リクエストのモデレーションモードをオプションで設定することもできます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/ml/imagemoderation
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.mlkit.READ
リクエストJSONプロパティ
処理する入力ファイル。
許可される形式: .webp, .jpeg, .png, .txt
ファイルサイズ制限: 10 MB
モデレーションモードを示します
許可される値: basic, moderate, advanced
デフォルト値: advanced
- basic: ヌードのみを検出
- moderate: ヌードと際どいコンテンツを検出
- advanced: 説明に記載されたすべての基準を検出
レスポンス詳細
レスポンスには、APIリクエストで設定されたモードに基づいて検出されたパラメータの確率が含まれます。検出されたパラメータの集計に基づいて、画像が安全か安全でないかのpredictionと、予測のconfidenceスコアも含まれます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/imagemoderation
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F “file=@attachment1.txt”
-d ‘{
“mode”: “basic”
}’
{
"probability": {
"nudity": "1.0"
},
"confidence": 1,
"prediction": "unsafe_to_use"
}
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/imagemoderation
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F “file=@attachment1.txt”
-d ‘{
“mode”: “moderate”
}’
{
"probability": {
"racy": "0.0",
"nudity": "0.0"
},
"confidence": 0.9,
"prediction": "safe_to_use"
}
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/imagemoderation
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F “file=@attachment1.txt”
-d ‘{
“mode”: “advanced”
}’
{
"probability": {
"racy": "0.0",
"weapon": "1.0",
"nudity": "0.0",
"gore": "0.0",
"drug": "0.0"
},
"confidence": 1,
"prediction": "unsafe_to_use"
}
Object Recognition
Zia Object Recognitionは、画像ファイル内の個々のオブジェクトを検出、特定、認識します。画像から80種類の一般的なオブジェクトを識別できます。Ziaは、人、車、犬、椅子、信号機、ナイフ、傘、携帯電話など、80種類の特定のオブジェクトタイプを認識できます。
Object Recognitionの実行
説明
このAPIは、画像ファイル内の個々のオブジェクトを検出、特定、認識するために使用されます。レスポンスは、画像内の検出された各オブジェクトの座標、そのタイプ、および各認識の信頼度スコアを返します。
サンプルリクエストに示すように、APIリクエストで画像ファイルのパスを指定する必要があります。
リクエスト詳細
リクエストURL
http://api.catalyst.zoho.com/baas/v1/project/{project_id}/ml/detect-object
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.mlkit.READ
リクエストJSONプロパティ
オブジェクト認識のために処理される画像ファイル。ローカルシステム内のパスを指定する必要があります。
許可される形式: .webp, .jpeg, .png, .txt
ファイルサイズ制限: 10 MB
レスポンス詳細
レスポンスには、検出された各オブジェクトの詳細が含まれ、co_ordinates、object_type、および検出のconfidenceスコアが含まれます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/56000000405001/ml/detect-object
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F “file=@attachment1.txt” \
{
"status":"success",
"data":{
"objects":[
{
"co_ordinates":[
37,
94,
704,
434
],
"object_type":"dog",
"confidence":"98.92"
},
{
"co_ordinates":[
20,
67,
202,
120
],
"object_type":"umbrella",
"confidence":"97.05"
}
]
}
}
バーコードスキャナー
Ziaバーコードスキャナーを使用すると、最も一般的に使用されるリニアおよび2Dバーコード形式をスキャンし、エンコードされたデータをデコードできます。バーコードスキャナーは、Codabar、EAN-13、ITF、UPC-A、QRコードなどの形式を検出できます。
バーコードスキャナーの実行
説明
このAPIは、画像ファイルからバーコードにエンコードされたデータをデコードするために使用されます。サンプルリクエストに示すように、APIリクエストで画像ファイルへのパスを指定する必要があります。
オプションでバーコード形式を指定できます。指定しない場合、Catalystは自動的にデフォルト値allを処理します。JSONレスポンスはデコードされたデータを返します。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/ml/barcode
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.mlkit.READ
リクエストJSONプロパティ
スキャンするバーコードを含む入力ファイル。
許可される形式: .webp, .jpeg, .png, .txt
ファイルサイズ制限: 10 MB
解像度制限: 36000000ピクセル
画像内のバーコードの形式。形式コードは以下の表に記載されています。
ローカルシステム内のパスを指定する必要があります。
許可される形式: .webp, .jpeg, .png
ファイルサイズ制限: 10 MB
バーコード形式コード
| バーコード形式 | 形式コード |
|---|---|
| Code 39 | code39 |
| Code 128 | code128 |
| Code 93 | code93 |
| Ean 8 | ean8 |
| Ean 13 | ean13 |
| Codabar | codabar |
| ITF | itf |
| UPC-A | upca |
| UPC-E | upce |
| RSS | rss |
| QRコード | qrcode |
| Aztec | aztec |
| PDF417 | pdf417 |
| Data Matrix | datamatrix |
| 形式が不明な場合 または指定しない場合 |
all |
レスポンス詳細
レスポンスには、contentフィールドにバーコードで検出されたデータが含まれます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/ocr
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F “file=@attachment1.txt”
-d ‘{
“format”: “ITF”
}’
{
"status": "success",
"data": {
"content": "40156"
}
}
Identity Scanner
Identity Scannerは、Zia AIを活用したコンポーネントで、さまざまな身分証明書や公式文書をスキャン・処理することにより、個人や文書に対する安全な本人確認を実行できます。E-KYCとDocument Processingの2つの主要カテゴリに分かれた複数の機能を組み込んだ包括的なスイートです。
Facial Comparison
Facial Comparison（E-KYCとも呼ばれる）は、Identity Scannerの一部で、2つの異なる画像の2つの顔を比較して、同一人物であるかどうかを判定します。
Facial Comparisonの処理
説明
このAPIを使用すると、ソース画像とクエリ画像の間で顔比較を実行できます。サンプルリクエストに示すように、APIリクエストで両方の画像ファイルのパスを指定する必要があります。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/ml/facecomparison
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.mlkit.READ
リクエストJSONプロパティ
写真付き身分証明書または個人の写真。ローカルシステム内のパスを指定する必要があります。
許可される形式: .webp, .jpeg, .png
ファイルサイズ制限: 10 MB
写真付き身分証明書または個人の写真。ローカルシステム内のパスを指定する必要があります。
許可される形式: .webp, .jpeg, .png
ファイルサイズ制限: 10 MB
レスポンス詳細
レスポンスは、顔が一致した場合はtrue、一致しなかった場合はfalseとして比較結果を返します。
レスポンスには、0から1の範囲の信頼度スコアも含まれます。比較で50%（0.5）を超える信頼度スコアが得られた場合にのみ、結果はtrueに設定されます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/facecomparison
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F source_image=/Desktop/SourceImage.webp
-F query_image=/Desktop/QueryImage.webp
{
"status": "success",
"data": {
"confidence": 1.0,
"matched": "true"
}
}
Aadhaar
AADHAARモデルは、Identity ScannerのDocument Processing機能の一部で、インドのAadhaarカードを本人確認書類として処理できます。
注意:
-
Catalystは、アップロードされたファイルをシステムに保存しません。アップロードされた文書は一回限りの処理にのみ使用されます。MLモデルのトレーニング目的にも使用されません。Catalystコンポーネントは、適用されるすべてのデータ保護およびプライバシー法に完全に準拠しています。
-
Document Processingはインドのユーザーのみに関連し、IN DCでのみ利用可能です。この機能は、EU、AU、US、JP、SAまたはCAデータセンターからアクセスするユーザーには利用できません。他のDCからのインド国外のユーザーは、汎用OCRコンポーネントにアクセスしてテキストコンテンツを読み取り・処理できます。
Aadhaarの処理
説明
このAPIは、高度なOCR技術を使用してインドのAadhaarカードからデータフィールドを抽出します。JSONレスポンスは、Aadhaarカードから認識されたパラメータと、各認識の精度を示す信頼度スコアを返します。Aadhaarカードの表面と裏面の画像ファイルのパスを指定し、APIリクエストでモデルタイプをAADHAARとして指定する必要があります。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/ml/ocr
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.mlkit.READ
リクエストJSONプロパティ
処理するAadhaarカードの表面の画像。ローカルシステム内のパスを指定する必要があります。
許可される形式: .webp, .jpeg, .png, .bmp, .tiff
ファイルサイズ制限: 15 MB
処理するAadhaarカードの裏面の画像。ローカルシステム内のパスを指定する必要があります。
許可される形式: .webp, .jpeg, .png, .bmp, .tiff
ファイルサイズ制限: 15 MB
画像のモデルタイプ
渡す値: AADHAAR
識別する言語の言語コード。AADHAARモデルは、以下の表に記載されているインド言語をサポートしています。
AADHAARタイプでは、英語と該当する地域言語のみを渡す必要があります。例えば、タミル・ナードゥ州の場合は、リクエストでtamとengを渡す必要があります。
Aadhaarモデルタイプがサポートする言語
| 言語 | 言語コード |
|---|---|
| 英語 | eng |
| ヒンディー語 | hin |
| ベンガル語 | ben |
| マラーティー語 | mar |
| テルグ語 | tel |
| タミル語 | tam |
| グジャラート語 | guj |
| ウルドゥー語 | urd |
| カンナダ語 | kan |
| マラヤーラム語 | mal |
| サンスクリット語 | san |
レスポンス詳細
レスポンスには、カード保有者の名前、住所、性別、Aadhaarカード番号など、Aadhaarカードで認識されたパラメータがそれぞれのキーに割り当てられて含まれます。レスポンスには、認識された各値に対して0から1の範囲の信頼度スコアも表示されます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/ocr
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F aadhaar_front=/Desktop/Aadhaar1.webp
-F aadhaar_back=/Desktop/Aadhaar2.webp
-F model_type=AADHAAR
-F “language=eng,tam”
{
"status":"success",
"data":{
"text": "{\"address\":{\"prob\":0.5,\"value\":\"S/O Tony, Seer 40, S/O Julie, 40, Dewdrops Street, Cherry Hill Pondicherry, Pondicherry ureing4Gen, ureing4Gen 605008 \"},\"gender\":{\"prob\":\"0.9\",\"value\":\"male\"},\"dob\": {\"prob\":\"0.6\", \"value\":\"12/12/2012\"},\"name\":{\"prob\":\"0.8\", \"value\":\"Hari Krishnan\"},\"aadhaar\":{\"prob\":0.8,\"value\":\"1234 5678 0123\"}}"
}
}
PAN
PANモデルは、Identity ScannerのDocument Processing機能の一部で、インドのPANカードを本人確認書類として処理できます。
注意:
-
Catalystは、アップロードされたファイルをシステムに保存しません。アップロードされた文書は一回限りの処理にのみ使用されます。MLモデルのトレーニング目的にも使用されません。Catalystコンポーネントは、適用されるすべてのデータ保護およびプライバシー法に完全に準拠しています。
-
Document Processingはインドのユーザーのみに関連し、IN DCでのみ利用可能です。この機能は、EU、AU、US、JP、SAまたはCAデータセンターからアクセスするユーザーには利用できません。他のDCからのインド国外のユーザーは、汎用OCRコンポーネントにアクセスしてテキストコンテンツを読み取り・処理できます。
PANの処理
説明
このAPIは、高度なOCR技術を使用してPANカードからデータフィールドを抽出し、PANカードから認識されたパラメータをJSONレスポンスとして返します。APIリクエストで個人情報が記載されたPANカードの表面の画像ファイルのパスを指定する必要があります。PANカードを処理するには、APIリクエストでモデルタイプをPANとして指定する必要があります。PANモデルは、デフォルトで英語のテキストのみを処理できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/ml/ocr
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.mlkit.READ
リクエストJSONプロパティ
PANカードの表面の画像。ローカルシステム内のパスを指定する必要があります。
許可される形式: .webp, .jpeg, .png
ファイルサイズ制限: 15 MB
画像のモデルタイプ
渡す値: PAN
レスポンス詳細
レスポンスには、PANカードから抽出されたパラメータ（名、姓、生年月日、PANカード番号など）がそれぞれのキーに割り当てられて含まれます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/ocr
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F image=/Desktop/MyPan.webp
-F model_type=PAN
{
"status": "success",
"data": {
"first_name": "KIRAN",
"last_name": "RAO",
"date_of_birth": "03/04/1982",
"pan": "ANRPM2537J"
}
}
Passbook
PASSBOOKモデルは、Identity ScannerのDocument Processing機能の一部で、インドの銀行通帳を金融証明書または本人確認書類として処理できます。
注意:
-
Catalystは、アップロードされたファイルをシステムに保存しません。アップロードされた文書は一回限りの処理にのみ使用されます。MLモデルのトレーニング目的にも使用されません。Catalystコンポーネントは、適用されるすべてのデータ保護およびプライバシー法に完全に準拠しています。
-
Document Processingはインドのユーザーのみに関連し、IN DCでのみ利用可能です。この機能は、EU、AU、US、JP、SAまたはCAデータセンターからアクセスするユーザーには利用できません。他のDCからのインド国外のユーザーは、汎用OCRコンポーネントにアクセスしてテキストコンテンツを読み取り・処理できます。
Passbookの処理
説明
このAPIは、OCR技術を使用して通帳からデータフィールドを抽出し、通帳から認識されたパラメータをJSONレスポンスとして返します。銀行通帳の表紙ページの画像ファイルのパスを指定し、APIリクエストでモデルタイプをPASSBOOKとして指定する必要があります。
また、オプションでAPIリクエストに通帳に含まれる言語を入力できます。言語を指定すると、テキスト認識と抽出のプロセスがより迅速かつ正確になります。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/ml/ocr
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.mlkit.READ
リクエストJSONプロパティ
通帳の表紙ページの画像。ローカルシステム内のパスを指定する必要があります。
許可される形式: .webp, .jpeg, .png, .bmp, .tiff, .pdf
ファイルサイズ制限: 15 MB
画像のモデルタイプ
渡す値: PASSBOOK
識別する言語の言語コード。複数の言語を渡すことができます。PASSBOOKモデルは、以下の表に記載されているインド言語と国際言語をサポートしています。
デフォルト値: eng
Passbookモデルタイプがサポートする国際言語
| 言語 | 言語コード |
|---|---|
| 英語 | eng |
| アラビア語 | ara |
| 中国語 | chi_sim |
| フランス語 | fra |
| イタリア語 | ita |
| 日本語 | jpn |
| ポルトガル語 | por |
| ルーマニア語 | ron |
| スペイン語 | spa |
Passbookモデルタイプがサポートするインド言語
| 言語 | 言語コード |
|---|---|
| ヒンディー語 | hin |
| ベンガル語 | ben |
| マラーティー語 | mar |
| テルグ語 | tel |
| タミル語 | tam |
| グジャラート語 | guj |
| ウルドゥー語 | urd |
| カンナダ語 | kan |
| マラヤーラム語 | mal |
| サンスクリット語 | san |
レスポンス詳細
レスポンスには、通帳から認識された銀行情報と口座情報（銀行名、支店、住所、口座番号など）が含まれます。抽出された情報フィールドはそれぞれのキーに割り当てられます。レスポンスには、その口座でRTGS、NEFT、IMPSが有効になっているかどうかも、それらのキーに対してtrueまたはfalseを返すことで示されます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/ocr
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F image=/Desktop/MyPassbook.pdf
-F model_type=PASSBOOK
-F “language=eng”
{
"status":"success",
"data":{
"text": "{\"address\":\"NO.20 ,SUNSHINE LANE,ANNA NAGAR,CHENNAI\",\"city\":\"CHENNAI\",\"centre\":\"CHENNAI\",\"bankName\":\"ABC BANK LIMITED\",\"accountNumber\":\"000000001111222\",\"branch\":\"ANNA NAGAR\",\"dateOfOpening\":\"30/08/2012\",\"imps\":\"true\",\"neft\":\"true\",\"district\":\"CHENNAI\",\"contact\":\"2891289\",\"micr\":\"0101010\",\"name\":\" 999919\",\"state\":\"TAMIL NADU\",\"rtgs\":\"true\",\"ifsc\":\"ABCB0000111\"}"
}
}
Cheque
CHEQUEモデルは、Identity ScannerのDocument Processing機能の一部で、インドの銀行小切手を本人確認書類として処理できます。
注意:
-
Catalystは、アップロードされたファイルをシステムに保存しません。アップロードされた文書は一回限りの処理にのみ使用されます。MLモデルのトレーニング目的にも使用されません。Catalystコンポーネントは、適用されるすべてのデータ保護およびプライバシー法に完全に準拠しています。
-
Document Processingはインドのユーザーのみに関連し、IN DCでのみ利用可能です。この機能は、EU、AU、US、JP、SAまたはCAデータセンターからアクセスするユーザーには利用できません。他のDCからのインド国外のユーザーは、汎用OCRコンポーネントにアクセスしてテキストコンテンツを読み取り・処理できます。
Chequeの処理
説明
このAPIは、高度なOCR技術を使用して小切手からデータフィールドを抽出し、小切手から認識されたパラメータをJSONレスポンスとして返します。APIリクエストで小切手の画像ファイルのパスを指定し、モデルタイプをCHEQUEとして指定する必要があります。
CHEQUEモデルは、デフォルトで英語のテキストのみを処理できます。他の言語はサポートされていません。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/ml/ocr
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
content-type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.mlkit.READ
リクエストJSONプロパティ
銀行小切手の画像。ローカルシステム内のパスを指定する必要があります。
許可される形式: .webp, .jpeg, .png
ファイルサイズ制限: 15 MB
画像のモデルタイプ
渡す値: CHEQUE
レスポンス詳細
レスポンスには、小切手から抽出されたパラメータ（金額、銀行名、支店名、口座番号、IFSCコードなど）がそれぞれのキーに割り当てられて含まれます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/ocr
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: multipart/form-data; boundary=—-WebKitFormBoundary7MA4YWxkTrZu0gW”
-F image=/Desktop/MyCheque.webp
-F model_type=CHEQUE \
{
"status": "success",
"data": {
"amount": "50000",
"branch_name": "ANNA NAGAR WEST",
"bank_name": "STATE BANK OF INDIA",
"account_number": "00001234556001",
"ifsc": "SBIN0011724",
"date": "25/09/2012"
}
}
Text Analytics
Text Analyticsは、以下の3つの機能の組み合わせで構成されています: Sentiment Analysis、Named Entity Recognition、Keyword Extraction。特定のテキストブロックに対して3つのアクションすべてを実行し、テキストのトーン、認識されたエンティティの分類、テキストの要旨を提供するキーワードとキーフレーズを取得できます。
全Text Analyticsの実行
説明
このAPIを使用して、最大1500文字のテキストブロックに対してSentiment Analysis、Named Entity Recognition、Keyword Extractionを実行できます。サンプルリクエストに示すように、リクエストのJSONボディにテキストを渡すことができます。
また、オプションのキーワードを渡して、それらのキーワードを含む文に対してのみSentiment Analysisを実行することもできます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/ml/text-analytics
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
content-type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.mlkit.READ
リクエストJSONプロパティ
レスポンス詳細
レスポンスには、各テキスト分析機能の結果が含まれます。詳細情報については、各機能のレスポンス詳細セクションを個別に参照してください。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/text-analytics
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
-d ‘{
“document”:"[Zoho Corporation is an Indian software development company. The focus of Zoho Corporation lies in web-based business tools and information technology.]"
}’
{
"status":"success",
"data":[
{
"keyword_extractor":{
"keywords":[
"focus"
],
"keyphrases":[
"Indian software development company",
"Zoho Corporation",
"web - based business tools",
"information technology"
]
},
"sentiment_prediction":[
{
"document_sentiment":"Neutral",
"sentence_analytics":[
{
"sentence":"Zoho Corporation is an Indian software development company.",
"sentiment":"Neutral",
"confidence_scores":{
"negative":0.0,
"neutral":1.0,
"positive":0.0
}
},
{
"sentence":"The focus of Zoho Corporation lies in web-based business tools and information technology.",
"sentiment":"Neutral",
"confidence_scores":{
"negative":0.0,
"neutral":1.0,
"positive":0.0
}
}
],
"overall_score":1.0
}
],
"ner":{
"general_entities":[
{
"start_index":0,
"confidence_score":99,
"end_index":16,
"ner_tag":"Organization",
"token":"Zoho Corporation"
},
{
"start_index":23,
"confidence_score":99,
"end_index":29,
"ner_tag":"Miscellaneous",
"token":"Indian"
},
{
"start_index":73,
"confidence_score":99,
"end_index":89,
"ner_tag":"Organization",
"token":"Zoho Corporation"
}
]
}
}
]
}
Sentiment Analysis
Zia Sentiment Analysisは、Text Analyticsの一部で、テキストコンテンツを処理してメッセージのトーンと、それを通じて伝えられるセンチメントを認識します。テキスト内の各文を分析して、そのトーンがPositive、Negative、またはNeutralであるかを判定します。次に、各文で認識されたセンチメントに基づいて、テキスト全体のトーンをこれら3つのセンチメントのいずれかとして判定します。
レスポンスには、分析の精度を示すために、各文とテキスト全体の信頼度スコアも返されます。
Sentiment Analysisの実行
説明
このAPIを使用して、1回のリクエストで最大1500文字のテキストブロックに対してSentiment Analysisを実行できます。サンプルリクエストに示すように、リクエストのJSONボディにテキストを渡す必要があります。
また、テキストに対してオプションのキーワードを渡すこともできます。これにより、Sentiment Analysisはこれらのキーワードを含む文のみを処理し、そのセンチメントを判定します。他の文は無視されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/ml/text-analytics/sentiment-analysis
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
content-type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.mlkit.READ
リクエストJSONプロパティ
レスポンス詳細
レスポンスには、個々の文の分析結果とテキスト全体の分析結果が、Positive、Negative、またはNeutralとして含まれ、各分析の全体的な信頼度スコアも含まれます。信頼度スコアは0から1の範囲です。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/text-analytics/sentiment-analysis
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
-d ‘{“document”:"[I love the design of the new model.]",
“keywords”:"[design]"
}’
{
"status":"success",
"data":[
{
"sentiment_prediction":[
{
"document_sentiment":"Positive",
"sentence_analytics":[
{
"sentence":"I love the design of the new model",
"sentiment":"Positive",
"confidence_scores":{
"negative":0.0,
"neutral":0.0,
"positive":1.0
}
}
],
"keyword":"design",
"overall_score":1.0
}
]
}
]
}
Named Entity Recognition
Zia Named Entity Recognitionは、Text Analyticsの一部で、テキストコンテンツを処理してキーワードを抽出し、さまざまなカテゴリに分類します。例えば、テキスト内の単語が組織名、人名、または日付であることを判定し、適切なカテゴリに追加できます。NERが認識するすべてのカテゴリのリストについてはこちらを参照してください。
レスポンスは、認識されたすべてのエンティティの詳細と、それらが属するカテゴリを示すタグを返します。また、各認識の精度を示す信頼度スコアと、テキスト内のエンティティの位置も含まれます。
Named Entity Recognitionの実行
説明
このAPIを使用して、1回のリクエストで最大1500文字のテキストブロックに対してNamed Entity Recognitionを実行できます。サンプルリクエストに示すように、リクエストのJSONボディにテキストを渡すことができます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/ml/text-analytics/ner
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
content-type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.mlkit.READ
リクエストJSONプロパティ
レスポンス詳細
レスポンスは、テキスト内で認識されたすべてのエンティティの配列を返します。各エンティティ認識の詳細には、エンティティの分類タグが含まれます（例：組織名を示すORGやその他の値を示すMISC）。
レスポンスは、テキスト内の各エンティティの位置もstart_indexとend_indexを通じて返し、エンティティの開始インデックスと終了インデックスを示します。各エンティティ分類に対して決定された信頼度スコアはパーセンテージ値で表されます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/text-analytics/ner
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
-d ‘{
“document”:"[The biggest reason for me to love and remember this trek is the beautiful valley itself. Right from the entry, you can see a bed of pink alpine orchids, blue Himalayan poppies, yellow marigolds, and a whole variety of flowers spread out around you. The weather was also very pleasant that day, about 24 degree celsius, which made the experience all the more amazing.]"
}’
{
"status": "success",
"data": [
{
"ner": {
"general_entities": [
{
"start_index": 21,
"confidence_score": 100,
"end_index": 25,
"ner_tag": "Color",
"token": "pink"
}
]
}
},
{
"ner": {
"general_entities": [
{
"start_index": 94,
"confidence_score": 56,
"end_index": 97,
"ner_tag": "Duration",
"token": "day"
}
]
}
},
{
"ner": {
"general_entities": []
}
},
{
"ner": {
"general_entities": []
}
},
{
"ner": {
"general_entities": [
{
"start_index": 0,
"confidence_score": 100,
"end_index": 6,
"ner_tag": "Color",
"token": "yellow"
}
]
}
},
{
"ner": {
"general_entities": [
{
"start_index": 6,
"confidence_score": 100,
"end_index": 15,
"ner_tag": "Temperature",
"token": "24 degree",
"fine_entities": [
{
"start_index": 9,
"end_index": 15,
"ner_tag": "Fahrenhiet",
"token": "degree"
},
{
"start_index": 6,
"end_index": 8,
"ner_tag": "Value",
"token": "24"
}
]
},
{
"start_index": 16,
"confidence_score": 100,
"end_index": 23,
"ner_tag": "Unit_temperature",
"token": "celsius"
}
]
}
},
{
"ner": {
"general_entities": [
{
"start_index": 5,
"confidence_score": 61,
"end_index": 14,
"ner_tag": "Miscellaneous",
"token": "Himalayan"
},
{
"start_index": 0,
"confidence_score": 100,
"end_index": 4,
"ner_tag": "Color",
"token": "blue"
}
]
}
}
]
}
Keyword Extraction
Zia Keyword Extractionは、Text Analyticsの一部で、テキストコンテンツを処理してテキストのハイライトを抽出します。抽出された用語は、KeywordsとKeyphrasesの2つのカテゴリに分類されます。これらのハイライトは、テキストの簡潔な要約を提供し、テキスト全体の概要を提供します。
Keyword Extractionは、長いテキストコンテンツをざっと確認し、そこから重要な情報とアクションアイテムだけを取得したい場合に非常に便利な機能です。レスポンスからテキストの主題と要旨を簡単に把握でき、貴重な時間を節約できます。
Keyword Extractionの実行
説明
このAPIを使用して、1回のリクエストで最大1500文字のテキストブロックに対してKeyword Extractionを実行できます。サンプルリクエストに示すように、リクエストのJSONボディにテキストを渡すことができます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/ml/text-analytics/keyword-extraction
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
content-type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.mlkit.READ
リクエストJSONプロパティ
レスポンス詳細
レスポンスには、テキストから抽出されたキーワードの配列と、キーフレーズの配列が含まれます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/ml/text-analytics/keyword-extraction
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H “Content-Type: application/json”
-d ‘{
“document”:
“[Catalyst is a full-stack cloud-based serverless development tool, that provides backend functionalities to build applications and microservices on various platforms.]”
}’
{
"status": "success",
"data": [
{
"keyword_extractor": {
"keywords": [
"microservices",
"applications"
],
"keyphrases": [
"backend functionalities",
"various platforms"
]
}
},
{
"keyword_extractor": {
"keywords": [
"Catalyst"
],
"keyphrases": [
"cloud-based serverless development tool"
]
}
}
]
}
Automation Testing
Automation Testingは、アプリケーションのAPIテストプロセスを自動化するAPIテストツールです。アプリケーション内のBasic I/OおよびAdvanced I/O関数、または任意のサードパーティURLをテストし、レスポンスを取得できます。要件に基づいてテストケースを記述し、テストの自動実行をスケジュールし、最小限の手動介入でAPIテストのプロセス全体を管理できます。
テストプランの実行
説明
テストプランは、Automation Testingにおける1つ以上のテストスイートの自動実行を可能にします。このAPIを使用すると、プロジェクト内のリモートコンソールで既に設定されているテストプランの実行をトリガーできます。これは、コンソールでテストプランに対して利用可能な即時実行オプションと同等です。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/automation-testing/{test_plan_id}/execute
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Environment: Development
任意のヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.automationtesting.execute
レスポンス詳細
レスポンスには、テストプラン実行のステータスが含まれ、自動実行または即時実行ごとに生成される一意のRun ID、渡されたTest Plan ID、および実行開始のステータスをtrueまたはfalseとして含むis_schedule_startedパラメータなどの詳細が含まれます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/3359000000016812/automation-testing/537000000022025/execute
-H “Authorization: Zoho-oauthtoken 1000.25*************************e.3e*************************3” \
{
"status": "success",
"data": {
"id": 537000000034053,
"test_plan_id": 537000000022025,
"is_schedule_started": true
}
}
Catalyst SmartBrowz
Catalyst SmartBrowzは、幅広いコンポーネントを通じてCatalystのクラウド環境でリモートブラウザを管理・制御できるCatalystブラウザサービスです。Browser Grid、Browser Logic関数、PDF & Screenshot、テンプレートなどが含まれます。
Browser Grid
Browser Gridは、ノードとブラウザのカスタム設定を通じてヘッドレスブラウザに接続できるCatalyst SmartBrowzのコンポーネントです。
すべてのBrowser Gridを一覧表示
説明
このAPIを使用すると、プロジェクトに作成されたすべてのグリッドの一覧を取得できます。
PDFリクエスト詳細
リクエストURL
{api-domain}/browser360/v1/project/{project_id}/browser-grid
スコープ
ZohoCatalyst.grid.read
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: Org IDの値を指定します。
レスポンス詳細
プロジェクトに存在するすべてのグリッドの詳細を含むレスポンスが返されます。
curl -X GET ‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid'
-H ‘CATALYST-ORG: 111737956’
-H ‘Content-Type: application/json’
-H ‘Authorization: Zoho-oauthtoken 1000.******************************************************780’
{
“status”: “success”,
“data”: [
{
“id”: “3970000000006058”,
“name”: “play”,
“memory”: 1024,
“browser_version”: {
“chrome_version”: “137.0.7515.155”,
“firefox_version”: “136.0.4”
},
“created_time”: “Sep 10, 2025 07:04 PM”,
“modified_time”: “Sep 10, 2025 07:04 PM”,
“api_key_modified_time”: “1757511270919”,
“created_by”: {
“zuid”: “111734674”,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“modified_by”: {
“zuid”: “111734674”,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“project_details”: {
“project_name”: “Project-Rainfall”,
“id”: “38119000000022053”,
“project_type”: “Live”
},
“endpoint_type”: 1,
“max_session_count”: 1,
“max_nodes_count”: 10,
“max_concurrent_count”: 10,
“config_type”: 1
},
{
“id”: “3970000000005426”,
“name”: “Automation”,
“memory”: 1024,
“browser_version”: {
“chrome_version”: “137.0.7515.155”,
“firefox_version”: “136.0.4”
},
“created_time”: “Sep 10, 2025 12:47 PM”,
“modified_time”: “Sep 23, 2025 03:12 PM”,
“api_key_modified_time”: “1757488669690”,
“created_by”: {
“zuid”: “111734674”,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“modified_by”: {
“zuid”: “111734674”,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“project_details”: {
“project_name”: “Project-Rainfall”,
“id”: “38119000000022053”,
“project_type”: “Live”
},
“endpoint_type”: 2,
“max_session_count”: 1,
“max_nodes_count”: 5,
“max_concurrent_count”: 5,
“config_type”: 2
},
{
“id”: “3970000000005027”,
“name”: “SDK”,
“memory”: 1024,
“browser_version”: {
“chrome_version”: “137.0.7515.155”,
“firefox_version”: “136.0.4”
},
“created_time”: “Sep 10, 2025 11:33 AM”,
“modified_time”: “Sep 10, 2025 04:27 PM”,
“api_key_modified_time”: “1757484201284”,
“created_by”: {
“zuid”: “111734674”,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“modified_by”: {
“zuid”: “111734674”,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“project_details”: {
“project_name”: “Project-Rainfall”,
“id”: “38119000000022053”,
“project_type”: “Live”
},
“endpoint_type”: 2,
“max_session_count”: 1,
“max_nodes_count”: 5,
“max_concurrent_count”: 5,
“config_type”: 1
},
{
“id”: “3970000000005015”,
“name”: “Puppeteer_Grid”,
“memory”: 1024,
“browser_version”: {
“chrome_version”: “137.0.7515.155”,
“firefox_version”: “136.0.4”
},
“created_time”: “Sep 10, 2025 10:21 AM”,
“modified_time”: “Sep 10, 2025 10:21 AM”,
“api_key_modified_time”: “1757479864798”,
“created_by”: {
“zuid”: “111734674”,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“modified_by”: {
“zuid”: “111734674”,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“project_details”: {
“project_name”: “Project-Rainfall”,
“id”: “38119000000022053”,
“project_type”: “Live”
},
“endpoint_type”: 1,
“max_session_count”: 1,
“max_nodes_count”: 1,
“max_concurrent_count”: 1,
“config_type”: 1
},
{
“id”: “3970000000005013”,
“name”: “Selenium_Gridt”,
“memory”: 1024,
“browser_version”: {
“chrome_version”: “137.0.7515.155”,
“firefox_version”: “136.0.4”
},
“created_time”: “Sep 10, 2025 10:21 AM”,
“modified_time”: “Sep 23, 2025 05:50 PM”,
“api_key_modified_time”: “1757479864794”,
“created_by”: {
“zuid”: “111734674”,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“modified_by”: {
“zuid”: “111734674”,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“project_details”: {
“project_name”: “Project-Rainfall”,
“id”: “38119000000022053”,
“project_type”: “Live”
},
“endpoint_type”: 2,
“max_session_count”: 1,
“max_nodes_count”: 1,
“max_concurrent_count”: 1,
“config_type”: 2
}
]
}
特定のBrowser Gridを一覧表示
説明
このAPIを使用すると、プロジェクトに作成された特定のブラウザグリッドの詳細を一覧表示できます。必要なグリッドはGrid IDを使用して参照されます。
PDFリクエスト詳細
リクエストURL
{api-domain}/browser360/v1/project/{project_id}/browser-grid/{grid_id}
スコープ
ZohoCatalyst.grid.read
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: Org IDの値を指定します。
レスポンス詳細
特定のグリッドの詳細を含むレスポンスが返されます。
curl -X PUT ‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000006058'
-H ‘CATALYST-ORG: 111737956’
-H ‘Connection: keep-alive’
-H ‘Content-Type: application/json’
-H ‘Authorization: Zoho-oauthtoken 1000********************************************780’
-d ‘{
“name”: “grid_2”,
“memory”: 1024,
“max_nodes_count”: 10,
“max_session_count”: 1,
“endpoint_type”: 1,
“config_type”: 1
}’
{
“status”: “success”,
“data”: {
“id”: “3970000000006058”,
“name”: “play2”,
“memory”: 1024,
“browser_version”: {
“chrome_version”: “137.0.7515.155”,
“firefox_version”: “136.0.4”
},
“created_time”: “Sep 10, 2025 07:04 PM”,
“modified_time”: “Sep 24, 2025 11:55 AM”,
“api_key_modified_time”: “1757511270919”,
“created_by”: {
“zuid”: “111734674”,
“is_confirmed”: false,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“modified_by”: {
“zuid”: “111734674”,
“is_confirmed”: false,
“email_id”: “emmy@zylker.com”,
“first_name”: “Headless”,
“last_name”: “2”,
“user_type”: “SuperAdmin”
},
“project_details”: {
“project_name”: “Project-Rainfall”,
“id”: “38119000000022053”,
“project_type”: “Live”
},
“endpoint_type”: 1,
“max_session_count”: 1,
“max_nodes_count”: 10,
“max_concurrent_count”: 10,
“config_type”: 1
}
}
グリッドのライブ統計を取得
説明
このAPIを使用すると、特定のグリッドのパフォーマンスのライブ統計を取得できます。必要なグリッドはGrid IDを使用して参照されます。
リクエスト詳細
リクエストURL
{api-domain}/browser360/v1/project/{project_id}/browser-grid/{grid_id}/stats?data_to_fetch=live_stats
スコープ
ZohoCatalyst.grid.read
OAuthを使用したAPIのリクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: Org IDの値を指定します。
APIキーを使用したAPIのリクエストヘッダー
Authorization
api-key: Catalystによって生成された一意のキー。コンソールから取得できます。
レスポンス詳細
Grid IDを使用して参照された特定のグリッドのライブ統計を含むレスポンスが返されます。
curl -X GET ‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/stats?data_to_fetch=live_stats'
-H ‘Authorization: Zoho-oauthtoken 1000*************************************f780’
-H ‘CATALYST-ORG: 111737956’
curl -X GET / ‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/stats?data_to_fetch=live_stats'
-H ‘api-key: 961***********************************************************************7049’
{
“status”: “success”,
“data”: {
“free_sessions”: 5,
“session_queue_size”: 0,
“node_count”: 0,
“session_count”: 0,
“is_hub_alive”: false
}
}
グリッドのノード数とリクエスト数を取得
説明
このAPIを使用すると、グリッドのノード数とリクエスト数の統計を取得できます。必要なグリッドはGrid IDを使用して参照されます。
リクエスト詳細
リクエストURL
{api-domain}/browser360/v1/project/{project_id}/browser-grid/{grid_id}/stats?data_to_fetch=node_req_count&datetime_filter=Last+30+Days
スコープ
ZohoCatalyst.grid.read
OAuthを使用したAPIのリクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: Org IDの値を指定します。
APIキーを使用したAPIのリクエストヘッダー
Authorization
api-key: Catalystによって生成された一意のキー。コンソールから取得できます。
レスポンス詳細
Grid IDを使用して参照された特定のグリッドのノード数とリクエスト数の統計の最大値と平均値を含むレスポンスが返されます。
curl -X GET
‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/stats?datetime_filter=24+Hours&data_to_fetch=node_req_count'
-H ‘CATALYST-ORG: 111737956’
-H ‘Authorization: Zoho-oauthtoken 1000*********************************************780’
curl -X GET
‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/stats?datetime_filter=24+Hours&data_to_fetch=node_req_count'
-H ‘CATALYST-ORG: 111737956’
-H ‘api-key: 96********************************************************************7049’
{
“status”: “success”,
“data”: {
“avg_concurrent_node_count”: “1”,
“max_concurrent_node_count”: “1”,
“avg_concurrent_req_count”: “0”,
“max_concurrent_req_count”: “0”
}
}
グリッドのメモリとCPU使用量を取得
説明
このAPIを使用すると、特定のグリッドのメモリとCPU使用量の詳細を取得できます。必要なグリッドはGrid IDを使用して参照されます。
リクエスト詳細
リクエストURL
{api-domain}/browser360/v1/project/{project_id}/browser-grid/{grid_id}/stats?data_to_fetch=memory_cpu_usage&datetime_filter=Last+30+Days
スコープ
ZohoCatalyst.grid.read
OAuthを使用したAPIのリクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: Org IDの値を指定します。
APIキーを使用したAPIのリクエストヘッダー
Authorization
api-key: Catalystによって生成された一意のキー。コンソールから取得できます。
レスポンス詳細
Grid IDを使用して参照された特定のグリッドのメモリとCPU使用量の統計の最大値と平均値を含むレスポンスが返されます。
curl -X GET
‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/stats?datetime_filter=24+Hours&data_to_fetch=memory_cpu_usage'
-H ‘CATALYST-ORG: 111737956’
-H ‘Authorization: Zoho-oauthtoken 1000*********************************************780’
-H ‘catalyst-org: 111737956’
curl -X GET
‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/stats?datetime_filter=24+Hours&data_to_fetch=memory_cpu_usage'
-H ‘CATALYST-ORG: 111737956’
-H ‘api-key: 96********************************************************************7049’
{
“status”: “success”,
“data”: {
“max_memory_usage”: 926.65234375,
“high_disk_usage_count”: 0,
“max_cpu_usage”: 1.1011011011011012,
“avg_memory_usage”: 926.65234375,
“avg_cpu_usage”: 1.1011011011011012
}
}
ブラウザ拒否とノードクラッシュの統計を取得
説明
このAPIを使用すると、グリッドでスポーンが拒否されたブラウザとクラッシュしたノードの統計を取得できます。必要なグリッドはGrid IDを使用して参照されます。
リクエスト詳細
リクエストURL
{api-domain}/browser360/v1/project/{project_id}/browser-grid/{grid_id}/stats?data_to_fetch=crashed_data&datetime_filter=Last+30+Days
スコープ
ZohoCatalyst.grid.read
OAuthを使用したAPIのリクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: Org IDの値を指定します。
APIキーを使用したAPIのリクエストヘッダー
Authorization
api-key: Catalystによって生成された一意のキー。コンソールから取得できます。
レスポンス詳細
Grid IDを使用して参照された特定のグリッドのスポーンが許可されなかったブラウザの数とクラッシュしたノードの数を含むレスポンスが返されます。
curl -X GET
‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/stats?datetime_filter=24+Hours&data_to_fetch=crashed_data'
-H ‘CATALYST-ORG: 111737956’
-H ‘Authorization: Zoho-oauthtoken 1000*********************************************780’ \
curl -X GET
‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/stats?datetime_filter=24+Hours&data_to_fetch=crashed_data'
-H ‘CATALYST-ORG: 111737956’
-H ‘api-key: 96********************************************************************7049’
{
“status”: “success”,
“data”: {
“browser_req_reject_count”: 0,
“node_crashed_count”: “0”
}
}
ブラウザリクエストグラフ
説明
このAPIを使用すると、24時間のグリッド内のブラウザリクエスト数のデータを取得できます。必要なグリッドはGrid IDを使用して参照されます。
リクエスト詳細
リクエストURL
{api-domain}/browser360/v1/project/{project_id}/browser-grid/{grid_id}/graph-data?datetime_filter=24+Hours&data_to_fetch=req_graph_data
スコープ
ZohoCatalyst.grid.read
OAuthを使用したAPIのリクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: Org IDの値を指定します。
APIキーを使用したAPIのリクエストヘッダー
Authorization
api-key: Catalystによって生成された一意のキー。コンソールから取得できます。
レスポンス詳細
24時間のブラウザグリッドの時刻と使用量を含むレスポンスが返されます。必要なグリッドはGrid IDを使用して参照されます。
curl -X GET
‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/graph-data?datetime_filter=24+Hours&data_to_fetch=req_graph_data'
-H ‘CATALYST-ORG: 111737956’
-H ‘Authorization: Zoho-oauthtoken 1000*********************************************780’
curl -X GET
‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/graph-data?datetime_filter=24+Hours&data_to_fetch=req_graph_data'
-H ‘CATALYST-ORG: 111737956’
-H ‘api-key: 96********************************************************************7049’
{
“status”: “success”,
“data”: [
[“Sep 22 2025, 04:00 PM”, 0.0],
[“Sep 22 2025, 06:00 PM”, 0.0],
[“Sep 22 2025, 08:00 PM”, 0.0],
[“Sep 22 2025, 10:00 PM”, 0.0],
[“Sep 23 2025, 12:00 AM”, 0.0],
[“Sep 23 2025, 02:00 AM”, 0.0],
[“Sep 23 2025, 04:00 AM”, 0.0],
[“Sep 23 2025, 06:00 AM”, 0.0],
[“Sep 23 2025, 08:00 AM”, 0.0],
[“Sep 23 2025, 10:00 AM”, 0.0],
[“Sep 23 2025, 12:00 PM”, 0.0],
[“Sep 23 2025, 02:00 PM”, 0.0],
[“Sep 23 2025, 04:00 PM”, 0.0],
[“Sep 23 2025, 06:00 PM”, 0.0]
]
}
ノード数グラフ
説明
このAPIを使用すると、24時間のグリッド内のアクティブなノード数のデータを取得できます。必要なグリッドはGrid IDを使用して参照されます。
リクエスト詳細
リクエストURL
{api-domain}/browser360/v1/project/{project_id}/browser-grid/{grid_id}/graph-data?datetime_filter=24+Hours&data_to_fetch=node_graph_data
スコープ
ZohoCatalyst.grid.read
OAuthを使用したAPIのリクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: Org IDの値を指定します。
APIキーを使用したAPIのリクエストヘッダー
Authorization
api-key: Catalystによって生成された一意のキー。コンソールから取得できます。
レスポンス詳細
24時間のブラウザグリッドの時刻とノード数を含むレスポンスが返されます。必要なグリッドはGrid IDを使用して参照されます。
curl -X GET ‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/graph-data?datetime_filter=24+Hours&data_to_fetch=node_graph_data'
-H ‘CATALYST-ORG: 111737956’
-H ‘Authorization: Zoho-oauthtoken 1000*********************************************780’
curl -X GET ‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/graph-data?datetime_filter=24+Hours&data_to_fetch=node_graph_data'
-H ‘CATALYST-ORG: 111737956’
-H ‘api-key: 96********************************************************************7049’
{
“status”: “success”,
“data”: [
[“Sep 23 2025, 11:00 AM”, 0.0],
[“Sep 23 2025, 01:00 PM”, 0.0],
[“Sep 23 2025, 03:00 PM”, 0.0],
[“Sep 23 2025, 05:00 PM”, 1.0],
[“Sep 23 2025, 07:00 PM”, 0.0],
[“Sep 23 2025, 09:00 PM”, 0.0],
[“Sep 23 2025, 11:00 PM”, 0.0],
[“Sep 24 2025, 01:00 AM”, 0.0],
[“Sep 24 2025, 03:00 AM”, 0.0],
[“Sep 24 2025, 05:00 AM”, 0.0],
[“Sep 24 2025, 07:00 AM”, 0.0],
[“Sep 24 2025, 09:00 AM”, 0.0],
[“Sep 24 2025, 11:00 AM”, 0.0],
[“Sep 24 2025, 01:00 PM”, 0.0]
]
}
メモリ使用量グラフ
説明
このAPIを使用すると、24時間のグリッドで使用されたメモリのデータを取得できます。必要なグリッドはGrid IDを使用して参照されます。
リクエスト詳細
リクエストURL
{api-domain}/browser360/v1/project/{project_id}/browser-grid/{grid_id}/graph-data?datetime_filter=24+Hours&data_to_fetch=memory_graph_data
スコープ
ZohoCatalyst.grid.read
OAuthを使用したAPIのリクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: Org IDの値を指定します。
APIキーを使用したAPIのリクエストヘッダー
Authorization
api-key: Catalystによって生成された一意のキー。コンソールから取得できます。
レスポンス詳細
24時間のブラウザグリッドの時刻とノード数を含むレスポンスが返されます。必要なグリッドはGrid IDを使用して参照されます。
curl -X GET ‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/graph-data?datetime_filter=24+Hours&data_to_fetch=memory_graph_data'
-H ‘CATALYST-ORG: 111737956’
-H ‘Authorization: Zoho-oauthtoken 1000*********************************************780’
curl -X GET ‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/graph-data?datetime_filter=24+Hours&data_to_fetch=memory_graph_data'
-H ‘CATALYST-ORG: 111737956’
-H ‘api-key: 96********************************************************************7049’
{
“status”: “success”,
“data”: [
{
“time”: “Sep 23 2025, 11:00 AM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 23 2025, 01:00 PM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 23 2025, 03:00 PM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 23 2025, 05:00 PM”,
“memory_usage_mb”: 771.1453125
},
{
“time”: “Sep 23 2025, 07:00 PM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 23 2025, 09:00 PM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 23 2025, 11:00 PM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 24 2025, 01:00 AM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 24 2025, 03:00 AM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 24 2025, 05:00 AM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 24 2025, 07:00 AM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 24 2025, 09:00 AM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 24 2025, 11:00 AM”,
“memory_usage_mb”: 0.0
},
{
“time”: “Sep 24 2025, 01:00 PM”,
“memory_usage_mb”: 0.0
}
]
}
CPU使用量グラフ
説明
このAPIを使用すると、24時間のグリッドで使用されたCPUのデータを取得できます。必要なグリッドはGrid IDを使用して参照されます。
リクエスト詳細
リクエストURL
{api-domain}/browser360/v1/project/{project_id}/browser-grid/{grid_id}/graph-data?datetime_filter=24+Hours&data_to_fetch=cpu_graph_data
スコープ
ZohoCatalyst.grid.read
OAuthを使用したAPIのリクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: Org IDの値を指定します。
APIキーを使用したAPIのリクエストヘッダー
Authorization
api-key: Catalystによって生成された一意のキー。コンソールから取得できます。
レスポンス詳細
24時間のブラウザグリッドのCPU使用量を含むレスポンスが返されます。必要なグリッドはGrid IDを使用して参照されます。
curl -X GET ‘https://consoleqa2.catalyst.localzoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/graph-data?datetime_filter=24+Hours&data_to_fetch=cpu_graph_data'
-H ‘CATALYST-ORG: 111737956’
-H ‘Authorization: Zoho-oauthtoken 1000*********************************************780’
curl -X GET ‘https://consoleqa2.catalyst.localzoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/graph-data?datetime_filter=24+Hours&data_to_fetch=cpu_graph_data'
-H ‘CATALYST-ORG: 111737956’
-H ‘api-key: 96********************************************************************7049’
{
“status”: “success”,
“data”: [
[“Sep 23 2025, 11:00 AM”, 0.0],
[“Sep 23 2025, 01:00 PM”, 0.0],
[“Sep 23 2025, 03:00 PM”, 0.0],
[“Sep 23 2025, 05:00 PM”, 0.8621659781801722],
[“Sep 23 2025, 07:00 PM”, 0.0],
[“Sep 23 2025, 09:00 PM”, 0.0],
[“Sep 23 2025, 11:00 PM”, 0.0],
[“Sep 24 2025, 01:00 AM”, 0.0],
[“Sep 24 2025, 03:00 AM”, 0.0],
[“Sep 24 2025, 05:00 AM”, 0.0],
[“Sep 24 2025, 07:00 AM”, 0.0],
[“Sep 24 2025, 09:00 AM”, 0.0],
[“Sep 24 2025, 11:00 AM”, 0.0],
[“Sep 24 2025, 01:00 PM”, 0.0]
]
}
Browser Gridの停止
説明
このAPIを使用すると、ブラウザグリッドを停止して実質的に終了できます。
リクエスト詳細
リクエストURL
{api-domain}/browser360/v1/project/{project_id}/browser-grid/{grid_id}/stop
スコープ
ZohoCatalyst.grid.terminate
OAuthを使用したAPIのリクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
CATALYST-ORG: Org IDの値を指定します。
APIキーを使用したAPIのリクエストヘッダー
Authorization
api-key: Catalystによって生成された一意のキー。コンソールから取得できます。
レスポンス詳細
実行のステータスに関する詳細を含むレスポンスが返されます。
curl -X POST
‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/stop'
-H ‘Authorization: Zoho-oauthtoken 1000*********************************************780’
-H ‘catalyst-org: 111737956’
curl -X POST \ ‘https://api.catalyst.zoho.com/browser360/v1/project/38119000000022053/browser-grid/3970000000005013/stop'
-H ‘CATALYST-ORG: 111737956’
-H ‘api-key: 96********************************************************************7049’
{
“status”: “success”,
“data”: true
}
PDF & Screenshot
PDF & Screenshotは、WebサイトやWebアプリケーションのビジュアルドキュメントを生成できるSmartBrowzのコンポーネントです。WebページのPDF変換、UIデバッグ時の使用、エンドユーザーの視点からのビジュアルコンポーネントの理解、許可されたクロール操作の実行など、さまざまな用途に活用できる強力なツールです。
以下のAPIを使用して、この機能をCatalystアプリケーションに導入できます。
HTML/URLを使用したPDF生成
PDFの説明
このAPIを使用すると、HTMLコードまたはURLを入力として使用し、WebページのPDFドキュメントを生成できます。
PDFリクエスト詳細
リクエストURL
{api-domain}/browser360/v1/project/{project_id}/convert
スコープ
ZohoCatalyst.pdfshot.EXECUTE
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
リクエストJSONプロパティ
デフォルト: false。
印刷ヘッダーのHTMLテンプレート。以下のクラスを持つ有効なHTMLで、値を注入できます:
デフォルト値は
page.set_default_timeout()またはpage.set_default_navigation_timeout()メソッドを使用して変更できます。
PDFレスポンス詳細
レスポンスとして生成されたPDFドキュメントが返されます。
HTML/URLを使用したスクリーンショット生成
スクリーンショットの説明
このAPIを使用すると、HTMLコードまたはURLを入力として使用し、Webページのスクリーンショットを生成できます。
スクリーンショットリクエスト詳細
リクエストURL
{api-domain}/browser360/v1/project/{project_id}/convert
スコープ
ZohoCatalyst.pdfshot.EXECUTE
リクエストJSONプロパティ
スクリーンショットレスポンス詳細
レスポンスとして生成されたスクリーンショットが返されます。
curl -X POST \ ‘https://api.catalyst.zoho.com/browser360/v1/project/10470000000272001/convert'
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H ‘Content-Type: application/json’
–d ‘{
“url”: “https://www.example.com”,
“output_options”: {
“output_type”: “pdf”
},
“pdf_options” : {
“scale” : 1,
“display_header_footer” : true,
“header_template” : “<style> #header, #footer { margin: 0 !important; padding: 0 !important; font-size: 9px; -webkit-print-color-adjust: exact;}</style><div style=\width:100%><span class=\date></span><span class=\title\ style=\float:right></span</div>”,
“footer_template” : “<style> #header, #footer { margin: 0 !important; padding: 0 !important; font-size: 9px; -webkit-print-color-adjust: exact;}</style><div style=\width:100%><span class=\url></span><div style=\float:right><span class=\pageNumber></span> / <span class=\totalPages></span></div></div>”,
“print_background” : false,
“landscape” : false,
“page_ranges” : “1”,
“format” : “A4”,
“width” : “100”,
“height” : “100”,
“margin” :
{
“top” : “1cm”,
“bottom” : “1cm”,
“left” : “1cm”,
“right”: “1cm”
},
“omit_background” : false
},
“page_options”:{
“css” : {
“content” : “body{background: lightgrey}”
},
“viewport” : {
“width”: 1440,
“height”: 900
},
“javascript_enabled” : true
},
“navigation_options”:{
“timeout” : 5000,
“wait_until” : “networkidle0”
}
}’
curl -X POST \ ‘https://api.catalyst.zoho.com/browser360/v1/project/10470000000272001/convert'
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H ‘Content-Type: application/json’
–d’{
“url”: “https://www.example.com”,
“output_options”: {
“output_type”: “screenshot”
},
“screenshot_options”: {
“type”: “jpeg”,
“quality”: 100,
“full_page”: false,
“omit_background”: false,
“capture_beyond_viewport”: true,
“clip”: {
“x”: 50,
“y”: 100,
“width”: 1000,
“height”: 100
}
},
“page_options”: {
“css”: {
“content”: “body{background: lightgrey}”
},
“viewport”: {
“width”: 1440,
“height”: 900
},
“javascript_enabled”: true
},
“navigation_options”: {
“timeout”: 5000,
“wait_until”: “networkidle0”
}
}’
テンプレートを使用したPDF生成
説明
このAPIを使用すると、テンプレートを入力として使用し、WebページのPDFドキュメントを生成できます。
PDFリクエスト詳細
リクエストURL
{api-domain}/browser360/v1/project/{project_id}/convert
スコープ
ZohoCatalyst.pdfshot.EXECUTE
リクエストJSONプロパティ
デフォルト: false。
デフォルト値は
page.set_default_timeout()またはpage.set_default_navigation_timeout()メソッドを使用して変更できます。
PDFレスポンス詳細
レスポンスとして生成されたPDFが返されます。
注意:
-
このAPIを使用するには、コンソールでテンプレートを作成する必要があります。
-
SmartBrowz Templatesでは、テンプレートを使用して生成するPDFドキュメントにパスワードを設定するオプションが提供されています。パスワードを手動で設定オプションを使用する場合、このAPIを使用できます。パスワードを動的に設定オプションを使用する場合、このAPIは使用できません。
テンプレートを使用したスクリーンショット生成
スクリーンショットの説明
このAPIを使用すると、テンプレートを入力として使用し、Webページのスクリーンショットを生成できます。
スクリーンショットリクエスト詳細
リクエストURL
{api-domain}/browser360/v1/project/{project_id}/convert
スコープ
ZohoCatalyst.pdfshot.EXECUTE
リクエストJSONプロパティ
デフォルト値は
page.set_default_timeout()またはpage.set_default_navigation_timeout()メソッドを使用して変更できます。
スクリーンショットレスポンス詳細
レスポンスとして生成されたスクリーンショットが返されます。
curl -X POST 'https://api.catalyst.zoho.com/browser360/v1/project/10470000000272001/convert'
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H ‘Content-Type: application/json’
–d ‘{
“template_id”:“367000000044001”,
“template_data”:{},
“output_options”: {
“output_type”: “pdf”
},
“pdf_options” : {
“scale” : 1,
“display_header_footer” : true,
"print_background" : false,
"landscape" : false,
"page_ranges" : "1",
"format" : "A4",
"width" : "100",
"height" : "100",
"omit_background" : false,
"password": "Demo$"
},
"page_options":{
"css" : {
"content" : "body{background: lightgrey}"
},
"viewport" : {
"width": 1440,
"height": 900
},
"javascript_enabled" : true
},
"navigation_options":{
"timeout" : 5000,
"wait_until" : "networkidle0"
}
}’
curl -X POST \ ‘https://api.catalyst.zoho.com/browser360/v1/project/10470000000272001/convert'
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57”
-H ‘Content-Type: application/json’
-d ‘{
“template_id”:“367000000044001”,
“template_data”:{},
“output_options”: {
“output_type”: “pdf”
},
“screenshot_options” : {
“type” : “jpeg”,
“quality” : 100,
“full_page” : false,
“omit_background” : false,
“capture_beyond_viewport” : true,
“clip” :{
“x” : 50,
“y” : 100,
“width” : 1000,
“height”: 100
}
},
“page_options”:{
"css" : {
"content" : "body{background: lightgrey}"
},
"viewport" : {
"width": 1440,
"height": 900
},
"javascript_enabled" : true
},
“navigation_options”:{
“timeout” : 5000,
“wait_until” : “networkidle0”
}
}’
Catalyst ConvoKraft
Catalyst ConvoKraftは、インテリジェントなチャットボットを構築してCatalystアプリケーションにデプロイできるAI搭載サービスです。これらのボットは自然言語理解（NLU）を活用してメッセージを解釈し、自然な会話形式の英語で応答します。アプリケーションの要件に基づいて、独自のロジックを設定したり、簡単な質問と回答のペアを提供したり、カスタムリソースでトレーニングしたりして、ボットをカスタマイズできます。
SmartTrainは、Catalyst ConvoKraftサービスのコンポーネントで、独自のリソースを使用してチャットボットをトレーニングできます。リソースがホストされているWebURLを設定することで、ボットがトレーニング済みコンテンツに関連するユーザーのクエリに迅速かつ正確に回答できるようになります。
Catalyst ConvoKraftサービスの詳細については、こちらのヘルプドキュメントを参照してください。
SmartTrainの有効化・無効化
このAPIは、Catalyst ConvoKraftサービスのSmartTrainを有効化または無効化します。有効化すると、ボットの応答を向上させるための学習素材を追加できます。無効化すると、ボットのトレーニング済み知識が一時的に停止され、トレーニングデータに基づくクエリに回答できなくなります。再度有効化すると、トレーニングが自動的に復元され、以前にアップロードされた素材を使用してボットが応答できるようになります。
以下のAPIを使用して、この機能をCatalystアプリケーションに導入できます。
リクエスト詳細
リクエストURL
{api-domain}/convokraft/api/v1/bots/{botid}? type=DEVELOPED
注意:
-
クエリパラメーターtype=DEVELOPEDは、ボットがConvoKraftサービス内で開発状態であることを示すために使用されます。
-
botidは、コンソールで環境がDevelopmentに設定されている場合、ConvoKraftサービスのURLから直接取得できます。
例: https://console.catalyst.zoho.com/baas/v1/project/183272829220/Development#/convokraft/bots/3828281991118
ここで、3828281991118がbotidです。
スコープ
ZIAPlatform.Convokraft.RAG.UPDATE
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: {org_id}
X-CATALYST-projectid: {project id}
X-CATALYST-Environment: Development
リクエストJSONプロパティ
RAG機能を有効にするにはtrue、無効にするにはfalseを渡します。
デフォルト: true
レスポンス詳細
レスポンスには、SmartTrainの有効化・無効化操作のステータスが、ステータスメッセージおよびステータスコードとともに返されます。
curl -X PATCH
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/convokraft/api/v1/bots/92738220219110?type=DEVELOPED
-H ‘Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57’
-H ‘Content-Type: application/json’
-H ‘CATALYST-ORG: 372822922’
-H ‘X-CATALYST-projectid: 2728172727718’
-H ‘X-CATALYST-Environment: “Development”’
--data ‘{
“bots”: {
“is_rag_enabled”: true
}
}’
{
"status": "SUCCESS",
"code": "SUCCESS",
"message": "Updated Successfully."
}
学習素材の追加
このAPIを使用すると、SmartTrainにカスタム学習素材をアップロードし、ConvoKraftボットを自動的にトレーニングさせることができます。HTMLまたはTXT形式でサードパーティプラットフォームにホストされている学習素材のWebURLを提供できます。アップロードされると、ボットはコンテンツを処理し、関連するクエリへの応答に使用します。
以下のAPIを使用して、この機能をCatalystアプリケーションに導入できます。
リクエスト詳細
リクエストURL
{api-domain}/convokraft/api/v1/bots/{botid}/rag_training_data?type=DEVELOPED
注意:
-
クエリパラメーターtype=DEVELOPEDは、ボットがConvoKraftサービス内で開発状態であることを示すために使用されます。
-
botidは、コンソールで環境がDevelopmentに設定されている場合、ConvoKraftサービスのURLから直接取得できます。
例: https://console.catalyst.zoho.com/baas/v1/project/183272829220/Development#/convokraft/bots/3828281991118
ここで、3828281991118がbotidです。
スコープ
ZIAPlatform.Convokraft.RAG.CREATE
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: {org_id}
X-CATALYST-projectid: {project id}
X-CATALYST-Environment: Development
リクエストJSONプロパティ
レスポンス詳細
このAPIは、ステータスコードとメッセージを含む学習素材のアップロードプロセスのステータスを提供します。また、アップロードされた素材のURLと、ConvoKraftが各URLに割り当てた一意のIDも返します。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/convokraft/api/v1/bots/92738220219110/rag_training_data?type=DEVELOPED
-H ‘Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57’
-H ‘Content-Type: application/json’
-H ‘CATALYST-ORG: 372822922’
-H ‘X-CATALYST-projectid: 2728172727718’
-H ‘X-CATALYST-Environment: “Development”’
--data ‘{
“rag_training_data”: [
{
“url”: “https://www.apple.com/iphone-15”,
“title”: “Iphone 15 Specifications”
},
{
“url”: “https://www.apple.com/iphone-11/”,
“title”: “Iphone 11 Specifications”
}
]
}’
{
"status": "SUCCESS",
"code": "SUCCESS",
"message": "File upload in progress",
"info": {
"files": [
{
"id": "2000000028005",
"url": "https://www.apple.com/iphone-15/"
},
{
"id": "2000000028007",
"url": "https://www.apple.com/iphone-11/"
},
]
}
}
学習素材の取得
このAPIを使用すると、特定のConvoKraftボットに関連する学習素材の詳細とメタデータを取得できます。
以下のAPIを使用して、この機能をCatalystアプリケーションに統合できます。
リクエスト詳細
リクエストURL
{api-domain}/convokraft/api/v1/bots/{botid}/rag_training_data?type=DEVELOPED
注意:
-
クエリパラメーターtype=DEVELOPEDは、ボットがConvoKraftサービス内で開発状態であることを示すために使用されます。
-
botidは、コンソールで環境がDevelopmentに設定されている場合、ConvoKraftサービスのURLから直接取得できます。
例: https://console.catalyst.zoho.com/baas/v1/project/183272829220/Development#/convokraft/bots/3828281991118
ここで、3828281991118がbotidです。
スコープ
ZIAPlatform.Convokraft.RAG.READ
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: {org_id}
X-CATALYST-projectid: {project id}
X-CATALYST-Environment: Development
レスポンス詳細
このAPIは、ConvoKraftが生成した一意のID、タイトル、URL、各学習素材のステータスを含む、ボットに関連する全学習素材の詳細とメタデータを提供します。また、ユーザーのメールアドレス、タイムゾーン、ZUID、ロール、その他の関連詳細など、素材の作成・変更に関する情報と、作成・変更のタイムスタンプも含まれます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/convokraft/api/v1/bots/92738220219110/rag_training_data?type=DEVELOPED
-H ‘Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57’
-H ‘Content-Type: application/json’
-H ‘CATALYST-ORG: 372822922’
-H ‘X-CATALYST-projectid: 2728172727718’
-H ‘X-CATALYST-Environment: “Development”’ \
{
“rag_training_data”: [
{
“id”: “67799000000085007”,
“title”: “Iphone 15 Specifications”,
“url”: “https://www.apple.com/iphone-15/”,
“source”: “URL”,
“created_by”: {
“id”: “76859507”,
“email”: “amelia.burrows@zylker.com”,
“username”: “amelia.burrows”,
“timezone”: “Asia/Calcutta”,
“nickname”: “amelia”,
“locale”: “en_IN”,
“role”: “SUPER_ADMIN”,
“zuid”: “76859507”
},
“created_time”: “1732880033148”,
“modified_by”: {
“id”: “76859507”,
“email”: “amelia.burrows@zylker.com”,
“username”: “amelia.burrows”,
“timezone”: “Asia/Calcutta”,
“nickname”: “nivetha.raja”,
“locale”: “en_IN”,
“role”: “SUPER_ADMIN”,
“zuid”: “76859507”
},
“modified_time”: “1732880389581”,
“status”: “TRAINED”
},
{
“id”: “67799000000085009”,
“title”: “Iphone 11 Specifications”,
“url”: “https://www.apple.com/iphone-11/”,
“source”: “URL”,
“created_by”: {
“id”: “76859507”,
“email”: “amelia.burrows”,
“username”: “amelia.burrows”,
“timezone”: “Asia/Calcutta”,
“nickname”: “amelia”,
“locale”: “en_IN”,
“role”: “SUPER_ADMIN”,
“zuid”: “76859507”
},
“created_time”: “1732880131250”,
“modified_by”: {
“id”: “76859507”,
“email”: “amelia.burrows@zylker.com”,
“username”: “amelia.burrows”,
“timezone”: “Asia/Calcutta”,
“nickname”: “amelia”,
“locale”: “en_IN”,
“role”: “SUPER_ADMIN”,
“zuid”: “76859507”
},
“modified_time”: “1732880131250”,
“status”: “TRAINED”
}
]
}
学習素材の削除
このAPIを使用すると、リクエストに各素材に割り当てられた一意のIDを指定して、ConvoKraftボットのSmartTrain機能にアップロードされたカスタム学習素材を削除できます。カンマ区切りでIDを渡すことで、複数の素材を一度に削除することもできます。学習素材を削除すると、ボット内のトレーニング済み知識も自動的に削除され、削除された学習素材に基づくクエリには回答できなくなりますのでご注意ください。
以下のAPIを使用して、この機能をCatalystアプリケーションに統合できます。
リクエスト詳細
リクエストURL
{api-domain}/convokraft/api/v1/bots/{botid}/rag_training_data?type=DEVELOPED
注意:
-
クエリパラメーターtype=DEVELOPEDは、ボットがConvoKraftサービス内で開発状態であることを示すために使用されます。
-
botidは、コンソールで環境がDevelopmentに設定されている場合、ConvoKraftサービスのURLから直接取得できます。
例: https://console.catalyst.zoho.com/baas/v1/project/183272829220/Development#/convokraft/bots/3828281991118
ここで、3828281991118がbotidです。
スコープ
ZIAPlatform.Convokraft.RAG.DELETE
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: {org_id}
X-CATALYST-projectid: {project id}
X-CATALYST-Environment: Development
リクエストJSONプロパティ
レスポンス詳細
このAPIは、ステータスコードとメッセージとともに削除操作のステータスを返します。
curl -X DELETE
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/convokraft/api/v1/bots/92738220219110/rag_training_data?type=DEVELOPED
-H ‘Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57’
-H ‘Content-Type: application/json’
-H ‘CATALYST-ORG: 372822922’
-H ‘X-CATALYST-projectid: 2728172727718’
-H ‘X-CATALYST-Environment: “Development”’
--data ‘{
“rag_training_data”: [
{
“id”: “67799000000084013”
}
]
}’
{
“status”: “SUCCESS”,
“code”: “SUCCESS”,
“message”: “Updated Successfully.”
}
ボットからの回答取得
このAPIを使用すると、トランスクリプトクエリを送信してConvoKraftボットから回答を取得できます。ボットは質問を理解し、トレーニングに基づいた回答を返します。
以下のAPIを使用して、この機能をCatalystアプリケーションに統合できます。
リクエスト詳細
リクエストURL
{api-domain}/convokraft/api/v1/bots/{production_botid}/answer
注意: production_botidは、コンソールで環境がProductionに設定されている場合、ConvoKraftサービスのURLから直接取得できます。
ここで、3828281991118がproduction_botidです。
スコープ
ZIAPlatform.Convokraft.RAG.CREATE
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
CATALYST-ORG: {org_id}
X-CATALYST-projectid: {project id}
X-CATALYST-Environment: Development
レスポンス詳細
このAPIは、学習素材に基づいてConvoKraftが提供する回答を、回答取得プロセスのステータスとともに返します。
curl -X POST
https://api.catalyst.zoho.com/convokraft/api/v1/bots/92738220219110/answer
-H ‘Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57’
-H ‘Content-Type: application/json’
-H ‘CATALYST-ORG: 372822922’
-H ‘X-CATALYST-projectid: 2728172727718’
-H ‘X-CATALYST-Environment: “Production”’
--data ‘{
“transcript”: {
“message”: “Explain Iphone 11 Specifications”
}
}’
{
“transcript”: {
“message”: “The iPhone 11 is a sleek and powerful smartphone from Apple, featuring a 6.1-inch Liquid Retina HD display that offers vibrant colors and sharp detail. It’s powered by the A13 Bionic chip, which ensures fast performance and smooth multitasking. Whether you’re gaming, editing photos, or using apps, the iPhone 11 can handle it with ease.
One of the standout features of the iPhone 11 is its camera system. It has a dual-camera setup, with a 12MP wide and ultra-wide lens, making it great for capturing detailed photos and videos. The Night Mode feature helps take clearer pictures in low-light environments, and it also supports 4K video recording at 60fps, allowing you to shoot high-quality videos.”,
“status”: “action_completion”
}
}
Job Scheduling API
Job Schedulingは、ジョブ送信をスケジュールし、ジョブプールで実行してCircuits、Webhook（任意のサードパーティURL）、Job Functions、およびApp SailサービスのエンドポイントをトリガーできるCatalystサービスです。
すべてのジョブプールの取得
説明
このAPIを使用すると、プロジェクトに存在するすべてのジョブプールの詳細を取得できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/job_scheduling/jobpool
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.jobpool.READ
レスポンス詳細
JSONレスポンスは、プロジェクトに存在するすべてのジョブプールのメタデータを返します。レスポンスには、ジョブプールを作成したユーザーおよび最後に変更したユーザーの詳細も含まれます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/10278000000019013/job_scheduling/jobpool
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
{
"status": "success",
"data": [
{
"type": "AppSail",
"name": "TriggerMicroservice",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:51 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:51 PM",
"capacity": {
"number": "1"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823795"
},
{
"type": "Circuit",
"name": "InventoryDataMaintaince",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:49 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:49 PM",
"capacity": {
"number": "3"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823699"
},
{
"type": "Webhook",
"name": "VendorDataFetch",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:47 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:47 PM",
"capacity": {
"number": "3"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823632"
},
{
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
}
]
}
識別子によるジョブプールの取得
説明
このAPIを使用すると、特定のジョブプールの詳細を取得できます。ジョブプールは一意のJob Pool IDまたはその名前で参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/job_scheduling/jobpool/{jobpool_identifier}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.jobpool.READ
レスポンス詳細
JSONレスポンスは、プロジェクトに存在する特定のジョブプールのメタデータを返します。レスポンスには、ジョブプールを作成したユーザーおよび最後に変更したユーザーの詳細も含まれます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/10278000000019013/job_scheduling/cron/10108000004154323
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
{
"status": "success",
"data": {
"cron_name": "pcMonthlyDay",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004154323",
"url": "",
"job_name": "j",
"job_config": {
"number_of_retries": 0
},
"target_type": "AppSail",
"target_details": {
"id": "10108000002976191",
"target_name": "appsailTrue"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004154321",
"source_name": "pcMonthlyDay",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000002976201",
"jobpool_details": {
"type": "AppSail",
"name": "appsailJP",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "Mar 28, 2024 05:41 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Mar 28, 2024 05:41 PM",
"capacity": {
"number": "5"
},
"project_details": {
"project_name": "AppsailCron",
"id": "10108000002976144",
"project_type": "Live"
},
"id": "10108000002976201"
},
"request_method": "get"
},
"cron_status": true,
"created_time": "Jun 04, 2024 04:31 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 04, 2024 04:31 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "AppsailCron",
"id": "10108000002976144",
"project_type": "Live"
},
"end_time": "1718303399",
"cron_detail": {
"hour": 4,
"minute": 4,
"second": 4,
"repetition_type": "monthly",
"days": [
1,
3,
4
],
"timezone": "Asia/Kolkata"
},
"success_count": 0,
"failure_count": 0,
"id": "10108000004154321"
}
}
IDによるWebhookジョブの送信
説明
このAPIを使用すると、Webhookエンドポイントをトリガーするジョブをジョブプールに送信できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/job_scheduling/job
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.job.CREATE
リクエストJSON
以下に示す対応する値を含むJSONを送信する必要があります。
{
"request_method": "post",
"source_type": "API",
"job_config": {
"number_of_retries": "2",
"retry_interval": 1800
},
"job_name": "webhookPost",
"jobpool_id": "10108000003823632",
"target_type": "Webhook",
"url": "https://www.zoho.com",
"headers": {
"h1": "v1"
},
"request_body": "{'key1':'val1'}"
}
このリクエストJSONをリクエストボディに設定し、以下の値を指定する必要があります：
レスポンス詳細
JSONレスポンスは、送信されたジョブのメタデータを返します。レスポンスには、ジョブを送信したユーザーの詳細も含まれます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/{project_id}/job_scheduling/job
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw $’{“request_method”:“post”,“source_type”:“API”,“job_config”:{“number_of_retries”:“2”,“retry_interval”:1800},“job_name”:“webhookPost”,“jobpool_id”:“10108000003823632”,“target_type”:“Webhook”,“url”:“https://www.zoho.com”,“headers”:{“h1”:“v1”},“request_body”:"{'key1':'val1'}"}'
{
"status": "success",
"data": {
"job_id": "10108000004194125",
"created_time": "Jun 05, 2024 04:37 PM",
"response_code": null,
"start_time": {},
"end_time": {},
"submitted_on": {
"startTimeToRedirectLogsPage": "05/06/2024 16:32",
"timeWithGivenTimezone": "Jun 05, 2024 04:37 PM IST",
"timeWithJobTimezone": "Jun 05, 2024 04:37 PM IST"
},
"job_status": "PENDING",
"capacity": {
"number": "1"
},
"job_meta_details": {
"id": "10108000004194126",
"url": "https://www.zoho.com",
"job_name": "webhookPost",
"job_config": {
"number_of_retries": 2,
"retry_interval": 1800
},
"target_type": "Webhook",
"target_details": {
"target_name": "https://www.zoho.com"
},
"source_type": "API",
"source_details": {
"source_name": "API"
},
"jobpool_id": "10108000003823632",
"jobpool_details": {
"type": "Webhook",
"name": "VendorDataFetch",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:47 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:47 PM",
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823632"
},
"headers": {
"h1": "v1"
},
"params": {},
"request_method": "post",
"request_body": "{'key1':'val1'}"
},
"retried_count": null,
"parent_job_id": "10108000004194125",
"execution_time": null
}
}
IDによるFunctionジョブの送信
説明
このAPIを使用すると、Job Functionエンドポイントをトリガーするジョブをジョブプールに送信できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/job_scheduling/job
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.job.CREATE
リクエストJSON
以下に示す対応する値を含むJSONを送信する必要があります。
{
"source_type": "API",
"job_config": {
"number_of_retries": "2",
"retry_interval": 10800
},
"job_name": "functionJob",
"jobpool_id": "10108000003823563",
"target_type": "Function",
"target_id": "10108000003823893",
"params": {
"param1": "value1"
}
}
このリクエストJSONをリクエストボディに設定し、以下の値を指定する必要があります：
レスポンス詳細
JSONレスポンスは、送信されたジョブのメタデータを返します。レスポンスには、ジョブを送信したユーザーの詳細も含まれます。
curl -X POST \ ‘https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/job
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“source_type”:“API”,“job_config”:{“number_of_retries”:“2”,“retry_interval”:10800},“job_name”:“functionJob”,“jobpool_id”:“10108000003823563”,“target_type”:“Function”,“target_id”:“10108000003823893”,“params”:{“param1”:“value1”}}’
{
"status": "success",
"data": {
"job_id": "10108000004194195",
"created_time": "Jun 05, 2024 04:51 PM",
"response_code": null,
"start_time": {},
"end_time": {},
"submitted_on": {
"startTimeToRedirectLogsPage": "05/06/2024 16:46",
"timeWithGivenTimezone": "Jun 05, 2024 04:51 PM IST",
"timeWithJobTimezone": "Jun 05, 2024 04:51 PM IST"
},
"job_status": "PENDING",
"capacity": {
"memory": "512"
},
"job_meta_details": {
"id": "10108000004194196",
"url": "",
"job_name": "functionJob",
"job_config": {
"number_of_retries": 2,
"retry_interval": 10800
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "API",
"source_details": {
"source_name": "API"
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"retried_count": null,
"parent_job_id": "10108000004194195",
"execution_time": null
}
}
IDによるCircuitジョブの送信
説明
このAPIを使用すると、Circuitのエンドポイントをトリガーするジョブをジョブプールに送信できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/job_scheduling/job
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.job.CREATE
リクエストJSON
以下に示す対応する値を含むJSONを送信する必要があります。
{
"source_type": "API",
"job_config": {
"number_of_retries": "4",
"retry_interval": 300
},
"job_name": "circuitJob",
"jobpool_id": "10108000003823699",
"target_type": "Circuit",
"target_id": "10108000004194246",
"test_cases": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
}
このリクエストJSONをリクエストボディに設定し、以下の値を指定する必要があります：
レスポンス詳細
JSONレスポンスは、送信されたジョブのメタデータを返します。レスポンスには、ジョブを送信したユーザーの詳細も含まれます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/{project_id}/job_scheduling/job
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“source_type”:“API”,“job_config”:{“number_of_retries”:“4”,“retry_interval”:300},“job_name”:“circuitJob”,“jobpool_id”:“10108000003823699”,“target_type”:“Circuit”,“target_id”:“10108000004194246”,“test_cases”:{“key1”:“value1”,“key2”:“value2”,“key3”:“value3”}}’
{
"status": "success",
"data": {
"job_id": "10108000004194251",
"created_time": "Jun 05, 2024 04:56 PM",
"response_code": null,
"start_time": {},
"end_time": {},
"submitted_on": {
"startTimeToRedirectLogsPage": "05/06/2024 16:51",
"timeWithGivenTimezone": "Jun 05, 2024 04:56 PM IST",
"timeWithJobTimezone": "Jun 05, 2024 04:56 PM IST"
},
"job_status": "PENDING",
"capacity": {
"number": "1"
},
"job_meta_details": {
"id": "10108000004194252",
"job_name": "circuitJob",
"job_config": {
"number_of_retries": 4,
"retry_interval": 300
},
"target_type": "Circuit",
"target_details": {
"id": "10108000004194246",
"target_name": "abc"
},
"source_type": "API",
"source_details": {
"source_name": "API"
},
"jobpool_id": "10108000003823699",
"jobpool_details": {
"type": "Circuit",
"name": "InventoryDataMaintaince",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:49 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:49 PM",
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823699"
},
"headers": {},
"params": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
},
"retried_count": null,
"parent_job_id": "10108000004194251",
"execution_time": null
}
}
IDによるAppSailジョブの送信
説明
このAPIを使用すると、AppSailサービスのエンドポイントをトリガーするジョブをジョブプールに送信できます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/job_scheduling/job
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.job.CREATE
リクエストJSON
以下に示す対応する値を含むJSONを送信する必要があります。
{
"request_method": "get",
"source_type": "API",
"job_config": {
"number_of_retries": "3",
"retry_interval": 300
},
"job_name": "appsailJob",
"jobpool_id": "10108000002976201",
"target_type": "AppSail",
"target_id": "10108000002976191",
"url": "",
"headers": {
"h1": "k1"
},
"params": {
"p1": "v1"
}
}
このリクエストJSONをリクエストボディに設定し、以下の値を指定する必要があります：
レスポンス詳細
JSONレスポンスは、送信されたジョブのメタデータを返します。レスポンスには、ジョブを送信したユーザーの詳細も含まれます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/{project_id}/job_scheduling/job
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“request_method”:“get”,“source_type”:“API”,“job_config”:{“number_of_retries”:“3”,“retry_interval”:300},“job_name”:“appsailJob”,“jobpool_id”:“10108000002976201”,“target_type”:“AppSail”,“target_id”:“10108000002976191”,“url”:"",“headers”:{“h1”:“k1”},“params”:{“p1”:“v1”}}’
{
"status": "success",
"data": {
"job_id": "10108000004194320",
"created_time": "Jun 05, 2024 05:02 PM",
"response_code": null,
"start_time": {},
"end_time": {},
"submitted_on": {
"startTimeToRedirectLogsPage": "05/06/2024 16:57",
"timeWithGivenTimezone": "Jun 05, 2024 05:02 PM IST",
"timeWithJobTimezone": "Jun 05, 2024 05:02 PM IST"
},
"job_status": "PENDING",
"capacity": {
"number": "1"
},
"job_meta_details": {
"id": "10108000004194321",
"url": "",
"job_name": "appsailJob",
"job_config": {
"number_of_retries": 3,
"retry_interval": 300
},
"target_type": "AppSail",
"target_details": {
"id": "10108000002976191",
"target_name": "appsailTrue"
},
"source_type": "API",
"source_details": {
"source_name": "API"
},
"jobpool_id": "10108000002976201",
"jobpool_details": {
"type": "AppSail",
"name": "appsailJP",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "Mar 28, 2024 05:41 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Mar 28, 2024 05:41 PM",
"project_details": {
"project_name": "AppsailCron",
"id": "10108000002976144",
"project_type": "Live"
},
"id": "10108000002976201"
},
"headers": {
"h1": "k1"
},
"params": {
"p1": "v1"
},
"request_method": "get"
},
"retried_count": null,
"parent_job_id": "10108000004194320",
"execution_time": null
}
}
IDによるジョブの取得
説明
このAPIを使用すると、特定のジョブの詳細を取得できます。ジョブは一意のJob IDで参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/job_scheduling/job/{job_id}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.job.READ
レスポンス詳細
JSONレスポンスは、プロジェクトに存在する特定のジョブのメタデータを返します。レスポンスには、ジョブを作成したユーザーおよび最後に変更したユーザーの詳細も含まれます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/10278000000019013/job_scheduling/job/10278000000027019
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
{
"status": "success",
"data": {
"job_id": "10108000003880208",
"created_time": "May 29, 2024 02:29 PM",
"response_code": "Success",
"start_time": {
"startTimeToRedirectLogsPage": "29/05/2024 14:24",
"timeWithGivenTimezone": "May 29, 2024 02:29 PM IST",
"timeWithJobTimezone": "May 29, 2024 02:29 PM IST"
},
"end_time": {
"timeWithGivenTimezone": "May 29, 2024 02:29 PM IST",
"timeWithJobTimezone": "May 29, 2024 02:29 PM IST",
"endTimeToRedirectLogsPage": "29/05/2024 14:34"
},
"submitted_on": {
"startTimeToRedirectLogsPage": "29/05/2024 14:24",
"timeWithGivenTimezone": "May 29, 2024 02:29 PM IST",
"timeWithJobTimezone": "May 29, 2024 02:29 PM IST"
},
"job_status": "SUCCESS",
"capacity": {
"memory": "256"
},
"job_meta_details": {
"id": "10108000003880209",
"url": "",
"job_name": "abc",
"job_config": {
"number_of_retries": 0
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "API",
"source_details": {
"source_name": "API"
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {}
},
"retried_count": 0,
"parent_job_id": "10108000003880208",
"execution_time": "633",
"status": false,
"dispatch_delay": "103"
}
}
Cron式を使用したCronの作成
説明
このAPIを使用すると、スケジュールされた時間にジョブをジョブプールに送信し、Job FunctionエンドポイントをトリガーするCron式を使用して定義された繰り返しタイプのcronを作成できます。
注意:
-
このAPIでは、Job Functionを使用したリクエスト例とレスポンス例を示しています。APIの機能はwebhook、Circuits、およびAppSailジョブでも同じです。
リクエスト詳細
リクエストURL
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cron.CREATE
リクエストJSON
以下に示す対応する値を含むJSONを送信する必要があります。
{
"cron_type": "CronExpression",
"cron_status": true,
"cron_expression": "* * * * *",
"job_detail": {
"timezone": "PST"
},
"job_meta": {
"source_type": "Cron",
"job_config": {
"number_of_retries": "1",
"retry_interval": "500"
},
"job_name": "jobName",
"jobpool_id": "10108000003823563",
"target_type": "Function",
"target_id": "10108000003823893",
"params": {
"param1": "value1"
}
},
"cron_name": "cronExp",
"description": "cronexpression",
"end_time": 1717916399,
"cron_execution_type": "pre-defined"
}
このリクエストJSONをリクエストボディに設定し、以下の値を指定する必要があります：
レスポンス詳細
JSONレスポンスは作成されたcronのメタデータを返します。レスポンスにはcronを作成したユーザーの詳細も含まれます。
curl -X POST \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_type”:“CronExpression”,“cron_status”:true,“cron_expression”:"* * * * *",“job_detail”:{“timezone”:“PST”},“job_meta”:{“source_type”:“Cron”,“job_config”:{“number_of_retries”:“1”,“retry_interval”:“500”},“job_name”:“jobName”,“jobpool_id”:“10108000003823563”,“target_type”:“Function”,“target_id”:“10108000003823893”,“params”:{“param1”:“value1”}},“cron_name”:“cronExp”,“description”:“cronexpression”,“end_time”:1717916399,“cron_execution_type”:“pre-defined”}’
{
"status": "success",
"data": {
"cron_name": "cronExp",
"description": "cronexpression",
"cron_type": "CronExpression",
"cron_execution_type": "pre-defined",
"cron_expression": "* * * * *",
"job_meta": {
"id": "10108000004280709",
"url": "",
"job_name": "jobName",
"job_config": {
"number_of_retries": 1,
"retry_interval": 500
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280707",
"source_name": "cronExp",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"created_time": "Jun 07, 2024 12:51 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 07, 2024 12:51 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1717916399",
"cron_detail": {
"jobId": "10108000004280707",
"transactionTimeout": -1,
"hour": 0,
"minute": 0,
"second": 0,
"timezone": "PST"
},
"id": "10108000004280707"
}
}
IDによるジョブの削除
説明
このAPIを使用すると、ジョブプールに存在するジョブを削除できます。ジョブはjob_idで参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/job_scheduling/job/{job_id}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.job.DELETE
レスポンス詳細
JSONレスポンスは、削除されたジョブのメタデータを返します。レスポンスには、ジョブを削除したユーザーの詳細も含まれます。
curl -X DELETE
https://api.catalyst.zoho.com/baas/v1/project/10278000000019013/job_scheduling/job/10278000000027019
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
{
"status": "success",
"data": {
"job_id": "10278000000027019",
"created_time": "May 29, 2024 02:29 PM",
"response_code": "Success",
"start_time": {
"startTimeToRedirectLogsPage": "29/05/2024 14:24",
"timeWithGivenTimezone": "May 29, 2024 02:29 PM IST",
"timeWithJobTimezone": "May 29, 2024 02:29 PM IST"
},
"end_time": {
"timeWithGivenTimezone": "May 29, 2024 02:29 PM IST",
"timeWithJobTimezone": "May 29, 2024 02:29 PM IST",
"endTimeToRedirectLogsPage": "29/05/2024 14:34"
},
"submitted_on": {
"startTimeToRedirectLogsPage": "29/05/2024 14:24",
"timeWithGivenTimezone": "May 29, 2024 02:29 PM IST",
"timeWithJobTimezone": "May 29, 2024 02:29 PM IST"
},
"job_status": "SUCCESS",
"capacity": {
"memory": "256"
},
"job_meta_details": {
"id": "10278000000027019",
"url": "",
"job_name": "abc",
"job_config": {
"number_of_retries": 0
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "API",
"source_details": {
"source_name": "API"
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {}
},
"retried_count": 0,
"parent_job_id": "10108000003880208",
"execution_time": "633",
"status": false,
"dispatch_delay": "103"
}
}
識別子によるCronの取得
説明
このAPIを使用すると、プロジェクトに存在するcronの利用可能なすべての詳細を取得できます。cronはIDや名前などの一意の識別子で参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/job_scheduling/cron/{cron_id/cron_name}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cron.READ
レスポンス詳細
JSONレスポンスは、プロジェクトに存在する特定のcronのメタデータを返します。レスポンスには、cronを作成および最後に変更したユーザーの詳細も含まれます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/10278000000019013/job_scheduling/cron/10108000004154323
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
{
"status": "success",
"data": {
"cron_name": "pcMonthlyDay",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004154323",
"url": "",
"job_name": "j",
"job_config": {
"number_of_retries": 0
},
"target_type": "AppSail",
"target_details": {
"id": "10108000002976191",
"target_name": "appsailTrue"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004154321",
"source_name": "pcMonthlyDay",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000002976201",
"jobpool_details": {
"type": "AppSail",
"name": "appsailJP",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "Mar 28, 2024 05:41 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Mar 28, 2024 05:41 PM",
"capacity": {
"number": "5"
},
"project_details": {
"project_name": "AppsailCron",
"id": "10108000002976144",
"project_type": "Live"
},
"id": "10108000002976201"
},
"request_method": "get"
},
"cron_status": true,
"created_time": "Jun 04, 2024 04:31 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 04, 2024 04:31 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "AppsailCron",
"id": "10108000002976144",
"project_type": "Live"
},
"end_time": "1718303399",
"cron_detail": {
"hour": 4,
"minute": 4,
"second": 4,
"repetition_type": "monthly",
"days": [
1,
3,
4
],
"timezone": "Asia/Kolkata"
},
"success_count": 0,
"failure_count": 0,
"id": "10108000004154321"
}
}
すべてのCronの取得
説明
このAPIを使用すると、プロジェクトに存在するすべての事前定義cronの詳細を取得できます。
リクエスト詳細
リクエストURL
{app_domain}/baas/v1/project/{project_id}/job_scheduling/cron
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cron.READ
レスポンス詳細
JSONレスポンスは、プロジェクトに存在するすべてのcronのメタデータを返します。レスポンスには、cronを作成および最後に変更したユーザーの詳細も含まれます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/10278000000019013/job_scheduling/cron
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
{
"status": "success",
"data": [
{
"cron_name": "circuitCron",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280089",
"job_name": "j",
"job_config": {
"number_of_retries": 0
},
"target_type": "Circuit",
"target_details": {
"id": "10108000004194246",
"target_name": "abc"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280087",
"source_name": "circuitCron",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823699",
"jobpool_details": {
"type": "Circuit",
"name": "InventoryDataMaintaince",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:49 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:49 PM",
"capacity": {
"number": "3"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823699"
},
"headers": {},
"params": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
},
"cron_status": true,
"created_time": "Jun 07, 2024 11:09 AM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 07, 2024 11:09 AM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1717871399",
"cron_detail": {
"hour": 4,
"minute": 3,
"second": 0,
"repetition_type": "daily",
"timezone": "Asia/Kolkata"
},
"success_count": 0,
"failure_count": 0,
"id": "10108000004280087"
},
{
"cron_name": "functionCron",
"description": "functionCron",
"cron_type": "CronExpression",
"cron_execution_type": "pre-defined",
"cron_expression": "* * * * *",
"job_meta": {
"id": "10108000004280074",
"url": "",
"job_name": "functionJob",
"job_config": {
"number_of_retries": 0
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280072",
"source_name": "functionCron",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"p1": "v1"
}
},
"cron_status": true,
"created_time": "Jun 07, 2024 11:08 AM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 07, 2024 11:08 AM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1718908199",
"cron_detail": {
"hour": 0,
"minute": 0,
"second": 0,
"timezone": "Asia/Kolkata"
},
"success_count": 0,
"failure_count": 0,
"id": "10108000004280072"
},
{
"cron_name": "abcUpdated",
"cron_type": "OneTime",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004153012",
"url": "https://www.google.com",
"job_name": "j",
"job_config": {
"number_of_retries": 0
},
"target_type": "Webhook",
"target_details": {
"target_name": "https://www.google.com"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004152971",
"source_name": "abcUpdated",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823632",
"jobpool_details": {
"type": "Webhook",
"name": "VendorDataFetch",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:47 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:47 PM",
"capacity": {
"number": "3"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823632"
},
"request_method": "get"
},
"cron_status": false,
"created_time": "Jun 04, 2024 03:56 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 04, 2024 03:57 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "-1",
"cron_detail": {
"time_of_execution": 1717612200,
"hour": 0,
"minute": 0,
"second": 0,
"timezone": "Asia/Kolkata"
},
"success_count": 0,
"failure_count": 0,
"id": "10108000004152971"
},
{
"cron_name": "abcupdate",
"description": "abc",
"cron_type": "OneTime",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004108000",
"url": "https://www.google.com",
"job_name": "j",
"job_config": {
"number_of_retries": 0
},
"target_type": "Webhook",
"target_details": {
"target_name": "https://www.google.com"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004107959",
"source_name": "abcupdate",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823632",
"jobpool_details": {
"type": "Webhook",
"name": "VendorDataFetch",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:47 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:47 PM",
"capacity": {
"number": "3"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823632"
},
"headers": {},
"params": {},
"request_method": "get"
},
"cron_status": false,
"created_time": "Jun 03, 2024 05:19 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 03, 2024 05:20 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "-1",
"cron_detail": {
"time_of_execution": 1717623183,
"hour": 0,
"minute": 0,
"second": 0,
"timezone": "Asia/Kolkata"
},
"success_count": 0,
"failure_count": 0,
"id": "10108000004107959"
}
]
}
ワンタイムCronの作成
説明
このAPIを使用すると、ジョブプールにジョブを送信してジョブFunctionエンドポイントをトリガーするワンタイムcronを作成できます。
注意:
-
このAPIでは、ジョブFunctionを使用したサンプルリクエストとサンプルレスポンスを示しています。APIの機能は、webhook、Circuit、およびAppSailのジョブでも同様です。
リクエスト詳細
リクエストURL
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cron.CREATE
リクエストJSON
以下に示す対応する値を含むJSONを送信する必要があります。
{
"cron_type": "OneTime",
"cron_status": true,
"job_detail": {
"time_of_execution": 1717916399,
"timezone": "PST"
},
"job_meta": {
"source_type": "Cron",
"job_config": {
"number_of_retries": "1",
"retry_interval": "60"
},
"job_name": "jobName",
"jobpool_id": "10108000003823563",
"target_type": "Function",
"target_id": "10108000003823893",
"params": {
"param1": "value1"
}
},
"cron_name": "oneTimeCronFn",
"cron_execution_type": "pre-defined"
}
このリクエストJSONをリクエストボディに設定し、以下の値を指定する必要があります：
レスポンス詳細
JSONレスポンスは、作成されたcronのメタデータを返します。レスポンスには、cronを作成したユーザーの詳細も含まれます。
curl -X POST \ ‘https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_type”:“OneTime”,“cron_status”:true,“job_detail”:{“time_of_execution”:1717916399,“timezone”:“PST”},“job_meta”:{“source_type”:“Cron”,“job_config”:{“number_of_retries”:“1”,“retry_interval”:“60”},“job_name”:“jobName”,“jobpool_id”:“10108000003823563”,“target_type”:“Function”,“target_id”:“10108000003823893” ,“params”:{“param1”:“value1”}},“cron_name”:“oneTimeCronFn”,“cron_execution_type”:“pre-defined”}’
{
"status": "success",
"data": {
"cron_name": "oneTimeCronFn",
"cron_type": "OneTime",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280446",
"url": "",
"job_name": "jobName",
"job_config": {
"number_of_retries": 1,
"retry_interval": 60
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280444",
"source_name": "oneTimeCronFn",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"created_time": "Jun 07, 2024 12:26 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 07, 2024 12:26 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "-1",
"cron_detail": {
"jobId": "10108000004280444",
"transactionTimeout": -1,
"time_of_execution": 1717916399,
"hour": 0,
"minute": 0,
"second": 0,
"timezone": "PST"
},
"id": "10108000004280444"
}
}
Every Cronの作成
説明
このAPIを使用すると、スケジュールされた時間にジョブプールにジョブを送信してジョブFunctionエンドポイントをトリガーする繰り返しタイプのEvery cronを作成できます。
注意:
-
このAPIでは、ジョブFunctionを使用したサンプルリクエストとサンプルレスポンスを示しています。APIの機能は、webhook、Circuit、およびAppSailのジョブでも同様です。
リクエスト詳細
リクエストURL
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cron.CREATE
リクエストJSON
以下に示す対応する値を含むJSONを送信する必要があります。
{
"cron_type": "Periodic",
"cron_status": true,
"job_detail": {
"repetition_type": "every",
"hour": "6",
"minute": "0",
"second": "0"
},
"job_meta": {
"source_type": "Cron",
"job_config": {
"number_of_retries": "3",
"retry_interval": "60"
},
"job_name": "jobName",
"jobpool_id": "10108000003823563",
"target_type": "Function",
"target_id": "10108000003823893",
"params": {
"param1": "value1"
}
},
"end_time": 1717957799,
"cron_name": "RecursiveCron",
"cron_execution_type": "pre-defined"
}
このリクエストJSONをリクエストボディに設定し、以下の値を指定する必要があります：
レスポンス詳細
JSONレスポンスは、作成されたcronのメタデータを返します。レスポンスには、cronを作成したユーザーの詳細も含まれます。
curl -X POST \ ‘https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_type”:“Periodic”,“cron_status”:true,“job_detail”:{“repetition_type”:“every”,“hour”:“6”,“minute”:“0”,“second”:“0”},“job_meta”:{“source_type”:“Cron”,“job_config”:{“number_of_retries”:“3”,“retry_interval”:“60”},“job_name”:“jobName”,“jobpool_id”:“10108000003823563”,“target_type”:“Function”,“target_id”:“10108000003823893”,“params”:{“param1”:“value1”}},“end_time”:1717957799,“cron_name”:“RecursiveCron”,“cron_execution_type”:“pre-defined”}’
{
"status": "success",
"data": {
"cron_name": "RecursiveCron",
"cron_type": "Periodic",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280482",
"url": "",
"job_name": "jobName",
"job_config": {
"number_of_retries": 3,
"retry_interval": 60
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280480",
"source_name": "RecursiveCron",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"created_time": "Jun 07, 2024 12:31 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 07, 2024 12:31 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1717957799",
"cron_detail": {
"jobId": "10108000004280480",
"transactionTimeout": -1,
"hour": 6,
"minute": 0,
"second": 0,
"repetition_type": "every",
"timezone": "Asia/Kolkata"
},
"id": "10108000004280480"
}
}
デイリーCronの作成
説明
このAPIを使用すると、スケジュールされた時間にジョブプールにジョブを送信し、Job Functionエンドポイントをトリガーする繰り返しタイプのデイリーcronを作成できます。
注意:
-
このAPIでは、Job Functionを使用したリクエスト例とレスポンス例を示しています。APIの機能はwebhook、Circuits、およびAppSailジョブでも同じです。
リクエスト詳細
リクエストURL
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cron.CREATE
リクエストJSON
以下に示す対応する値を含むJSONを送信する必要があります。
{
"cron_type": "Calendar",
"cron_status": true,
"job_detail": {
"repetition_type": "daily",
"hour": "1",
"minute": "0",
"second": "0",
"timezone": "PST"
},
"job_meta": {
"source_type": "Cron",
"job_config": {
"number_of_retries": "1",
"retry_interval": "300"
},
"job_name": "job",
"jobpool_id": "10108000003823563",
"target_type": "Function",
"target_id": "10108000003823893",
"params": {
"param1": "value1"
}
},
"cron_name": "RecursiveCronDaily",
"end_time": 1718002799,
"description": "dailycron",
"cron_execution_type": "pre-defined"
}
このリクエストJSONをリクエストボディに設定し、以下の値を指定する必要があります：
レスポンス詳細
JSONレスポンスは作成されたcronのメタデータを返します。レスポンスにはcronを作成したユーザーの詳細も含まれます。
curl -X POST \ ‘https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_type”:“Calendar”,“cron_status”:true,“job_detail”:{“repetition_type”:“daily”,“hour”:“1”,“minute”:“0”,“second”:“0”,“timezone”:“PST”},“job_meta”:{“source_type”:“Cron”,“job_config”:{“number_of_retries”:“1”,“retry_interval”:“300”},“job_name”:“job”,“jobpool_id”:“10108000003823563”,“target_type”:“Function”,“target_id”:“10108000003823893”,“params”:{“param1”:“value1”}},“cron_name”:“RecursiveCronDaily”,“end_time”:1718002799,“description”:“dailycron”,“cron_execution_type”:“pre-defined”}’
{
"status": "success",
"data": {
"cron_name": "RecursiveCronDaily",
"description": "dailycron",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280518",
"url": "",
"job_name": "job",
"job_config": {
"number_of_retries": 1,
"retry_interval": 300
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280516",
"source_name": "RecursiveCronDaily",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"created_time": "Jun 07, 2024 12:33 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 07, 2024 12:33 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1718002799",
"cron_detail": {
"jobId": "10108000004280516",
"transactionTimeout": -1,
"hour": 1,
"minute": 0,
"second": 0,
"repetition_type": "daily",
"timezone": "PST"
},
"id": "10108000004280516"
}
}
マンスリーCronの作成（日付タイプ）
説明
このAPIを使用すると、スケジュールされた時間にジョブをジョブプールに送信し、Job Functionエンドポイントをトリガーする繰り返しタイプのマンスリーcron（カレンダー日付を使用して定義）を作成できます。
注意:
-
このAPIでは、Job Functionを使用したリクエスト例とレスポンス例を示しています。APIの機能はwebhook、Circuits、およびAppSailジョブでも同じです。
リクエスト詳細
リクエストURL
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cron.CREATE
リクエストJSON
以下に示す対応する値を含むJSONを送信する必要があります。
{
"cron_type": "Calendar",
"cron_status": true,
"job_detail": {
"repetition_type": "monthly",
"days": [
"1",
"3",
"8"
],
"hour": "3",
"minute": "0",
"second": "0",
"timezone": "PST"
},
"job_meta": {
"source_type": "Cron",
"job_config": {
"number_of_retries": "2",
"retry_interval": "500"
},
"job_name": "jobName",
"jobpool_id": "10108000003823563",
"target_type": "Function",
"target_id": "10108000003823893",
"params": {
"param1": "value1"
}
},
"cron_name": "recurCronMonthly",
"end_time": 1718002799,
"description": "monthly",
"cron_execution_type": "pre-defined"
}
このリクエストJSONをリクエストボディに設定し、以下の値を指定する必要があります：
レスポンス詳細
JSONレスポンスは作成されたcronのメタデータを返します。レスポンスにはcronを作成したユーザーの詳細も含まれます。
curl -X POST \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_type”:“Calendar”,“cron_status”:true,“job_detail”:{“repetition_type”:“monthly”,“days”:[“1”,“3”,“8”],“hour”:“3”,“minute”:“0”,“second”:“0”,“timezone”:“PST”},“job_meta”:{“source_type”:“Cron”,“job_config”:{“number_of_retries”:“2”,“retry_interval”:“500”},“job_name”:“jobName”,“jobpool_id”:“10108000003823563”,“target_type”:“Function”,“target_id”:“10108000003823893”,“params”:{“param1”:“value1”}},“cron_name”:“recurCronMonthly”,“end_time”:1718002799,“description”:“monthly”,“cron_execution_type”:“pre-defined”}’
{
"status": "success",
"data": {
"cron_name": "recurCronMonthly",
"description": "monthly",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280537",
"url": "",
"job_name": "jobName",
"job_config": {
"number_of_retries": 2,
"retry_interval": 500
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280535",
"source_name": "recurCronMonthly",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"created_time": "Jun 07, 2024 12:35 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 07, 2024 12:35 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1718002799",
"cron_detail": {
"jobId": "10108000004280535",
"transactionTimeout": -1,
"hour": 3,
"minute": 0,
"second": 0,
"repetition_type": "monthly",
"days": [
1,
3,
8
],
"timezone": "PST"
},
"id": "10108000004280535"
}
}
マンスリーCronの作成（週タイプ）
説明
このAPIを使用すると、スケジュールされた時間にジョブをジョブプールに送信し、Job Functionエンドポイントをトリガーする繰り返しタイプのマンスリーcron（月内の週を使用して定義）を作成できます。
注意:
-
このAPIでは、Job Functionを使用したリクエスト例とレスポンス例を示しています。APIの機能はwebhook、Circuits、およびAppSailジョブでも同じです。
リクエスト詳細
リクエストURL
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cron.CREATE
リクエストJSON
以下に示す対応する値を含むJSONを送信する必要があります。
{
"cron_type": "Calendar",
"cron_status": true,
"job_detail": {
"repetition_type": "monthly",
"weeks_of_month": [
"1",
"2",
"3"
],
"week_day": [
"1"
],
"hour": "0",
"minute": "0",
"second": "0",
"timezone": "PST"
},
"job_meta": {
"source_type": "Cron",
"job_config": {
"number_of_retries": "2",
"retry_interval": "600"
},
"job_name": "job",
"jobpool_id": "10108000003823563",
"target_type": "Function",
"target_id": "10108000003823893",
"params": {
"param1": "value1"
}
},
"cron_name": "recurCronMonthlyWeek",
"description": "week",
"end_time": 1718607599,
"cron_execution_type": "pre-defined"
}
このリクエストJSONをリクエストボディに設定し、以下の値を指定する必要があります：
レスポンス詳細
JSONレスポンスは作成されたcronのメタデータを返します。レスポンスにはcronを作成したユーザーの詳細も含まれます。
curl -X POST \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_type”:“Calendar”,“cron_status”:true,“job_detail”:{“repetition_type”:“monthly”,“weeks_of_month”:[“1”,“2”,“3”],“week_day”:[“1”],“hour”:“0”,“minute”:“0”,“second”:“0”,“timezone”:“PST”},“job_meta”:{“source_type”:“Cron”,“job_config”:{“number_of_retries”:“2”,“retry_interval”:“600”},“job_name”:“job”,“jobpool_id”:“10108000003823563”,“target_type”:“Function”,“target_id”:“10108000003823893”,“params”:{“param1”:“value1”}},“cron_name”:“recurCronMonthlyWeek”,“description”:“week”,“end_time”:1718607599,“cron_execution_type”:“pre-defined”}’
{
"status": "success",
"data": {
"cron_name": "recurCronMonthlyWeek",
"description": "week",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280565",
"url": "",
"job_name": "job",
"job_config": {
"number_of_retries": 2,
"retry_interval": 600
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280563",
"source_name": "recurCronMonthlyWeek",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"created_time": "Jun 07, 2024 12:37 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 07, 2024 12:37 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1718607599",
"cron_detail": {
"jobId": "10108000004280563",
"transactionTimeout": -1,
"hour": 0,
"minute": 0,
"second": 0,
"repetition_type": "monthly",
"weeks_of_month": [
1,
2,
3
],
"week_day": [
1
],
"timezone": "PST"
},
"id": "10108000004280563"
}
}
年次Cronの作成（日付タイプ）
説明
このAPIを使用すると、スケジュールされた時間にジョブをジョブプールに送信し、Job Functionエンドポイントをトリガーする繰り返しタイプの年次cron（カレンダー日付を使用して定義）を作成できます。
注意:
-
このAPIでは、Job Functionを使用したリクエスト例とレスポンス例を示しています。APIの機能はwebhook、Circuits、およびAppSailジョブでも同じです。
リクエスト詳細
リクエストURL
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cron.CREATE
リクエストJSON
以下に示す対応する値を含むJSONを送信する必要があります。
{
"cron_type": "Calendar",
"cron_status": true,
"job_detail": {
"repetition_type": "yearly",
"months": [
"0",
"1"
],
"days": [
"1",
"2",
"3",
"6",
"8"
],
"hour": "0",
"minute": "0",
"second": "0",
"timezone": "PST"
},
"job_meta": {
"source_type": "Cron",
"job_config": {
"number_of_retries": "1",
"retry_interval": "500"
},
"job_name": "jobName",
"jobpool_id": "10108000003823563",
"target_type": "Function",
"target_id": "10108000003823893",
"params": {
"param1": "value1"
}
},
"cron_name": "recurCronYearlyday",
"description": "yearlyday",
"end_time": 1719125999,
"cron_execution_type": "pre-defined"
}
このリクエストJSONをリクエストボディに設定し、以下の値を指定する必要があります：
レスポンス詳細
JSONレスポンスは作成されたcronのメタデータを返します。レスポンスにはcronを作成したユーザーの詳細も含まれます。
curl -X POST \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_type”:“Calendar”,“cron_status”:true,“job_detail”:{“repetition_type”:“yearly”,“months”:[“0”,“1”],“days”:[“1”,“2”,“3”,“6”,“8”],“hour”:“0”,“minute”:“0”,“second”:“0”,“timezone”:“PST”},“job_meta”:{“source_type”:“Cron”,“job_config”:{“number_of_retries”:“1”,“retry_interval”:“500”},“job_name”:“jobName”,“jobpool_id”:“10108000003823563”,“target_type”:“Function”,“target_id”:“10108000003823893”,“params”:{“param1”:“value1”}},“cron_name”:“recurCronYearlyday”,“description”:“yearlyday”,“end_time”:1719125999,“cron_execution_type”:“pre-defined”}’
{
"status": "success",
"data": {
"cron_name": "recurCronYearlyday",
"description": "yearlyday",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280594",
"url": "",
"job_name": "jobName",
"job_config": {
"number_of_retries": 1,
"retry_interval": 500
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280592",
"source_name": "recurCronYearlyday",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"created_time": "Jun 07, 2024 12:39 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 07, 2024 12:39 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1719125999",
"cron_detail": {
"jobId": "10108000004280592",
"transactionTimeout": -1,
"hour": 0,
"minute": 0,
"second": 0,
"repetition_type": "yearly",
"days": [
1,
2,
3,
6,
8
],
"months": [
0,
1
],
"timezone": "PST"
},
"id": "10108000004280592"
}
}
年次Cronの作成（週タイプ）
説明
このAPIを使用すると、スケジュールされた時間にジョブをジョブプールに送信し、Job Functionエンドポイントをトリガーする繰り返しタイプの年次cron（カレンダー週を使用して定義）を作成できます。
注意:
-
このAPIでは、Job Functionを使用したリクエスト例とレスポンス例を示しています。APIの機能はwebhook、Circuits、およびAppSailジョブでも同じです。
リクエスト詳細
リクエストURL
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cron.CREATE
リクエストJSON
以下に示す対応する値を含むJSONを送信する必要があります。
{
"cron_type": "Calendar",
"cron_status": true,
"job_detail": {
"repetition_type": "yearly",
"months": [
"0",
"1",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11"
],
"weeks_of_month": [
"1",
"3",
"5"
],
"week_day": [
"1"
],
"hour": "0",
"minute": "0",
"second": "0",
"timezone": "PST"
},
"job_meta": {
"source_type": "Cron",
"job_config": {
"number_of_retries": "2",
"retry_interval": "1000"
},
"job_name": "jobName",
"jobpool_id": "10108000003823563",
"target_type": "Function",
"target_id": "10108000003823893",
"params": {
"param1": "value1"
}
},
"cron_name": "recurCronYearlyWeek",
"description": "abc",
"end_time": 1719212399,
"cron_execution_type": "pre-defined"
}
このリクエストJSONをリクエストボディに設定し、以下の値を指定する必要があります：
レスポンス詳細
JSONレスポンスは作成されたcronのメタデータを返します。レスポンスにはcronを作成したユーザーの詳細も含まれます。
curl -X POST \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_type”:“Calendar”,“cron_status”:true,“job_detail”:{“repetition_type”:“yearly”,“months”:[“0”,“1”,“2”,“3”,“4”,“5”,“6”,“7”,“8”,“9”,“10”,“11”],“weeks_of_month”:[“1”,“3”,“5”],“week_day”:[“1”],“hour”:“0”,“minute”:“0”,“second”:“0”,“timezone”:“PST”},“job_meta”:{“source_type”:“Cron”,“job_config”:{“number_of_retries”:“2”,“retry_interval”:“1000”},“job_name”:“jobName”,“jobpool_id”:“10108000003823563”,“target_type”:“Function”,“target_id”:“10108000003823893”,“params”:{“param1”:“value1”}},“cron_name”:“recurCronYearlyWeek”,“description”:“abc”,“end_time”:1719212399,“cron_execution_type”:“pre-defined”}’
{
"status": "success",
"data": {
"cron_name": "recurCronYearlyWeek",
"description": "abc",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280663",
"url": "",
"job_name": "jobName",
"job_config": {
"number_of_retries": 2,
"retry_interval": 1000
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280661",
"source_name": "recurCronYearlyWeek",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"created_time": "Jun 07, 2024 12:45 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 07, 2024 12:45 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1719212399",
"cron_detail": {
"jobId": "10108000004280661",
"transactionTimeout": -1,
"hour": 0,
"minute": 0,
"second": 0,
"repetition_type": "yearly",
"months": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
],
"weeks_of_month": [
1,
3,
5
],
"week_day": [
1
],
"timezone": "PST"
},
"id": "10108000004280661"
}
}
ワンタイムCronの更新
説明
このAPIを使用すると、プロジェクト内のワンタイムcronを更新できます。更新するcronは、名前やIDなどの一意の識別子を使用して参照されます。
注意:
-
このAPIでは、Job Functionを使用したリクエスト例とレスポンス例を示しています。APIの機能はwebhook、Circuits、およびAppSailジョブでも同じです。
リクエスト詳細
リクエストURL
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron/{cron_identifier (name/ID)}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cron.UPDATE
リクエストJSON
以下に示す対応する値を含むJSONを送信する必要があります。
{
"cron_name": "oneTimeCronFn",
"cron_type": "OneTime",
"cron_status": true,
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280446",
"job_name": "jobName",
"job_config": {
"number_of_retries": 1,
"retry_interval": 60
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280444",
"source_name": "oneTimeCronFn",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"params": {
"param1": "value1"
},
"target_id": "10108000003823893"
},
"job_detail": {
"time_of_execution": 1718002799,
"timezone": "PST"
},
"id": "10108000004280444"
}
このリクエストJSONをリクエストボディに設定し、以下の値を指定する必要があります：
レスポンス詳細
JSONレスポンスは更新されたcronのメタデータを返します。レスポンスにはcronを更新したユーザーの詳細も含まれます。
curl -X PUT \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron/10108000004280444
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_name”:“oneTimeCronFn”,“cron_type”:“OneTime”,“cron_status”:true,“cron_execution_type”:“pre-defined”,“job_meta”:{“id”:“10108000004280446”,“job_name”:“jobName”,“job_config”:{“number_of_retries”:1,“retry_interval”:60},“target_type”:“Function”,“target_details”:{“id”:“10108000003823893”,“target_name”:“target_function_fetch”},“source_type”:“Cron”,“source_details”:{“id”:“10108000004280444”,“source_name”:“oneTimeCronFn”,“details”:{“cron_execution_type”:“pre-defined”}},“jobpool_id”:“10108000003823563”,“jobpool_details”:{“type”:“Function”,“name”:“VendorReminder”,“created_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“created_time”:“May 28, 2024 04:44 PM”,“modified_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“modified_time”:“May 28, 2024 04:44 PM”,“capacity”:{“memory”:“2048”},“project_details”:{“project_name”:“ZylkerShipments”,“id”:“10108000003823392”,“project_type”:“Live”},“id”:“10108000003823563”},“params”:{“param1”:“value1”},“target_id”:“10108000003823893”},“job_detail”:{“time_of_execution”:1718002799,“timezone”:“PST”},“id”:“10108000004280444”}’
{
"status": "success",
"data": {
"cron_name": "oneTimeCronFn",
"cron_type": "OneTime",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280726",
"url": "",
"job_name": "jobName",
"job_config": {
"number_of_retries": 1,
"retry_interval": 60
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280444",
"source_name": "oneTimeCronFn",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"modified_time": "Jun 07, 2024 12:53 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "-1",
"cron_detail": {
"jobId": "10108000004280444",
"transactionTimeout": -1,
"time_of_execution": 1718002799,
"hour": 0,
"minute": 0,
"second": 0,
"timezone": "PST"
},
"id": "10108000004280444"
}
}
Every Cronの更新
説明
このAPIを使用すると、プロジェクト内の繰り返しタイプのEvery cronを更新できます。更新するcronは、名前やIDなどの一意の識別子を使用して参照されます。
注意:
-
このAPIでは、Job Functionを使用したリクエスト例とレスポンス例を示しています。APIの機能はwebhook、Circuits、およびAppSailジョブでも同じです。
リクエスト詳細
リクエストURL
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron/{cron_identifier (name/ID)}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cron.UPDATE
リクエストJSON
以下に示す対応する値を含むJSONを送信する必要があります。
{
"cron_name": "RecursiveCronEvery",
"cron_type": "Periodic",
"cron_status": true,
"end_time": 1717957799,
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280482",
"job_name": "jobName",
"job_config": {
"number_of_retries": 3,
"retry_interval": 60
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280480",
"source_name": "RecursiveCron",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"params": {
"param1": "value1"
},
"target_id": "10108000003823893"
},
"job_detail": {
"hour": 6,
"minute": 0,
"second": 0,
"repetition_type": "every"
},
"id": "10108000004280480"
}
このリクエストJSONをリクエストボディに設定し、以下の値を指定する必要があります：
レスポンス詳細
JSONレスポンスは更新されたcronのメタデータを返します。レスポンスにはcronを更新したユーザーの詳細も含まれます。
curl -X PUT \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron/10108000004280480
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_name”:“RecursiveCronEvery”,“cron_type”:“Periodic”,“cron_status”:true,“end_time”:1717957799,“cron_execution_type”:“pre-defined”,“job_meta”:{“id”:“10108000004280482”,“job_name”:“jobName”,“job_config”:{“number_of_retries”:3,“retry_interval”:60},“target_type”:“Function”,“target_details”:{“id”:“10108000003823893”,“target_name”:“target_function_fetch”},“source_type”:“Cron”,“source_details”:{“id”:“10108000004280480”,“source_name”:“RecursiveCron”,“details”:{“cron_execution_type”:“pre-defined”}},“jobpool_id”:“10108000003823563”,“jobpool_details”:{“type”:“Function”,“name”:“VendorReminder”,“created_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“created_time”:“May 28, 2024 04:44 PM”,“modified_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“modified_time”:“May 28, 2024 04:44 PM”,“capacity”:{“memory”:“2048”},“project_details”:{“project_name”:“ZylkerShipments”,“id”:“10108000003823392”,“project_type”:“Live”},“id”:“10108000003823563”},“params”:{“param1”:“value1”},“target_id”:“10108000003823893”},“job_detail”:{“hour”:6,“minute”:0,“second”:0,“repetition_type”:“every”},“id”:“10108000004280480”}’
{
"status": "success",
"data": {
"cron_name": "RecursiveCronEvery",
"cron_type": "Periodic",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280762",
"url": "",
"job_name": "jobName",
"job_config": {
"number_of_retries": 3,
"retry_interval": 60
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280480",
"source_name": "RecursiveCronEvery",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"modified_time": "Jun 07, 2024 12:56 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1717957799",
"cron_detail": {
"hour": 6,
"minute": 0,
"second": 0,
"repetition_type": "every",
"timezone": "Asia/Kolkata"
},
"id": "10108000004280480"
}
}
デイリーCronの更新
説明
このAPIを使用すると、プロジェクト内のデイリーcronを更新できます。更新するcronは、名前やIDなどの一意の識別子を使用して参照されます。
注意:
-
このAPIでは、Job Functionを使用したリクエスト例とレスポンス例を示しています。APIの機能はwebhook、Circuits、およびAppSailジョブでも同じです。
リクエスト詳細
リクエストURL
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron/{cron_identifier (name/ID)}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cron.UPDATE
リクエストJSON
以下に示す対応する値を含むJSONを送信する必要があります。
{
"cron_name": "RecursiveCronDaily",
"description": "dailycron",
"cron_type": "Calendar",
"cron_status": true,
"end_time": 1718002799,
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280518",
"job_name": "job",
"job_config": {
"number_of_retries": 1,
"retry_interval": 300
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280516",
"source_name": "RecursiveCronDaily",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"params": {
"param1": "value1"
},
"target_id": "10108000003823893"
},
"job_detail": {
"hour": "2",
"minute": 0,
"second": 0,
"repetition_type": "daily",
"timezone": "PST"
},
"id": "10108000004280516"
}
このリクエストJSONをリクエストボディに設定し、以下の値を指定する必要があります：
レスポンス詳細
JSONレスポンスは更新されたcronのメタデータを返します。レスポンスにはcronを更新したユーザーの詳細も含まれます。
curl -X PUT \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron/10108000004280516
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_name”:“RecursiveCronDaily”,“description”:“dailycron”,“cron_type”:“Calendar”,“cron_status”:true,“end_time”:1718002799,“cron_execution_type”:“pre-defined”,“job_meta”:{“id”:“10108000004280518”,“job_name”:“job”,“job_config”:{“number_of_retries”:1,“retry_interval”:300},“target_type”:“Function”,“target_details”:{“id”:“10108000003823893”,“target_name”:“target_function_fetch”},“source_type”:“Cron”,“source_details”:{“id”:“10108000004280516”,“source_name”:“RecursiveCronDaily”,“details”:{“cron_execution_type”:“pre-defined”}},“jobpool_id”:“10108000003823563”,“jobpool_details”:{“type”:“Function”,“name”:“VendorReminder”,“created_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“created_time”:“May 28, 2024 04:44 PM”,“modified_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“modified_time”:“May 28, 2024 04:44 PM”,“capacity”:{“memory”:“2048”},“project_details”:{“project_name”:“ZylkerShipments”,“id”:“10108000003823392”,“project_type”:“Live”},“id”:“10108000003823563”},“params”:{“param1”:“value1”},“target_id”:“10108000003823893”},“job_detail”:{“hour”:“2”,“minute”:0,“second”:0,“repetition_type”:“daily”,“timezone”:“PST”},“id”:“10108000004280516”}’
{
"status": "success",
"data": {
"cron_name": "RecursiveCronDaily",
"description": "dailycron",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280784",
"url": "",
"job_name": "job",
"job_config": {
"number_of_retries": 1,
"retry_interval": 300
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280516",
"source_name": "RecursiveCronDaily",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"modified_time": "Jun 07, 2024 12:59 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1718002799",
"cron_detail": {
"jobId": "10108000004280516",
"transactionTimeout": -1,
"hour": 2,
"minute": 0,
"second": 0,
"repetition_type": "daily",
"timezone": "PST"
},
"id": "10108000004280516"
}
}
マンスリーCronの更新（日付タイプ）
説明
このAPIを使用すると、プロジェクト内のマンスリーcron（カレンダー日付を使用して設定）を更新できます。更新するcronは、名前やIDなどの一意の識別子を使用して参照されます。
注意:
-
このAPIでは、Job Functionを使用したリクエスト例とレスポンス例を示しています。APIの機能はwebhook、Circuits、およびAppSailジョブでも同じです。
-
月内の週を使用して定義されたマンスリーcronを更新する場合も、APIの機能は同じです。マンスリーCronの作成（週タイプ）APIを参照してください。
リクエスト詳細
リクエストURL
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron/{cron_identifier (name/ID)}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cron.UPDATE
リクエストJSON
以下に示す対応する値を含むJSONを送信する必要があります。
{
"cron_name": "recurCronMonthly",
"description": "monthly",
"cron_type": "Calendar",
"cron_status": true,
"end_time": 1718002799,
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280537",
"job_name": "jobName",
"job_config": {
"number_of_retries": 2,
"retry_interval": 500
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280535",
"source_name": "recurCronMonthly",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"params": {
"param1": "value1"
},
"target_id": "10108000003823893"
},
"job_detail": {
"hour": 3,
"minute": 0,
"second": 0,
"repetition_type": "monthly",
"days": [
1,
3,
8,
"9"
],
"timezone": "PST"
},
"id": "10108000004280535"
}
このリクエストJSONをリクエストボディに設定し、以下の値を指定する必要があります：
レスポンス詳細
JSONレスポンスは更新されたcronのメタデータを返します。レスポンスにはcronを更新したユーザーの詳細も含まれます。
curl -X PUT \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron/10108000004280535
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_name”:“recurCronMonthly”,“description”:“monthly”,“cron_type”:“Calendar”,“cron_status”:true,“end_time”:1718002799,“cron_execution_type”:“pre-defined”,“job_meta”:{“id”:“10108000004280537”,“job_name”:“jobName”,“job_config”:{“number_of_retries”:2,“retry_interval”:500},“target_type”:“Function”,“target_details”:{“id”:“10108000003823893”,“target_name”:“target_function_fetch”},“source_type”:“Cron”,“source_details”:{“id”:“10108000004280535”,“source_name”:“recurCronMonthly”,“details”:{“cron_execution_type”:“pre-defined”}},“jobpool_id”:“10108000003823563”,“jobpool_details”:{“type”:“Function”,“name”:“VendorReminder”,“created_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“created_time”:“May 28, 2024 04:44 PM”,“modified_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“modified_time”:“May 28, 2024 04:44 PM”,“capacity”:{“memory”:“2048”},“project_details”:{“project_name”:“ZylkerShipments”,“id”:“10108000003823392”,“project_type”:“Live”},“id”:“10108000003823563”},“params”:{“param1”:“value1”},“target_id”:“10108000003823893”},“job_detail”:{“hour”:3,“minute”:0,“second”:0,“repetition_type”:“monthly”,“days”:[1,3,8,“9”],“timezone”:“PST”},“id”:“10108000004280535”}’
{
"status": "success",
"data": {
"cron_name": "recurCronMonthly",
"description": "monthly",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280805",
"url": "",
"job_name": "jobName",
"job_config": {
"number_of_retries": 2,
"retry_interval": 500
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280535",
"source_name": "recurCronMonthly",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"modified_time": "Jun 07, 2024 01:00 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1718002799",
"cron_detail": {
"jobId": "10108000004280535",
"transactionTimeout": -1,
"hour": 3,
"minute": 0,
"second": 0,
"repetition_type": "monthly",
"days": [
1,
3,
8,
9
],
"timezone": "PST"
},
"id": "10108000004280535"
}
}
年次Cronの更新（週タイプ）
説明
このAPIを使用すると、プロジェクトに存在する年次cron（月の週を使用して定義）を更新できます。更新するcronは、名前やIDなどの一意の識別子を使用して参照されます。
注意:
-
このAPIでは、サンプルリクエストとサンプルレスポンスをJob Functionで説明しています。APIの機能は、webhook、Circuits、およびAppSailのジョブでも同様です。
-
月の日付を使用して定義された年次cronを更新する場合も、APIの機能は同じです。年次Cronの作成（日付タイプ）APIを参照してください。
リクエスト詳細
リクエストURL
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron/{cron_identifier(name/ID)}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cron.UPDATE
リクエストJSON
以下に示す対応する値を含むJSONを送信する必要があります。
{
"cron_name": "recurCronYearlyWeek",
"description": "abc",
"cron_type": "Calendar",
"cron_status": true,
"end_time": 1719212399,
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280663",
"job_name": "jobName",
"job_config": {
"number_of_retries": 2,
"retry_interval": 1000
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280661",
"source_name": "recurCronYearlyWeek",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"params": {
"param1": "value1"
},
"target_id": "10108000003823893"
},
"job_detail": {
"hour": 0,
"minute": 0,
"second": 0,
"repetition_type": "yearly",
"months": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
],
"weeks_of_month": [
1,
3,
5,
"4"
],
"week_day": [
1
],
"timezone": "PST"
},
"id": "10108000004280661"
}
このリクエストJSONをリクエストボディに設定し、以下の値を指定する必要があります：
レスポンス詳細
JSONレスポンスは、更新されたcronのメタデータを返します。レスポンスには、cronを更新したユーザーの詳細も含まれます。
curl -X PUT \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron/10108000004280535
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_name”:“recurCronYearlyWeek”,“description”:“abc”,“cron_type”:“Calendar”,“cron_status”:true,“end_time”:1719212399,“cron_execution_type”:“pre-defined”,“job_meta”:{“id”:“10108000004280663”,“job_name”:“jobName”,“job_config”:{“number_of_retries”:2,“retry_interval”:1000},“target_type”:“Function”,“target_details”:{“id”:“10108000003823893”,“target_name”:“target_function_fetch”},“source_type”:“Cron”,“source_details”:{“id”:“10108000004280661”,“source_name”:“recurCronYearlyWeek”,“details”:{“cron_execution_type”:“pre-defined”}},“jobpool_id”:“10108000003823563”,“jobpool_details”:{“type”:“Function”,“name”:“VendorReminder”,“created_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“created_time”:“May 28, 2024 04:44 PM”,“modified_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“modified_time”:“May 28, 2024 04:44 PM”,“capacity”:{“memory”:“2048”},“project_details”:{“project_name”:“ZylkerShipments”,“id”:“10108000003823392”,“project_type”:“Live”},“id”:“10108000003823563”},“params”:{“param1”:“value1”},“target_id”:“10108000003823893”},“job_detail”:{“hour”:0,“minute”:0,“second”:0,“repetition_type”:“yearly”,“months”:[0,1,2,3,4,5,6,7,8,9,10,11],“weeks_of_month”:[1,3,5,“4”],“week_day”:[1],“timezone”:“PST”},“id”:“10108000004280661”}’
{
"status": "success",
"data": {
"cron_name": "recurCronYearlyWeek",
"description": "abc",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280844",
"url": "",
"job_name": "jobName",
"job_config": {
"number_of_retries": 2,
"retry_interval": 1000
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280661",
"source_name": "recurCronYearlyWeek",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"modified_time": "Jun 07, 2024 01:03 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1719212399",
"cron_detail": {
"jobId": "10108000004280661",
"transactionTimeout": -1,
"hour": 0,
"minute": 0,
"second": 0,
"repetition_type": "yearly",
"months": [
0,
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11
],
"weeks_of_month": [
1,
3,
4,
5
],
"week_day": [
1
],
"timezone": "PST"
},
"id": "10108000004280661"
}
}
Cron式で定義されたCronの更新
説明
このAPIを使用すると、Cron式で定義されたcronを更新できます。更新するcronは、名前やIDなどの一意の識別子を使用して参照されます。
注意:
-
このAPIでは、サンプルリクエストとサンプルレスポンスをJob Functionで説明しています。APIの機能は、webhook、Circuits、およびAppSailのジョブでも同様です。
リクエスト詳細
リクエストURL
{api-domain/}baas/v1/project/{project_id}/job_scheduling/cron/{cron_identifier(name/ID)}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cron.UPDATE
リクエストJSON
以下に示す対応する値を含むJSONを送信する必要があります。
{
"cron_name": "cronExp",
"description": "cronexpression",
"cron_type": "CronExpression",
"cron_status": true,
"end_time": 1717916399,
"cron_execution_type": "pre-defined",
"cron_expression": "/30 /6 * * *",
"job_meta": {
"id": "10108000004280709",
"job_name": "jobName",
"job_config": {
"number_of_retries": 1,
"retry_interval": 500
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280707",
"source_name": "cronExp",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"params": {
"param1": "value1"
},
"target_id": "10108000003823893"
},
"job_detail": {
"timezone": "PST"
},
"id": "10108000004280707"
}
このリクエストJSONをリクエストボディに設定し、以下の値を指定する必要があります：
レスポンス詳細
JSONレスポンスは、更新されたcronのメタデータを返します。レスポンスには、cronを更新したユーザーの詳細も含まれます。
curl -X PUT \ https://api.catalyst.zoho.com/baas/v1/project/10108000003823392/job_scheduling/cron/10108000004280535
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“cron_name”:“cronExp”,“description”:“cronexpression”,“cron_type”:“CronExpression”,“cron_status”:true,“end_time”:1717916399,“cron_execution_type”:“pre-defined”,“cron_expression”:"/30 /6 * * *",“job_meta”:{“id”:“10108000004280709”,“job_name”:“jobName”,“job_config”:{“number_of_retries”:1,“retry_interval”:500},“target_type”:“Function”,“target_details”:{“id”:“10108000003823893”,“target_name”:“target_function_fetch”},“source_type”:“Cron”,“source_details”:{“id”:“10108000004280707”,“source_name”:“cronExp”,“details”:{“cron_execution_type”:“pre-defined”}},“jobpool_id”:“10108000003823563”,“jobpool_details”:{“type”:“Function”,“name”:“VendorReminder”,“created_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“created_time”:“May 28, 2024 04:44 PM”,“modified_by”:{“zuid”:“77941453”,“is_confirmed”:false,“email_id”:“emmy@zylker.com”,“first_name”:“Amelia Burrows”,“last_name”:"",“user_type”:“Admin”,“user_id”:“10108000000009004”},“modified_time”:“May 28, 2024 04:44 PM”,“capacity”:{“memory”:“2048”},“project_details”:{“project_name”:“ZylkerShipments”,“id”:“10108000003823392”,“project_type”:“Live”},“id”:“10108000003823563”},“params”:{“param1”:“value1”},“target_id”:“10108000003823893”},“job_detail”:{“timezone”:“PST”},“id”:“10108000004280707”}’
{
"status": "success",
"data": {
"cron_name": "cronExp",
"description": "cronexpression",
"cron_type": "CronExpression",
"cron_execution_type": "pre-defined",
"cron_expression": "/30 /6 * * *",
"job_meta": {
"id": "10108000004280861",
"url": "",
"job_name": "jobName",
"job_config": {
"number_of_retries": 1,
"retry_interval": 500
},
"target_type": "Function",
"target_details": {
"id": "10108000003823893",
"target_name": "target_function_fetch"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280707",
"source_name": "cronExp",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823563",
"jobpool_details": {
"type": "Function",
"name": "VendorReminder",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:44 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:44 PM",
"capacity": {
"memory": "2048"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823563"
},
"headers": {},
"params": {
"param1": "value1"
}
},
"cron_status": true,
"modified_time": "Jun 07, 2024 01:04 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1717916399",
"cron_detail": {
"jobId": "10108000004280866",
"transactionTimeout": -1,
"hour": 0,
"minute": 0,
"second": 0,
"timezone": "PST"
},
"id": "10108000004280707"
}
}
Cronの即時実行
説明
このAPIを使用すると、ターゲットタイプのエンドポイントをトリガーするために、ジョブプールにジョブを即時送信するcronを送信できます。
注意:
-
このAPIは、設定されたcronが構成通りに機能しているかどうかをテストするために主に使用されます。
-
このAPIでは、ジョブFunctionを使用したサンプルリクエストとサンプルレスポンスを示しています。APIの機能は、webhook、Circuit、およびAppSailのジョブでも同様です。
リクエスト詳細
リクエストURL
{app_domain}/baas/v1/project/{project_id}/job_scheduling/cron/{cron_id}/submit_job
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cron.CREATE
レスポンス詳細
JSONレスポンスは、送信されたcronのメタデータを返します。レスポンスには、cronを送信したユーザーの詳細も含まれます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/10278000000019013/job_scheduling/cron/10108000003822189/submit_immediately
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
{
"status": "success",
"data": {
"job_id": "10108000004251242",
"created_time": "Jun 07, 2024 10:32 AM",
"response_code": null,
"start_time": {},
"end_time": {},
"submitted_on": {
"startTimeToRedirectLogsPage": "07/06/2024 10:27",
"timeWithGivenTimezone": "Jun 07, 2024 10:32 AM IST",
"timeWithJobTimezone": "Jun 07, 2024 10:32 AM IST"
},
"job_status": "PENDING",
"capacity": {
"memory": "256"
},
"job_meta_details": {
"id": "10108000003822191",
"url": "",
"job_name": "delayJob",
"job_config": {
"number_of_retries": 0
},
"target_type": "Function",
"target_details": {
"id": "10108000003822071",
"target_name": "fn"
},
"source_type": "Cron",
"source_details": {
"id": "10108000003822189",
"source_name": "check2",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003822066",
"headers": {},
"params": {}
},
"retried_count": null,
"parent_job_id": "10108000004251242",
"execution_time": null,
"cron_circuit_id": null,
"circuit_execution": null,
"status": false
}
}
Cronのパッチ
説明
このAPIを使用すると、プロジェクトに存在するcronを有効化または無効化できます。cronはIDなどの一意の識別子で参照されます。
リクエスト詳細
リクエストURL
{app_domain}/baas/v1/project/{project_id}/job_scheduling/cron/{cron_id}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cron.UPDATE
レスポンス詳細
JSONレスポンスは、有効化または無効化するcronのメタデータを返します。レスポンスには、cronのステータスを変更したユーザーの詳細も含まれます。
curl -X PATCH
https://api.catalyst.zoho.com/baas/v1/project/10278000000019013/job_scheduling/cron/10108000004280087
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-H “Content-Type:application/json”
--data-raw ‘{“id”:“10108000004280087”,“cron_status”:false}’
{
"status": "success",
"data": {
"cron_name": "circuitCron",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004280089",
"job_name": "j",
"job_config": {
"number_of_retries": 0
},
"target_type": "Circuit",
"target_details": {
"id": "10108000004194246",
"target_name": "abc"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004280087",
"source_name": "circuitCron",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000003823699",
"jobpool_details": {
"type": "Circuit",
"name": "InventoryDataMaintaince",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "May 28, 2024 04:49 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "May 28, 2024 04:49 PM",
"capacity": {
"number": "3"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"id": "10108000003823699"
},
"headers": {},
"params": {
"key1": "value1",
"key2": "value2",
"key3": "value3"
}
},
"cron_status": false,
"created_time": "Jun 07, 2024 11:09 AM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 07, 2024 11:09 AM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "ZylkerShipments",
"id": "10108000003823392",
"project_type": "Live"
},
"end_time": "1717871399",
"cron_detail": {
"hour": 4,
"minute": 3,
"second": 0,
"repetition_type": "daily",
"timezone": "Asia/Kolkata"
},
"success_count": 0,
"failure_count": 0,
"id": "10108000004280087"
}
}
Cronの削除
説明
このAPIを使用すると、プロジェクトに存在するcronを削除できます。cronはIDや名前などの一意の識別子で参照されます。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/job_scheduling/cron/{cron_id/cron_name}
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
オプションヘッダー
CATALYST-ORG: {org_id}
Environment: Development
スコープ
ZohoCatalyst.cron.DELETE
レスポンス詳細
JSONレスポンスは、削除されたcronのメタデータを返します。レスポンスには、cronを削除したユーザーの詳細も含まれます。
curl -X DELETE
https://api.catalyst.zoho.com/baas/v1/project/10278000000019013/job_scheduling/cron/10108000004154323
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57
{
"status": "success",
"data": {
"cron_name": "pcMonthlyDay",
"cron_type": "Calendar",
"cron_execution_type": "pre-defined",
"job_meta": {
"id": "10108000004154323",
"url": "",
"job_name": "j",
"job_config": {
"number_of_retries": 0
},
"target_type": "AppSail",
"target_details": {
"id": "10108000002976191",
"target_name": "appsailTrue"
},
"source_type": "Cron",
"source_details": {
"id": "10108000004154321",
"source_name": "pcMonthlyDay",
"details": {
"cron_execution_type": "pre-defined"
}
},
"jobpool_id": "10108000002976201",
"jobpool_details": {
"type": "AppSail",
"name": "appsailJP",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"created_time": "Mar 28, 2024 05:41 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Mar 28, 2024 05:41 PM",
"capacity": {
"number": "5"
},
"project_details": {
"project_name": "AppsailCron",
"id": "10108000002976144",
"project_type": "Live"
},
"id": "10108000002976201"
},
"request_method": "get"
},
"cron_status": true,
"created_time": "Jun 04, 2024 04:31 PM",
"created_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"modified_time": "Jun 04, 2024 04:31 PM",
"modified_by": {
"zuid": "77941453",
"is_confirmed": false,
"email_id": "emmy@zylker.com",
"first_name": "Amelia Burrows",
"last_name": "",
"user_type": "Admin",
"user_id": "10108000000009004"
},
"project_details": {
"project_name": "AppsailCron",
"id": "10108000002976144",
"project_type": "Live"
},
"end_time": "1718303399",
"cron_detail": {
"hour": 4,
"minute": 4,
"second": 4,
"repetition_type": "monthly",
"days": [
1,
3,
4
],
"timezone": "Asia/Kolkata"
},
"success_count": 0,
"failure_count": 0,
"id": "10108000004154321"
}
}
Catalyst Pipelines
Catalyst Pipelinesは、アプリケーションのビルド、テスト、デプロイプロセスを自動化するCatalyst CI/CDサービスです。Catalystコンソールからパイプラインを作成できます。次のセクションでは、パイプラインのトリガーと既存のパイプラインの詳細取得に利用できるAPIについて説明します。
Pipeline詳細の取得
このAPIを使用すると、Catalystコンソールで作成されたパイプラインの詳細を取得できます。これは、リクエストURLにpipeline_idとproject_idを渡すことで行えます。APIは、パイプラインが作成されたプロジェクトの詳細とパイプラインの詳細を取得します。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/pipeline/{pipeline_id}
パイプラインが作成されたプロジェクトの一意のID
詳細を取得するパイプラインの一意のID
スコープ
pipeline.READ
レスポンス詳細
パイプライン詳細オブジェクトがレスポンスとして返されます。これには、パイプラインの名前、project_nameやproject_typeを含むプロジェクトの詳細、user_id、email_id、first_name、last_name、user_typeを含むパイプライン作成者の詳細、パイプラインのステータス、パイプラインを変更したユーザーの詳細と変更時間の詳細、およびパイプラインのデフォルトランナー設定が含まれます。
curl -X GET
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/pipeline/29810101101
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57” \
{
“status”: “success”,
“data”: {
“pipeline_id”: “29810101101”,
“name”: “test1”,
“project_details”: {
“project_name”: “Project-Rainfall”,
“id”: “4000000006007”,
“project_type”: “Live”
},
“created_by”: {
“zuid”: “20257791”,
“is_confirmed”: false,
“email_id”: “amelia.burrows@zylker.com”,
“first_name”: “Amelia”,
“last_name”: “Burrows”,
“user_type”: “Admin”,
“user_id”: “5000000000056”
},
“created_time”: “Mar 19, 2024 11:28 AM”,
“modified_by”: {
“zuid”: “20257791”,
“is_confirmed”: false,
“email_id”: “amelia.burrows@zylker.com”,
“first_name”: “Amelia”,
“last_name”: “Burrows”,
“user_type”: “Admin”,
“user_id”: “5000000000056”
},
“modified_time”: “Mar 19, 2024 11:28 AM”,
“git_account_id”: “”,
“mask_regex”: [
null
],
“pipeline_status”: “Active”,
“config_id”: 2,
“integ_id”: 1
}
}
Pipelineの実行
このAPIを使用すると、Gitリポジトリ内の特定のブランチでパイプラインをトリガーできます。これは、リクエストボディでパラメータとしてブランチ名を渡すことで行えます。手動パイプラインをトリガーする場合は、リクエストJSONのブランチ名パラメータを省略できます。
このAPIをトリガーすると、パイプラインが実行され、実行のステータスがレスポンスとして返されます。
Pipeline詳細の取得
このAPIを使用すると、Catalystコンソールで作成されたパイプラインの詳細を取得できます。これは、リクエストURLにpipeline_idとproject_idを渡すことで行えます。APIは、パイプラインが作成されたプロジェクトの詳細とパイプラインの詳細を取得します。
リクエスト詳細
リクエストURL
{api-domain}/baas/v1/project/{project_id}/pipeline/{pipeline_id}/run
パイプラインが作成されたプロジェクトの一意のID
詳細を取得するパイプラインの一意のID
リクエストJSONプロパティ
注意:
- 手動のCatalyst Pipelineをトリガーする場合、BRANCH_NAMEは任意です。
- EVENTおよびURLキーは環境変数として追加されています。パイプラインの実行に必要なキーをイベントJSONで渡すことができます。
スコープ
pipeline.execution.CREATE
レスポンス詳細
パイプライン作成履歴の詳細を含むオブジェクトがレスポンスとして返されます。オブジェクトには、history_id、event_time、history_statusなどの詳細が含まれます。
curl -X POST
https://api.catalyst.zoho.com/baas/v1/project/4000000006007/pipeline/29810101101/run
-H “Authorization: Zoho-oauthtoken 1000.91016.2f57”
-d ‘{
“BRANCH_NAME” : “main”,
“EVENT”: “push”, \
“URL”: “https://www.google.com”
}
{
“status”: “success”,
“data”: {
“history_id”: “5000000021007”,
“pipeline_id”: “29810101101”,
“event_time”: “Mar 20, 2024 02:02 PM”,
“event_details”: {
“BRANCH_NAME”: “main”,
“EVENT”: “push”,
“URL”: “https://www.google.com”
},
“history_status”: “Queued”
}
}
Catalyst Slate
Slateは、Catalystが提供する堅牢なフロントエンド開発サービスで、Webアプリケーションのデプロイ、プレビュー、公開をシームレスに行えます。Next.js、Angular、Reactなどの人気のあるJavaScriptフレームワークをネイティブサポートし、その他のフロントエンドフレームワークにもシームレスに対応して、手間のかからないデプロイを実現します。
アプリケーションの再デプロイ
一意のCatalystプロジェクトID、プロジェクト内の特定のSlateアプリケーション名、およびデプロイメントIDを以下のAPIに渡すことで、Slateの既存のデプロイメントに対して新しいビルドをトリガーできます。
リクエスト詳細
リクエストURL
{api-domain}/slate/v1/project/{project_id}/app/{app_id}/deployment/{deployment_id}/redeploy
注意:
コンソールでSlateデプロイメントを開くと、URLから以下の値を取得できます。
ここで、26879000000021001がproject_idです。1860000000007114がapp_idで、1860000000007119がdeployment_idです。
リクエストヘッダー
Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json
リクエストJSONプロパティ
リクエストボディでキーと値のペアとして環境変数を渡します。
例:
{“API_KEY”: “xxxxxxxx2433”}
スコープ
ZohoCatalyst.Slate.app.CREATE
レスポンス詳細
レスポンスには、新しいビルドデプロイメントのステータス、デプロイメントの詳細情報、コミットメッセージ、接続されたGitリポジトリから直接取得されたコミットURL、およびその他のメタデータが含まれます。
curl -X POST
‘https://api.catalyst.zoho.com/slate/v1/project/4000000006007/app/29810101101/deployment/1860000000007119/redeploy'
-H ‘Authorization: Zoho-oauthtoken 1000.91016.2f57’
-H ‘Content-Type: application/json’
-d ‘{
{“API_KEY”: “xxxxxxx2433”}
}
{
“status”: “success”,
“data”: {
“id”: “2289000000006001”,
“status”: “Queued”,
“created_time”: “Feb 04, 2025 10:46 AM”,
“created_by”: {
“zuid”: “92747509”,
“is_confirmed”: false,
“email_id”: “amelia.b@zylker.com”,
“first_name”: “Amelia”,
“last_name”: “Burrows”,
“user_type”: “SuperAdmin”,
“user_id”: “28674000000016006”
},
“deployment_id”: “2289000000004006”,
“build_meta”: {
“event_type”: “push”,
“commit_id”: “18f6b8ef0d2586718a015be07701bd6ba486a18f”,
“commit_message”: “Initial commit”,
“commit_url”: “https://api.github.com/repos/ameliab-13966/nextjs-mongo-db/commits/18f6b8ef0d2586718a015be07701bd6ba486a18f",
“timestamp”: “2024-12-23T07:22:39Z”,
“author_name”: “amelia-b-13966”,
“repo_id”: “907257721”,
“repo_name”: “nextjs-mongo-db”,
“web_url”: “https://github.com/ameliab-13966/nextjs-mongo-db",
“ssh_url”: “git@github.com:ameliab-13966/nextjs-mongo-db.git”,
“http_url”: “https://github.com/ameliab-13966/nextjs-mongo-db.git",
“provider”: “Github”,
“repo_slug”: “nextjs-mongo-db”
}
}
}
Yes
No
Thank you for your feedback!
Send your feedback to us