HB_API_GET コマンド

HighBond API に GET 要求を送信します。

構文

HB_API_GET HighBond API 要求 URL HEADERS ヘッダー情報 PASSWORD 番号 <TO 回答ファイル>HighBond_API_request_URL

パラメーター

"https://apis-us.highbond.com/v1/orgs/11594/robots"

'{"content-type": "application/vnd.api+json"}'

TO "response.json"

TO "C:\HighBond API responses\response.json"

例

HB_API_GET "https://apis-us.highbond.com/v1/orgs/11594/robots" HEADERS '{"content-type": "application/vnd.api+json"}' TO "all_robots.json"

HB_API_GET "https://apis-us.highbond.com/v1/orgs/11594/robots" HEADERS '{"content-type": "application/vnd.api+json"}' TO "C:\HighBond API responses\all_robots.json"

{
  "data": [
    {
      "id": "17504",
      "type": "robots",
      "attributes": {
        "active_app_version": 4,
        "app_versions_count": 5,
        "name": "Concur T&E Data Integration",
        "category": "acl",
        "drive_system_user": "exYRZqYABvrjHCjV7E7j"
      }
    },
    {
      "id": "24202",
      "type": "robots",
      "attributes": {
        "active_app_version": 2,
        "app_versions_count": 2,
        "name": "Test_Steele_Adverse_Media",
        "category": "highbond",
        "drive_system_user": "exYRZqYABvrjHCjV7E7j"
      }
    }
  ]
}

COMMENT
//ANALYTIC のサンプルHighBond API 要求			
//PASSWORD 1HighBond API トークン：				
 //RESULT FILE all_robots.json				
 END		
				
HB_API_GET "https://apis-us.highbond.com/v1/orgs/11594/robots" HEADERS '{"content-type": "application/vnd.api+json"}' PASSWORD 1 TO "all_robots.json"

HB_API_GET "robots" TO "all_robots.json"

備考

パスワード定義の作成とパスワード値の指定

ロボットで HighBond API に要求を送信するスクリプトを実行する場合、要求を送信するコマンドとともにパスワード定義を含める必要があります。オフラインアクティベーションを使用する場合、同じ要件が Analytics で実行されるスクリプトに適用されます。

どの方法を用いてパスワード定義を作成したかにかかわらず、パスワードには値として HighBond アクセストークンを指定する必要があります。このトークンは Launchpad で生成できます。詳細については、HighBond アクセストークンを取得を参照してください。

パスワード定義方法

HighBond アクセストークンを取得

新しいアクセストークンを作成する理由がない場合は、既存のトークンを使用してください。既存のトークンが機能しない場合は、新しいトークンを作成してください。既存のトークンを使用すると、管理する必要があるトークン数が減ります。

1. 次のいずれかを実行します。

   • Analytics メインメニューで［ツール］ > ［HighBond アクセストークン］を選択します。HighBond Access Token

   • スクリプト エディター内を右クリックし、［挿入 > HighBond トークン］を選択します。HighBond Token

   ［API トークンを管理］ページがお使いのブラウザーで開きます。最初に Diligent One にサインインすることを求められる場合があります。

   Analytics からの［API トークンを管理］ページへのアクセスが便利です。Diligent One にサインインし、Analytics を使用せずにユーザープロファイルからこのページにアクセスすることもできます。

2. 次のいずれかを実行します。

   • 既存のトークンを使用する

     1. ［トークン］列で、使用するトークンをクリックします。

     2. Diligent One アカウントのパスワードを入力し、［確認Diligent One］をクリックします。

        マスクされていないトークンが表示されます。

     3. ［コピー ］をクリックしてトークンをコピーします。

        ヒント

        トークンが含まれているこのダイアログボックスは、そのトークンを貼り付けるまで閉じないでください。

   • 新しいトークンを作成する

     1. ［トークンを追加］ > ［Analytics］をクリックします。

     2. ［新しい Analytics トークン］サイド パネルで、次の情報を指定します。

        フィールドまたはオプション	説明
        説明	次のような有用な情報を提供する説明を入力します。 トークンの目的 トークンの使用場所 - 例えば、Analyticsスクリプトの名前と場所、ロボットのタスクの名前と場所など。
        トークンの有効期限	有効 指定した日数後にトークンの有効期限が切れます 無効 トークンの有効期限はありません メモ あなたの組織には、トークンを一定期間後に失効させるセキュリティポリシーがあるかもしれません。有効期限付きのトークンを作成することは良い習慣です。Diligent One では、有効期限の前に自動でメール通知が送られます。
        有効期限が切れるまでの日数	トークンの有効期限が切れるまでの日数を指定します (1～365)。
        パスワード	Diligent One アカウントのパスワードを入力します。

     3. ［トークンを生成］をクリックします。

     4. ［コピー ］をクリックしてトークンをコピーします。

        ヒント

        トークンが含まれているこのサイド パネルは、トークンを貼り付けるまで閉じないでください。

3. 使用しているパスワード定義方法に応じて次のいずれかを実行します。

   • PASSWORDアナリティクスタグACLロボットのタスクデザイナーで、コピーしたトークンをパスワーACL robotドパラメーターフィールドに貼り付けます。

   • PASSWORD コマンドAnalytics で、コピーしたトークンを、スクリプト実行中に表示されるパスワードの確認に貼り付けます。

   • SET PASSWORD コマンドAnalytics で、スクリプトの SET PASSWORD コマンド構文内の適切な位置にコピーしたトークンを貼り付けます。

4. Launchpad で、トークンが含まれているダイアログボックスまたはサイド パネルを閉じます。

   新しいトークンを作成した場合は、部分的にマスクされたバージョンのトークンが、トークンのリストに追加されます。

   詳細については、HighBond アクセストークンの作成と管理を参照してください。HighBond access tokens