Image Processing - Create Rasterize Job

サービス:

Azure Data Manager for Agriculture

API バージョン:

2023-11-01-preview

ImageProcessing Rasterize ジョブを作成します。

PUT {endpoint}/image-processing/rasterize/{jobId}?api-version=2023-11-01-preview

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string uri	名前空間のホスト名 (例: admaInstanceName.farmbeats.azure.net)
jobId	path	True	string	ユーザーによって提供される JobId。
api-version	query	True	string	要求された API バージョン

要求ヘッダー

名前	必須	型	説明
Authorization	True	string	承認された API 呼び出しに対して有効なベアラー トークンを指定してください。 以前に認証されていない呼び出しを試した場合は、ブラウザー キャッシュをクリアする必要がある場合があることに注意してください。

要求本文

名前	必須	型	説明
partyId	True	string	パーティ ID。
shapefileAttachmentId	True	string	シェープファイルの添付ファイル ID。
shapefileColumnNames	True	string[]	ラスター 添付ファイルを作成するためのシェープファイル列名の一覧。
description		string	リソースの説明テキスト。
name		string	リソースを識別する名前
properties			リソースに属するキー値ペアのコレクション。 各ペアには、50 文字を超えるキーを持つ必要があり、150 文字を超える値を持つ必要があります。 注: リソースには最大 25 個のキー値ペアを指定でき、文字列、数字、datetime (yyyy-MM-ddTHH:mm:ssZ) 値のみがサポートされます。

応答

名前	型	説明
202 Accepted	ImageProcessingRasterizeJob	同意
Other Status Codes	ErrorResponse	エラー ヘッダー x-ms-error-code: string

セキュリティ

Authorization

承認された API 呼び出しに対して有効なベアラー トークンを指定してください。 以前に認証されていない呼び出しを試した場合は、ブラウザー キャッシュをクリアする必要がある場合があることに注意してください。

型: apiKey
/: header

例

ImageProcessing_CreateRasterizeJob

要求のサンプル

HTTP

PUT {endpoint}/image-processing/rasterize/JOB123?api-version=2023-11-01-preview

{
  "partyId": "string",
  "shapefileAttachmentId": "string",
  "shapefileColumnNames": [
    "string"
  ]
}

応答のサンプル

状態コード:

202

{
  "partyId": "string",
  "shapefileAttachmentId": "string",
  "shapefileColumnNames": [
    "string"
  ],
  "name": "string",
  "description": "string",
  "properties": {
    "key1": "value1",
    "key2": 123.45
  }
}

定義

名前	説明
Error	Azure AgPlatform サービスからのエラー。
ErrorResponse	Azure AgPlatform サービスからのエラー応答。 ErrorResponse リファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses してください。
ImageProcessingRasterizeJob	イメージ処理: シェープファイルを tiff ファイルに変換するラスター化ジョブ。
InnerError	エラーの一覧を含む内部エラー。InnerError リファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。

Error

Azure AgPlatform サービスからのエラー。

名前	型	説明
code	string	サーバー定義のエラー コードのセット。
details	Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	InnerError	エラーの一覧を含む内部エラー。InnerError リファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。
message	string	人が判読できるエラーの表現。
target	string	エラーのターゲット。

ErrorResponse

Azure AgPlatform サービスからのエラー応答。 ErrorResponse リファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses してください。

名前	型	説明
error	Error	Azure AgPlatform サービスからのエラー。
traceId	string	一意のトレース ID。

ImageProcessingRasterizeJob

イメージ処理: シェープファイルを tiff ファイルに変換するラスター化ジョブ。

名前	型	説明
createdBy	string	ユーザー/テナント ID によって作成されます。
createdDateTime	string	dateTime で作成されたジョブ。 サンプル形式: yyyy-MM-ddTHH:mm:ssZ。
description	string	リソースの説明テキスト。
durationInSeconds	number	ジョブの実行時間 (秒単位)。
endTime	string	ジョブの終了時刻 (使用可能な場合)。 サンプル形式: yyyy-MM-ddTHH:mm:ssZ。
errorCode	string	ジョブが失敗した場合のエラー コード。
id	string	一意のジョブ ID。
lastActionDateTime	string	ジョブは dateTime で最後に処理されました。 サンプル形式: yyyy-MM-ddTHH:mm:ssZ。
message	string	ジョブの詳細をキャプチャするステータス メッセージ。
modifiedBy	string	ユーザー/テナント ID によって変更されます。
name	string	リソースを識別する名前
partyId	string	パーティ ID。
properties		リソースに属するキー値ペアのコレクション。 各ペアには、50 文字を超えるキーを持つ必要があり、150 文字を超える値を持つ必要があります。 注: リソースには最大 25 個のキー値ペアを指定でき、文字列、数字、datetime (yyyy-MM-ddTHH:mm:ssZ) 値のみがサポートされます。
shapefileAttachmentId	string	シェープファイルの添付ファイル ID。
shapefileColumnNames	string[]	ラスター 添付ファイルを作成するためのシェープファイル列名の一覧。
startTime	string	ジョブの開始時刻 (使用可能な場合)。 サンプル形式: yyyy-MM-ddTHH:mm:ssZ。
status	string	ジョブの状態。 指定できる値は、'Waiting'、'Running'、'Succeeded'、'Failed'、'Cancelled' です。

InnerError

エラーの一覧を含む内部エラー。InnerError リファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。

名前	型	説明
code	string	を含むエラーによって提供されたエラー コードよりも具体的なエラー コード。
innererror	InnerError	エラーの一覧を含む内部エラー。InnerError リファレンス ドキュメントを参照 https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object してください。