ジャンプ先

• リクエスト
• レスポンス
• 例

指定された索引のレコードを分類するためのサービス。

post

/spatialviewer/api/v1/spark/categorize

このサービスでは、特定の索引のレコードが分類され、マップに表示する必要がある情報を示す結果が返されます。可能な分類操作は、次のように使用できます。

• カウント操作では、RenderingOptionsに定義される属性名は必要ありません。
• 数値属性およびテキスト属性の場合は、平均を使用できます。
• 数値属性の平均がテンプレート機能ごとの平均値に応じてレンダリングされます。テキスト値の場合、テンプレート機能の数が多いテキスト値に応じてレンダリングが行われます。
• 合計は、数値属性でのみ使用できます。
• カウントでは、テンプレート機能ごとのレコード数に基づいてビューが作成されます。

リクエスト

サポートされるメディア・タイプ

• application/json

問合せパラメータ

• asynchronous: boolean
  trueの場合、この操作は非同期で実行されます。

  デフォルト値: false
• attributeName: string
  カテゴリ化アイテムの色を値に応じてレンダリングする属性の名前。
• catOperation: string
  カテゴリ化操作。指定できる値は、average、countおよびsumです。デフォルト値はaverageです。

  デフォルト値: average
• indexPath: string
  HDFS内の索引パスです。
• isRenderingByAttributeNumber: boolean
  trueの場合、attributeName属性は数値です。falseの場合、attributeNameはテキスト値の属性として処理されます。

  デフォルト値: false
• limits: string
  制限をJSON文字列として設定します。たとえば、[{ "lowerLimit": 1, "upperLimit": 2}, { "lowerLimit": 2, "upperLimit": 3}]のようになります。色配列との関係は1対1である必要がありますオプションのパラメータ。
• maxAttributeValue: number
  カテゴリ化アイテムの可能な最大値。オプションのパラメータ。

  デフォルト値: 0
• minAttributeValue: number
  カテゴリ化アイテムの可能な最小値。オプションのパラメータ。

  デフォルト値: 0
• outputPath: string
  ジョブの出力パス。
• renderColors: string
  カテゴリ化アイテムの指定可能な色を設定します。デフォルトでは、色は#225d98、#D3D3D3、#ffa500、#600000です。オプションのパラメータ。
• templateFile: string
  テンプレート・ファイル(たとえば、world_countries.json)。使用可能なテンプレートは、フォルダ/opt/oracle/oracle-spatial-graph/spatial/web-server/spatialviewer/templates/にあります。
• textAttributeValues: string
  カンマで区切られた、使用可能なテキスト属性の値を設定します。色配列との関連は1対1である必要があります。つまり5つの値が候補として定義された場合、5色が定義される必要があります。例: very high,high,medium,low,very low.オプションのパラメータ。
• tolerance: number
  空間操作を実行するときに使用される許容差を表すdouble値。例: 0.05

  デフォルト値: 0.05

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200レスポンス

要求が成功しました。

レスポンスには、HDFS内の結果の場所が含まれています。

さらに、ジョブが完了すると、結果はSpatialViewerのローカル作業ディレクトリ(SpatialViewer構成を参照)に含まれているフォルダcategorization_resultsに保存されます。

本文()

ルート・スキーマ: SparkCatJobResponse

型: object

ソースの表示

• o:successCode(optional): string
  成功コード。

  例: SV-05015
• response(optional): string
  レスポンスには、HDFS内の結果の場所が含まれています。

  例: hdfs://<namenode>:8020/user/oracle/spatialviewer/catResult
• status(optional): string
  成功またはエラー

  例: success
• title(optional): string
  サービスのタイトル。

  例: Categorize job.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"success"
        },
        "title":{
            "type":"string",
            "description":"Service title.",
            "example":"Categorize job."
        },
        "o:successCode":{
            "type":"string",
            "description":"The success code.",
            "example":"SV-05015"
        },
        "response":{
            "type":"string",
            "description":"The response contains the location of the results in HDFS.",
            "example":"hdfs://<namenode>:8020/user/oracle/spatialviewer/catResult"
        }
    }
}

202レスポンス

非同期リクエストを受け入れました

本文()

ルート・スキーマ: AsyncSparkCatJobResponse

型: object

ソースの表示

• o:successCode(optional): string
  成功コード。

  例: SV-05015
• response(optional): string
  レスポンスには、ジョブを追跡するためのリソース・マネージャWebアプリケーションのURLの場所が含まれています(Hadoopパラメータyarn.resourcemanager.webapp.addressの構成を参照してください)。

  例: http://resource.manager.webapp:8088
• status(optional): string
  成功またはエラー

  例: success
• title(optional): string
  サービスのタイトル。

  例: Categorize job.

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"success or error",
            "example":"success"
        },
        "title":{
            "type":"string",
            "description":"Service title.",
            "example":"Categorize job."
        },
        "o:successCode":{
            "type":"string",
            "description":"The success code.",
            "example":"SV-05015"
        },
        "response":{
            "type":"string",
            "description":"The response contains the location of the resource manager web application URL to track the job (see in the configuration the Hadoop parameter yarn.resourcemanager.webapp.address).",
            "example":"http://resource.manager.webapp:8088"
        }
    }
}

先頭に戻る

例

次の例では、cURLを使用してRESTリソースに対するPOSTリクエストを発行することによって、カテゴリ化を実行する方法を示しています。

curl -v -X POST "http://localhost:8045/spatialviewer/api/v1/spark/categorize?indexPath=/user/oracle/tweetsJanuary&outputPath=/user/oracle/spatialviewer/CatTweets&isRenderingByAttributeNumber=true&attributeName=followers_count&templateFile=world_countries.json" -H  "accept: application/json" 

レスポンス・ヘッダーの例

次に、レスポンス・ヘッダーの例を示します。

HTTP/1.1 200 OK Date: Wed, 15 Nov 2017 17:50:38 GMT Access-Control-Allow-Origin: * Access-Control-Allow-Credentials: true Access-Control-Allow-Methods: GET, POST, DELETE, PUT Access-Control-Allow-Headers: Content-Type, Accept Transfer-Encoding: chunked  Content-Type: application/json

レスポンス本文の例

次の例は、レスポンス本文の内容をJSON形式で示したものです。

{"status" : "success", "title" : "Categorize job.", "o:successCode" : "SV-05015", "response" : "hdfs://system4.example.com:8020/user/oracle/spatialviewer/CatTweets"} 

先頭に戻る