フィルタ:
検索を送信

REST APIジョブ

REST APIジョブページでは、作成済みのAPIプロジェクトをウェブブラウザやツールなどからのHTTP RESTリクエストによって実行可能にするジョブを作成できます。

REST APIジョブを設定するには、ナビゲーションメニューの > ジョブ > REST APIジョブを選択します。

= 備考 =

ジョブを作成したユーザーがジョブ（スクリプト）の実行者になります。

 

ユーザーはREST APIジョブ作成時にワークスペースを指定することで他のユーザーまたはグループと共有することができます。

ワークスペースを使用して設定を共有する方法については、「チームメンバーと設定を共有してみよう」を参照してください。

 

REST APIジョブを新規作成および編集すると、アプリケーションで使用するエンドポイントのURLが発行されます。

注意

非同期実行を指定しなかった場合、REST APIジョブのリクエストタイムアウトは29秒となっています。REST APIジョブが実行するスクリプトが29秒以上かかった場合、REST APIジョブはスクリプトが実行中であっても、HTTPクライアントにタイムアウトエラーを返します。

必要に応じて、 > サービス > HULFT Integrateで、プロジェクト名でフィルターをかけるなどしてREST APIジョブに登録されたスクリプトの完了を確認してください。

 

ここではREST APIジョブの作成および設定時のキーポイントについて解説します。

 

チュートリアル

HTTP RESTジョブの作成方法については、以下のチュートリアルを参照してください。

 

設定のポイント

HTTP RESTジョブを新規作成するには、事前に以下の設定が必要です。

  • APIプロジェクト

  • APIクライアント

  • プロファイル

  • スクリプト実行のためのサービス

 

REST APIジョブページの追加を選択し、事前に設定したこれらの設定を指定します。

ここでは、REST APIジョブページからの画面遷移と、REST APIジョブを設定するための操作について説明します。

= 備考 =

HULFT Squareの基本的なUI要素などの名前と機能については、以下のトピックを参照してください。

REST APIジョブ

ナビゲーションメニューの > ジョブ > REST APIジョブを選択すると、このページが表示されます。

REST APIジョブページでは、以下の操作を行ってREST APIジョブを管理できます。

  • ジョブの詳細情報の表示

  • ジョブの有効/無効の切り替え

  • 新規アプリケーションの作成

  • ジョブの削除

(1) 追加

REST APIジョブを新規作成するには、このアイコンを選択します。

ステータス以外の各項目の詳細は、「REST APIジョブ > 新規追加」を参照してください。

(2) 設定リスト

設定済のREST APIジョブの情報が表形式で表示されます。

:

REST APIジョブが起動中であることを示します。

:

REST APIジョブが停止中であることを示します。

ステータス以外の各項目の詳細は、「REST APIジョブ > 新規追加」を参照してください。

(3) アクションメニュー

作成済REST APIジョブに対する操作を行う場合に選択します。

を選択すると、以下の操作メニューが表示されます。

情報

選択中のREST APIジョブの詳細情報が表示されます。REST APIジョブの詳細情報の編集および削除もできます。

このメニュー項目を選択した後に表示される画面については、「REST APIジョブ > REST APIジョブ名」を参照してください。

ジョブを有効化/無効化

REST APIジョブが必要なくなった場合に、ジョブを無効化を選択します。

ジョブを無効にすると、ステータスがになります。

アプリケーションの新規作成

作成済のREST APIジョブからアプリケーションを作成します。

このメニュー項目を選択した後に表示される画面については、「REST APIジョブ > REST APIジョブ名 > アプリケーションの新規作成」を参照してください。

削除

選択中のREST APIジョブを削除します。

REST APIジョブ > 新規追加

REST APIジョブページで追加を選択すると、このページが表示されます。

ウィザード形式のページで、作成するジョブの情報を順番に設定できます。

手順全般

ワークスペース

REST APIジョブを共有するために、共有したいユーザーおよびグループが指定されたワークスペースを選択します。

APIプロジェクト

このジョブと紐づける、APIプロジェクトの名前を指定します。

APIプロジェクトバージョン

このジョブと紐づける、APIプロジェクトのバージョンを指定します。

APIプロジェクトバージョンの指定後、スクリプト依存関係の設定が必要です。

依存関係を選択するとスクリプト依存関係ダイアログボックスが表示されます。

HTTPメソッドを選択してHTTPメソッドごとにスクリプト依存関係を設定してください。

詳細は「スクリプト依存関係」を参照してください。

プロファイル

このジョブと紐づける、プロファイルの名前を指定します。

説明

このジョブと紐づける、APIプロジェクトに対する説明コメントを指定します。

次へ

次のページを表示します。

手順API設定

APIクライアント

このジョブと紐づける、APIクライアントの名前を指定します。

= 備考 =

REST APIジョブの新規追加または編集後、APIクライアントを更新した場合、REST APIジョブと新しいAPIクライアントの紐づけをしなおす必要があります。

この場合は、ジョブを無効化をしてから再度ジョブを有効化をしてください。

次へ

次のページを表示します。

手順スクリプト実行のためのサービス

スクリプト実行のためのサービス

指定したスクリプトを実行するHULFT Integrateサービスを選択します。

次へ

次のページを表示します。

REST APIジョブ > REST APIジョブ名

REST APIジョブページで、作成したREST APIジョブの情報アイコンを選択すると、このページが表示されます。

選択したジョブの詳細情報が表示され、アプリケーションで使用するエンドポイントのURLのコピーができます。

APIのエンドポイントは任意のHTTPクライアントから呼び出しできます。

注意

REST APIジョブを編集し更新すると、APIのエンドポイントは再発行されます。REST APIジョブを更新した場合は、APIの呼び出し元のエンドポイントを再発行された内容に変更する必要があります。

詳細情報の編集や削除だけではなく、ジョブの有効化または無効化もできます。

(1) REST APIジョブ名

REST APIジョブ名に、REST APIジョブの名前が表示されます。

APIプロジェクトの名前がREST APIジョブの名前として使用されます。

(2) エンドポイント

REST APIジョブを実行するエンドポイントが表示されます。

を選択すると、エンドポイントをコピーできます。

(3) 編集

REST APIジョブの以下の項目を再設定して更新します。

  • APIプロジェクトバージョン

  • プロファイル

  • 説明

  • APIクライアント

  • スクリプト実行のためのサービス

(4) ジョブを有効化/無効化

REST APIジョブの有効/無効を切り替えます。

= 備考 =

REST APIジョブの新規追加または編集後、APIクライアントを更新した場合、REST APIジョブと新しいAPIクライアントの紐づけをしなおす必要があります。

この場合は、ジョブを無効化をしてから再度ジョブを有効化をしてください。

(5) アプリケーションの新規作成

REST APIジョブからアプリケーションを作成します。

このメニュー項目を選択した後に表示される画面については、「REST APIジョブ > REST APIジョブ名 > アプリケーションの新規作成」を参照してください。

(6) 削除

REST APIジョブを削除します。

REST APIジョブ > REST APIジョブ名 > アプリケーションの新規作成

REST APIジョブページで、設定リストのアクションメニューからアプリケーションの新規作成を選択すると、このページが表示されます。

ウィザード形式のページで項目を設定してアプリケーションを作成します。

アプリケーションの作成方法については、「アプリケーションの作成」を参照してください。

サイトポリシー     (c) Saison Technology Co.,Ltd. 2021

TOP