Skip to main content

URL パラメーターの使用

ArcGIS Knowledge Studio は、リンクを使用して Knowledge Studio を開くことで他のアプリと連携できます。 たとえば、別の Esri アプリ、Web マップのポップアップ、電子メールや Web サイトの単純なハイパーリンクから Knowledge Studio を起動して開くためのアプリ リンクを作成できます。

URL パラメーターは、名前と値のペアです。 各パラメーターでは、名前と値は等号 (=) で区切られます。

注意:

このトピック全体を通して、URL リクエストのコンテキストに固有の値は大なり記号と小なり記号 (<>) で囲まれています。 たとえば、https://<YourPortal>/apps/knowledge-studio/main? という URL では、<YourPortal> を自分のポータルの場所に置き換える必要があります。

Knowledge Studio プロジェクト コンテンツの共有

Knowledge Studio プロジェクト内の特定のコンテンツ アイテム、保存済みクエリー、エンティティー、またはリレーションシップへの URL を共有できます。 各マップ、リンク チャート、データ カード、保存済みクエリー、ダッシュボード ビュー、ナレッジ グラフ ビュー内の選択したレコードには、プロジェクト内の特定のコンテンツ アイテム、エンティティー、またはリレーションシップにリンクする、共有可能な一意の URL があります。

マップ、リンク チャート、保存済みクエリー、データ カードを共有するには、プロジェクトを保存する必要があります。 特定のエンティティーまたはリレーションシップへの URL をすべてのプロジェクトから共有できます。

ベース URL

Knowledge Studio プロジェクトによって自動的に生成された URL を使用して、ナレッジ グラフ ビューまたは保存済みクエリー内の特定のコンテンツ アイテム、エンティティーまたはリレーションシップを共有できます。 これらの URL コンポーネントを使用して URL オーサリング パラメーターから成る URL を作成することで、新しいコンテンツを作成したり、エンティティーやリレーションシップを既存のコンテンツに追加したり、保存済みクエリーを実行することもできます。

Knowledge Studio プロジェクト URL の構造は次のようになります:

1 つ目のセクションによって Knowledge Studio に誘導されます。

https://<YourPortal>/portal/apps/knowledge-studio/main?

Knowledge Studio プロジェクト ID が疑問符 (?) の後ろに追加されます。 ポータルに保存した Knowledge Studio プロジェクトを使用している場合、そのポータル アイテム ID が使用されます。 プロジェクトを保存していない場合、プロジェクトを保存するまでは、探索しているナレッジ グラフ サービスのポータル アイテム ID がプロジェクト ID として使用されます。

id=b1ce0d5b814c40ba8809fb3625f476db

コンテンツ ID

プロジェクト ID の後ろのパラメーターはすべてアンパサンド (&) とともに追加し、そのコンテンツ アイテムに応じて追加のパラメーターでどのコンテンツ アイテムが選択されるかを指定します。 Knowledge Studio プロジェクトには各デフォルト ビュー (ダッシュボード、クエリー、ナレッジ グラフ) のいずれか 1 つだけが含まれるため、これらのビューには名前付き ID が割り当てられます。 その他すべてのコンテンツ アイテムには、プロジェクトで一意の識別子が割り当てられます。

&selectedContentId=<contentID>

コンテンツ アイテム

コンテンツ ID

ナレッジ グラフ ビュー

dataExplorer

クエリー ビュー

queryViewer

ダッシュボード ビュー

dashboard

マップとリンク チャート

コンテンツ アイテムが追加または作成されたときに cb4449dd-886c-4623-837b-7a5685a76fc7 という形式でプロジェクトごとに生成

特定のパラメーターの表示

ナレッジ グラフ ビューとクエリー ビューには、追加のコンテキストを提供する追加パラメーターを指定することもできます。 すべてのパラメーターの後ろに、等号 (=) に続けて値を指定する必要があります。

コンテンツ アイテム

追加パラメーター

値

Details

ナレッジ グラフ ビュー

selectedContentElement

選択したエンティティーまたはリレーションシップの一意識別子。

エンティティーまたはリレーションシップの URL エンコードされた一意識別子。 たとえば、ID が {B1FF2B9A6-C146-4913-A364-BC81F66A025D} である場合、中括弧 ({}) をエンコードして %7B1FF2B9A6-C146-4913-A364-BC81F66A025D%7D にする必要があります。

selectedContentInstruction

entity

relationship

その ID がエンティティーの ID であるかリレーションシップの ID であるかを示します。

クエリー ビュー

selectedContentElement

保存済みクエリーの一意識別子

保存済みクエリーが選択されている場合にのみ cb4449dd-886c-4623-837b-7a5685a76fc7 という形式で追加

ナレッジ グラフ ビュー内の特定のエンティティーに誘導する URL の例

https://<YourPortal>/portal/apps/knowledge-studio/main?id=ddd37b4f73904c7ba073d9fed75dba6c&selectedContentId=dataExplorer&selectedContentElement=%7B29018C8F-A061-4889-B5BB-77714E4ACC3D%7D&selectedContentInstruction=entity

クエリー ビュー内の特定の保存済みクエリーに誘導する URL の例。 この方法による保存済みクエリーの共有は、そのプロジェクトが保存されている場合にのみ可能です。

https://<YourPortal>/portal/apps/knowledge-studio/main?id=ddd37b4f73904c7ba073d9fed75dba6c&selectedContentId=queryViewer
&selectedContentElement=cb4449dd-886c-4623-837b-7a5685a76fc7

URL オーサリング パラメーター

別の Esri アプリ、Web マップのポップアップ、電子メールや Web サイトの単純なハイパーリンクから Knowledge Studio プロジェクトのコンテンツを作成するための追加のパラメーターを Knowledge Studio URL に指定できます。 オーサリング パラメーターでは、以下のアクションがサポートされています。

  • マップとリンク チャートの新規作成

  • 既存のマップとリンク チャートへのエンティティーとリレーションシップの追加

  • テンプレートからのマップとリンク チャートの新規作成

  • 保存済みクエリーの新規作成

  • 新規パラメーターを使用した既存の保存済みクエリーの実行

オーサリング パラメーターを使用するためのベース URL は次のとおりです:

https://<YourPortal>/portal/apps/knowledge-studio/studioApiContent?

すべてのオーサリング アクションで、疑問符の後ろに次のパラメーターを指定する必要があります:

パラメーター

値

Details

version

ArcGIS Enterprise バージョン番号

operation

createNew

addToExisting

executeQuery

createQuery

URL パラメーターを指定して実行したい操作。 コンテンツの新規作成、既存のコンテンツへの追加、クエリーの実行を行えます。

id

Knowledge Studio プロジェクト アイテム ID

または

ナレッジ グラフ サービス アイテム ID

Knowledge Studio プロジェクトまたはナレッジ グラフ サービスのポータル アイテム ID。 コンテンツを新規作成するには、Knowledge Studio プロジェクト ポータル アイテムか、ナレッジ グラフ サービス ポータル アイテムから初期化された新しい未保存のプロジェクトを使用できます。 既存のコンテンツへの追加と既存のクエリーの実行は、Knowledge Studio プロジェクト ポータル アイテムでのみ実行できます。

各操作には、実行するアクションに応じて、追加の必須パラメーターがあります。

URL エンコード

実行時にパラメーターをダッシュボードに渡すとき、必ずその値をエンコードします。 エンコードによって、無効な文字はパーセント記号 (%) と 16 進数表記に置き換えられます。 複数のパラメーターを含めるには、これらをアンパサンド (&) で区切る必要があります。

注意:

エンコードされたパラメーターを作成する方法の 1 つは、ArcGIS Arcade を使用することです。 UrlEncode 関数では、各パラメーターを表すキー値ペアのコレクションを定義して、適切なエンコードを行った URL を作成できます。

注意:

パラメーターの順序は重要ではありません。 たとえば、param=value&param2=value2 と param=value&param2=value2 は、同じ結果を生成します。

コンテンツ アイテムの新規作成

エンティティーとリレーションシップからなるマップまたはリンク チャートを Knowledge Studio プロジェクトに新規作成できます。 同じタイプの既存のコンテンツ アイテムをテンプレートとして使用して、マップまたはリンク チャートを新規作成することもできます。 新しいコンテンツは、既存のプロジェクトに作成することも、新しいプロジェクトに作成することもできます。

注意:

リンクされたポータル コンテンツ アイテムを、コンテンツ アイテムを新規作成する際のテンプレートとして使用することはできません。

既存のプロジェクトにコンテンツ アイテムを新規作成するには、id パラメーターでプロジェクト アイテム ID を指定します。 新しい未保存のプロジェクトにマップまたはリンク チャートを作成するには、id パラメーターでナレッジ グラフ サービス アイテム ID を指定します。 マップとリンク チャートを新規作成するには、次のパラメーターを使用します:

パラメーター

値

Details

entityIds

一意の ID の配列

コンテンツ アイテムに追加するエンティティーの一意識別子の配列。

relationshipIds

一意の ID の配列

コンテンツ アイテムに追加するリレーションシップの一意識別子の配列。 リレーションシップの ID だけを指定した場合、その起点エンティティーと終点エンティティーが自動的に追加されます。

contentType

map

linkChart

プロジェクトに作成するコンテンツ アイテムのタイプ

properties

linkChartProperties オブジェクト

layoutType オブジェクト

新しいリンク チャートで使用するリンク チャート レイアウト タイプ。 サポートされているレイアウト タイプについては、「レイアウト タイプ」をご参照ください。

layoutSettings オブジェクト (任意)

オーガニック レイアウトまたは時系列レイアウトのレイアウト設定。 構成可能な設定の詳細については、「レイアウト設定」をご参照ください。

contentId (任意)

Knowledge Studio プロジェクト コンテンツ ID

テンプレートとして使用するコンテンツ アイテムの ID。 指定した場合、そのコンテンツ アイテムのレイヤー定義を使用して新しいコンテンツ アイテムが作成されます。 テンプレート コンテンツ アイテムは、新しいコンテンツ アイテムと同じコンテンツ タイプでなければなりません。

layoutType のみを指定した linkChartProperties オブジェクトの例:

{ "linkChartProperties" : { "layoutType" : "force-directed" } }

地理レイアウトでの layoutSettings オブジェクトの例。 レイアウト設定は任意であり、オーガニック レイアウトと時系列レイアウトでのみサポートされています。 レイアウト設定のその他のオプションについては、「レイアウト設定」をご参照ください。 これらのオブジェクトが URL パラメーター値として機能するためには、エンコードする必要があります。

{
    "linkChartProperties":{
        "layoutType":"geographic-organic-standard",
        "layoutSettings":{
            "organicLayoutSettings": {
                "absoluteIdealEdgeLength": 5,
                "computationBudgetTime": 2,
                "autoRepulsionRadius": false,
                "idealEdgeLengthType": "absolute-value"
                "multiplicativeIdealEdgeLength": 1,
                "repulsionRadiusMultiplier": 1
            }
        }
    }
}

既存のコンテンツ アイテムへの追加

Knowledge Studio プロジェクト内の既存のマップまたはリンク チャートにエンティティーとリレーションシップを追加できます。 既存のコンテンツには Knowledge Studio プロジェクト コンテンツ アイテムを使用することによってのみ追加できます。

パラメーター

値

Details

entityIds

一意の ID の配列

コンテンツ アイテムに追加するエンティティーの一意識別子の配列

relationshipIds

一意の ID の配列

コンテンツ アイテムに追加するリレーションシップの一意識別子の配列。 リレーションシップの ID だけを指定した場合、その起点エンティティーと終点エンティティーが自動的に追加されます。

contentId

Knowledge Studio プロジェクト コンテンツ ID

追加先コンテンツ アイテムの識別子。 これは、コンテンツ アイテム タブが開いている場合に Knowledge Studio プロジェクトの URL に含まれています

クエリーの新規作成

Knowledge Studio プロジェクトにクエリーを新規作成して実行することができます。 新しいコンテンツは、既存のプロジェクトに作成することも、新しいプロジェクトに作成することもできます。

既存のプロジェクトにクエリーを新規作成するには、id パラメーターでプロジェクト アイテム ID を指定します。 新しい未保存のプロジェクトにクエリーを作成するには、id パラメーターでナレッジ グラフ サービス アイテム ID を指定します。 マップとリンク チャートを新規作成するには、次のパラメーターを使用します:

クエリーを新規作成するには、次のプロパティを使用できます:

パラメーター

値

Details

properties

name

新規作成する保存済みクエリーの名前。

openCypherQuery

実行する openCypher クエリー。 openCypher クエリーの詳細

description

(任意)

新しい保存済みクエリーの説明。

provenanceBehavior

(任意)

クエリーの結果に来歴の結果を含めるか除外するかを指定します。 指定しない場合、デフォルトは除外です。

include

exclude

bindParameters

(任意)

クエリーで使用する各パラメーターのオブジェクトの配列。 パラメーターは任意ですが、クエリーでパラメーターを使用する場合、bindParameter URL パラメーターでパラメーター情報を指定する必要があります。 各オブジェクトの URL パラメーターを次の表に示します。 クエリーでのパラメーターの使用の詳細

クエリーでのパラメーターの使用は任意ですが、クエリーでパラメーターを使用する場合、bindParameter URL パラメーターでパラメーター情報を指定する必要があります。 bindParameter は、クエリーで使用する各パラメーターのオブジェクトの配列です。 bind パラメーターのオプションの詳細

各オブジェクトの URL パラメーターを次の表に示します:

パラメーター

Details

title

(任意)

bind パラメーターのタイトル

parameterName

openCypher クエリーで使用される bind パラメーターの名前。

parameterType

bind パラメーターの値のタイプ。 このタイプは、このパラメーターを使用するクエリーでのプロパティのタイプと一致していなければなりません。 タイプは以下のとおりです:

esriBindParameterTypeString

esriBindParameterTypeNumber

esriBindParameterTypeDateTime

esriBindParameterTypeDate

esriBindParameterTypeTime

esriBindParameterTypeTimestampOffset

esriBindParameterTypeEntityId

esriBindParameterTypeRelationshipId

esriBindParameterTypeGeometry

value

bind パラメーターの値。 parameterType で指定したタイプの 1 つの値、またはそのタイプの値の配列を指定できます。

エンコード前の bind パラメーターの配列の構造の例:

"bindParameters": [
      {
        "parameterName": "facilities",
        "parameterType": "esriBindParameterTypeEntityId",
        "value": ["2344","2342"]
      }
    ]
  };

既存のクエリーの実行

Knowledge Studio プロジェクトに保存済みの既存のクエリーを実行できます。 クエリーにパラメーターがある場合、URL パラメーターを使用して新しいパラメーター値を送信できます。 既存のクエリーは Knowledge Studio プロジェクト コンテンツ アイテムを使用することによってのみ実行できます。

既存のクエリーを実行するには、次のプロパティを使用できます:

パラメーター

値

Details

storedQueryId

Knowledge Studio プロジェクトに保存済みのクエリーの ID

保存済みクエリーの ID。 これは、クエリー ビューで保存済みクエリーが選択されている場合に Knowledge Studio プロジェクトの URL に含まれています

properties

openCypherQuery

実行する openCypher クエリー。 openCypher クエリーの詳細

description

(任意)

新しい保存済みクエリーの説明。

provenanceBehavior

(任意)

クエリーの結果に来歴の結果を含めるか除外するかを指定します。 指定しない場合、デフォルトは除外です。

include

exclude

bindParameters

(任意)

クエリーで使用する各パラメーターのオブジェクトの配列。 パラメーターは任意ですが、クエリーでパラメーターを使用する場合、bindParameter URL パラメーターでパラメーター情報を指定する必要があります。 各オブジェクトの URL パラメーターを次の表に示します。 クエリーでのパラメーターの使用の詳細

クエリーでのパラメーターの使用は任意ですが、クエリーでパラメーターを使用する場合、bindParameter URL パラメーターでパラメーター情報を指定する必要があります。 bindParameter は、クエリーで使用する各パラメーターのオブジェクトの配列です。 bind パラメーターのオプションの詳細

各オブジェクトの URL パラメーターを次の表に示します:

パラメーター

Details

title

(任意)

bind パラメーターのタイトル

parameterName

openCypher クエリーで使用される bind パラメーターの名前。

parameterType

bind パラメーターの値のタイプ。 このタイプは、このパラメーターを使用するクエリーでのプロパティのタイプと一致していなければなりません。 タイプは以下のとおりです:

esriBindParameterTypeString

esriBindParameterTypeNumber

esriBindParameterTypeDateTime

esriBindParameterTypeDate

esriBindParameterTypeTime

esriBindParameterTypeTimestampOffset

esriBindParameterTypeEntityId

esriBindParameterTypeRelationshipId

esriBindParameterTypeGeometry

value

bind パラメーターの値。 parameterType で指定したタイプの 1 つの値、またはそのタイプの値の配列を指定できます。

エンコード前の bind パラメーターの配列の構造の例:

"bindParameters": [
      {
        "parameterName": "facilities",
        "parameterType": "esriBindParameterTypeEntityId",
        "value": ["2344","2342"]
      }
    ]
  };