ルート要素および属性

XML メッセージのルート要素は、通信に使用するチャネルまたはサービスに指定されているオブジェクト構造および操作に基づいています。 ルート要素には、1 つ以上の属性を含めることができます。

次の表に、ルート要素に適用できる属性を示します。 属性名と値には大/小文字の区別があります。 属性はすべてオプションです。

属性 説明 タイプ 適用先
baselanguage

コンテンツの値が指定される基本言語。

ストリング

すべての入出力操作

creationDateTime

コンテンツが生成された日時。

dateTime

すべての入出力操作

maximoVersion

すべてのパブリッシュ済み XML に対して生成されるメジャー・バージョン、マイナー・バージョン、ビルド、およびデータベースのビルド。

MaximoVersionType

すべての入出力操作

messageID

すべてのメッセージに対して生成される固有 ID。

ストリング

すべての入出力操作

transLanguage

複数言語対応のフィールドに値が指定される言語。

ストリング

すべての入出力操作

event

アウトバウンド XML メッセージの発信元。 有効な値は以下のとおりです:

  • 0 (False)。データのエクスポート機能によってメッセージが生成されたことを示します。
  • 1 (True)。アウトバウンド統合イベント・リスナー (つまり、アプリケーションでのデータ入力) によってメッセージが生成されたことを示します。

eventType

すべての出力操作

uniqueResult

クエリーが応答で 1 つのレコードまたは複数のレコードのどちらを予期するかを指定します。 値が 0 であるか、属性が指定されていない場合、クエリーは複数のレコードを返すことができます。 値が 1 である場合、クエリーが返すことができるのは 1 つのレコードのみであり、それ以外の場合はエラーが発生します。

ブール値

クエリー (入力)

maxItems

クエリーが複数のレコードを返すことができる場合、この属性は、一度に返されるレコード数を制限します。 この属性が指定されていない場合、応答には結果セット全体が含まれます。

positiveInteger

クエリー (入力)

rsStart

応答時に返す最初のレコードを指定します。 指定しなかった場合、応答は結果セットの最初のレコードから開始されます。 結果セット内の結果の数が rsStart 値より小さい場合、応答はレコードを返しません。

maxItems 値を指定した場合は、rsStart 値から始まる、指定された数のレコードが応答で返されます (rsStart を指定した場合)。

例えば、maxItems=10 および rsStart が指定されていない場合、応答は結果 1 から 10 を戻します。 結果 11 から 20を受け取るには、rsStart=11 を指定して照会を再送してください。

整数

クエリー (入力)

rsStart

この値は、対応するクエリーの rsStart 値と一致します。

クエリーに maxItems 値が含まれる場合、追加レコードを求める要求の rsStart 値は、rsStart + rsCount + 1 になります。

この属性が指定されていない場合、応答は結果セットの最初のレコードから開始し、rsCount 属性によって指定されたレコード数を含みます。

整数

応答 (出力)

rsCount

メッセージで返されるレコード数。 元のクエリーで maxItems 値が指定されている場合、追加レコードにある後続の要求の rsStart 値は rsStart + rsCount + 1 です。

整数

応答 (出力)

rsTotal

結果セットの合計レコード数。 クエリーが maxItems 値を指定しない場合、rsTotal 値は rsCount 値と同じです。

整数

応答 (出力)