DataWorks:API の表示、削除、移動、複製、複数 API に対するバッチ操作の実行、およびコード検索機能を使用した API の検索

API の表示

1. DataWorks コンソール にログオンします。上部のナビゲーションバーで、目的のリージョンを選択します。左側のナビゲーションペインで、[データ開発とガバナンス] > [dataservice Studio] を選択します。表示されたページで、ドロップダウンリストから目的のワークスペースを選択し、[dataservice Studio に移動] をクリックします。

2. [サービス開発] ペインで、目的の ビジネスプロセス[API] が属する をクリックします。

3. 詳細を表示する API を見つけ、API を右クリックして、[詳細の表示] を選択します。

   説明

   [詳細の表示] オプションは、公開済みの API のショートカットメニューにのみ表示されます。API が公開されていない場合は、API をダブルクリックして API の構成タブに移動します。次に、右側のナビゲーションペインで [プロパティ] をクリックして、API に関する基本情報を表示します。

API の複製

API をディレクトリツリー内の指定されたフォルダーに複製できます。

1. [サービス開発] ペインで、目的の [ビジネスプロセス] が属する [API] をクリックします。

2. 複製する API を見つけ、API を右クリックして、[複製] を選択します。

3. [clone API] ダイアログボックスで、パラメーターを構成します。

   

   パラメーター	説明
   API名	複製された API の名前。名前は 4 ～ 50 文字で、文字、数字、およびアンダースコア (_) を使用できます。文字で始める必要があります。
   APIパス	複製された API のパス。例: /user。 パスは最大 200 文字で、文字、数字、アンダースコア (_)、およびハイフン (-) を使用できます。スラッシュ (/) で始める必要があります。
   説明	複製された API の説明。
   保存先フォルダー	複製された API が保存されるフォルダー。

4. [OK] をクリックします。

API の削除

公開されていない API のみ削除できます。公開済みの API を削除するには、最初に公開を取り消す必要があります。

1. (オプション) 削除する API を非公開にします。

   削除する API が未公開状態の場合は、この手順をスキップします。

   1. [サービス開発] ページで、上部のナビゲーションバーにある [サービス管理] タブをクリックします。[API の管理] ページが表示されます。

      

   2. [公開済み API] タブで、削除する API を見つけ、[操作] 列の [公開の停止] をクリックします。[API の公開停止] メッセージで、[OK] をクリックします。

   3. 上部のナビゲーションバーにある [サービス開発] タブをクリックします。

2. [サービス開発] ペインで、目的の [ビジネスプロセス] が属する [API] をクリックします。

3. 削除する API を探し、API を右クリックして、[削除] を選択します。 [API の削除] メッセージで、[OK] をクリックします。

   重要

   削除された API は復元できません。API を削除する際は注意してください。

API を別のフォルダーに移動する

公開されていない API のみ移動できます。公開済みの API を移動するには、最初に公開を取り消す必要があります。

1. (オプション) 削除する API を非公開にします。

   削除する API が未公開状態の場合は、この手順をスキップします。

   1. [サービス開発] ページで、上部のナビゲーションバーにある [サービス管理] タブをクリックします。[API の管理] ページが表示されます。

      

   2. [公開済み API] タブで、削除する API を見つけ、[アクション] 列の [公開停止] をクリックします。[API の公開停止] メッセージで、[OK] をクリックします。

   3. 上部のナビゲーションバーにある [サービス開発] タブをクリックします。

2. [サービス開発] ペインで、目的の [ビジネスプロセス] が属する [API] をクリックします。

3. 別のフォルダーに移動する API を見つけ、API を右クリックして、[移動] を選択します。

4. [ファイルパスの変更] ダイアログボックスで、[宛先フォルダー] パラメーターを構成し、[OK] をクリックします。

5. 重要

   API を移動すると、API が属するグループが変更される場合があります。API の公開後にこの API を呼び出すためのエンドポイントも変更される場合があります。API を別のフォルダーに移動する際は注意してください。

複数 API に対するバッチ操作の実行

DataWorks では、複数の API の DataService Studio のリソースグループを同時に変更できます。DataWorks では、複数の API を同時に送信および公開することもできます。これにより、API は DataService Studio の他のリソースグループで実行でき、効率的に公開できます。

1. DataService Studioページに移動します。左側のナビゲーションペインで、[サービス開発] をクリックします。表示されるページの [サービス開発] ペインで、 アイコンをクリックします。

   

2. [バッチ操作] タブの上部で、[ビジネスプロセス] や [所有者] などのフィルター条件を指定して API をフィルターします。

3. リストから目的の API を選択します。

4. [バッチ操作] タブの下部にあるボタンをクリックすると、選択した API に対して同時に対応する操作を実行できます。

   次の表は、バッチ操作と API 状態の関係を示しています。

   バッチ操作	未公開および未送信	未公開および送信済み	公開済みおよび未送信	公開済みおよび送信済み
   リソースグループの変更
   送信		繰り返し送信はサポートされていません。送信済みの API を再送信する場合は、API の構成タブに移動し、右側のナビゲーションペインの [バージョン] タブで、以前に送信されたバージョンを破棄する必要があります。		繰り返し送信はサポートされていません。送信済みの API を再送信する場合は、API の構成タブに移動し、右側のナビゲーションペインの [バージョン] タブで、以前に送信されたバージョンを破棄する必要があります。
   公開	API は、送信後にのみ公開できます。公開する API が送信されていない場合は、最初に API を送信してください。		API は、送信後にのみ公開できます。公開する API が送信されていない場合は、最初に API を送信してください。

   説明

   公開済み API の DataService Studio のリソースグループを変更した後、変更を有効にするには、API を再度テスト、送信、および公開する必要があります。

コード検索機能を使用して API を検索する

コード検索機能を使用すると、現在のワークスペースのコードに基づいて、スクリプトモードで作成された API を検索できます。

1. DataService Studioページに移動します。左側のナビゲーションペインで、 アイコンをクリックします。

2. コード検索 API ペインで、検索ボックスの右側にある ドロップダウン矢印をクリックして、検索条件を展開します。

   API名、APIパス、APIの説明、テーブル名、フィールド名などのキーワードを検索ボックスに入力して、APIを検索できます。また、所有者、ビジネスプロセス、または変更時間でクエリ結果をフィルタリングすることもできます。

3. クエリ結果を表示します。

   検索条件に一致する結果が表示されます。次の項目が含まれます。

   説明

   公開済みの API のみが表示されます。

   • API名: API名をクリックすると、右側にAPIの設定タブが表示されます。

   • コード: 一致するコードのキーワード、対応する行、および簡単なコンテキストが表示されます。一致するコードをコピーできます。

   • 基本情報: API ID、所有者、ビジネスプロセス、最終変更時刻などの情報が表示されます。