タスク パラメータのプロパティ（REST）

各ジオプロセシング タスクには 1 つ以上のパラメータがあります。各タスク パラメータには、説明的な名前のプロパティが用意されています。これらのプロパティは、パラメータの理解に役立つとともに、タスク実行の成功のために適切な値を提供します。次のスクリーン キャプチャは、Services Directory のジオプロセシング タスク ページに表示されるタスク パラメータ Distance の例です。各プロパティの意味について次に説明します。

タスク パラメータ プロパティ

データ タイプ

パラメータのデータ タイプは、クライアントがパラメータに対して提供する必要がある値のタイプを示します。パラメータの値は、string、long、double、Boolean、date のように単純なタイプであるか、フィーチャセット（フィーチャクラスと同様に、属性を持つフィーチャのコレクション）、テーブル、またはラスタのいずれかになります。たとえば、データ タイプが、-2,147,483,648 ～ 2,147,483,647 の範囲内の数値を指定する必要がある long である場合に、他の 10 進値や文字列値を指定すると、ツールの予期しない動作が発生します。同様に、ラスタ データ タイプの場合にツールを正常に実行するには、適切なラスタ データを指定する必要があります。次のリストに、タスク パラメータのデータ タイプとその期待値を示します。

データ タイプ 値 JSON 表現の例

GPLong

-2,147,483,648 ～ 2,147,483,647 の範囲内の整数値

345

GPDouble

10 進値

1.414

GPString

文字列

TestString

GPBoolean

true または false

true

GPLinearUnit

距離値とその計測単位（マイル、キロメートル、フィートなど）を持つ値

{ "distance" : 345.678, "units" : "esriMiles" }

GPDate

紀元（1970 年 1 月 1 日（UTC））からの経過秒数を表す数字

1199145600000

GPDataFile

*.txt、*.pdf、*.csv などの任意のファイル タイプ

{ "url" : "http://myserver/myfile" }

GPRasterDataLayer

行と列（グリッド）に整理されたセル（ピクセル）のマトリックスで構成されるラスタ データ。この場合、各セルには情報を表す値が含まれます。

{ "url" : "http://myserver/lake.tif", "format" : "tif" }

GPRecordSet

行と列で表現されるテーブル

 

{
"fields":[{"name":"Id","type":"esriFieldTypeString","alias":"Id"},
{"name":"State_Name","type":"esriFieldTypeString","alias":"State
Name"},
{"name":"State_Abbr","type":"esriFieldTypeString","alias":"State
Abbr"}],
"features" : [
 { "attributes" : {"Id" : 43, "State_Name" :
"California","State_Abbr":"CA"},
{ "attributes" : {"Id" : 67, "State_Name" :
"Colorado","State_Abbr":"CO"}]}
TypeString","alias":"Id"},








GPFeatureRecordSetLayer




ジオメトリ、空間参照、フィールド定義、およびフィーチャを保持するフィーチャ




GPFeatureRecordSetLayer JSON
{ 
"geometryType" : "esriGeometryPoint",
"fields":[
  {"name":"Id","type":"esriFieldTypeOID","alias":"Id"},
  {"name":"Name","type":"esriFieldTypeString","alias":"Name"}],
"spatialReference" : {"wkid" : 4326},
"features" : [
    { "geometry" : {"x" : -104.44, "y" : 34.83,
           "spatialReference" : {"wkid" : 4326}}, 
      "attributes" : 
           {"Id" : 43,"Name" : "Feature 1"}},
    { "geometry" : {"x" : -100.65, "y" : 33.69,
            "spatialReference" : {"wkid" : 4326}},
      "attributes" : 
           {"Id" : 42,"Name" : "Feature 2"}}
    ]
}











GPMultiValue




同じデータ タイプの GP パラメータ値の配列


例: GPMultiValue:GPString、GPMultiValue:GPLinearUnit




["Parcels", "Street Lights"]
[ { "distance" : 345.67, "units" : "esriMiles" }, { "distance" : 36, "units" : "esriMiles" } ]




注意注意:
  • GPRecordSet と GPFeatureRecordSetLayer のパラメータについては、多数のレコードやフィーチャが存在する場合に、ファイルに JSON 構造を格納して、入力として URL を提供できます（{ "url" : "http://myserver/myfeatures/afile.txt"} など）。. このテキスト ファイルには、フィーチャセットとレコードセットが JSON フォーマットで含まれている必要があります。
  • GPMultiValue:GPFeatureRecordSetLayer データ タイプの場合は、実行が成功するためにフィーチャセットにフィールド定義が含まれている必要があります。 



表示名
表示名はパラメータのわかりやすい名前です。
方向
方向は、パラメータが入力または出力パラメータのどちらに該当するかを識別するのに役立ちます。
タスクを実行する際、クライアントは入力パラメータの値のみを提供する必要があります。タスクが正常に実行されると、サーバによって出力パラメータが作成され、クライアントはこれらの出力パラメータの値にアクセスできます。
デフォルト値
ジオプロセシング サービスの公開時に、成功したジオプロセシング ツール結果からジオプロセシング タスクが作成されます。デフォルト値には、タスクの作成元になった結果に含まれるパラメータの値が表示されます。入力パラメータのデフォルト値は、タスクの実行が成功するために渡される必要があるパラメータ値の例であり、出力パラメータのデフォルト値は、タスクからの期待される出力の例です。
パラメータ タイプ
パラメータ タイプには、次の 3 種類があります。


    

  1.  esriParameterTypeRequired:パラメータは、実行が成功するために必須です。クライアントは、タスクのリソースに対して操作を実行するときにパラメータの値を提供する必要があります。
    2. 

  2. esriParameterTypeOptional:パラメータは、実行が成功するために必須ではありません。
  3. esriParameterTypeDerived:パラメータ値は、他の入力パラメータから取得される出力パラメータであるため、クライアントは値を提供する必要はありません。


カテゴリ
入力および出力パラメータが多数存在する場合、通常、それらのパラメータは、ツール作成者が理解しやすいように特定のカテゴリにグループ化されます。次のスクリーン キャプチャは、ArcGIS for Desktop のツール ダイアログ ボックスで表示されるカテゴリの例です。
カテゴリ プロパティ
カテゴリは、ツール作成者の設計に従って、パラメータが特定のカテゴリに属するかどうかを規定します。カテゴリの値は、ジオプロセシング タスク用のウィジェットを設計するときに使用できます。
選択リスト
一部の GPString パラメータには、追加の選択リスト プロパティが示されます。選択リストは、ツールの実行が成功するために公開者によって指定される定義済みの値のセットです。実行が成功するには、クライアントが、選択リストから値の 1 つを選択する必要があります。クライアントが選択リストの値以外の値を提供した場合は、タスクが失敗します。次のスクリーン キャプチャは、GPString パラメータ Transportation_mode_network 用の選択リストの値 Street network、Bike network、Walk network を示しています。このような選択リストの値が表示された場合、クライアントは、実行の成功のためにそれらの値の中から 1 つを選択しなければなりません。
選択リスト プロパティ
タスク公開時におけるパラメータの選択リストの値の作成に関する詳細


関連トピック
ジオプロセシング タスク（REST）の概要
 Copyright © 1995-2013 Esri. All rights reserved. 
9/15/2013