フィルタ:
検索を送信

OData サービス実行(PATCH)

オペレーション名

ODataサービス実行(PATCH)

機能概要

SAP S/4HANAのODataサービスAPIをHTTPのPATCHメソッドで実行します。

データモデル

本コンポーネントのデータモデルはXML型です。

プロパティ

= 備考 =

変数の使用については、「変数」を参照してください。

基本設定

項目名

必須/省略可

変数の使用

説明

備考

名前

必須

使用不可

スクリプトキャンバス上での名前を入力します。

 

必須設定

項目名

必須/省略可

変数の使用

説明

備考

接続先

必須

使用不可

コネクションリソースを選択します。

[追加]

新規にコネクションリソースを追加します。

[一覧の編集]

> HULFT INTEGRATE > コネクションで、コネクションリソースの設定を編集することができます。

 

認証方式

必須

使用不可

ODataサービスを実行する際の認証方式を選択します。

[OAuth 2.0認証]

(デフォルト)

OAuth 2.0認証で実行します。

[ベーシック認証]

ベーシック認証で実行します。

 

OAuth 2.0認証設定

必須

使用不可

コネクションリソースを選択します。

[追加]

新規にコネクションリソースを追加します。

[一覧の編集]

> HULFT INTEGRATE > コネクションで、コネクションリソースの設定を編集することができます。

  • [認証方式]に[OAuth 2.0認証]を選択した場合、表示されます。

ベーシック認証設定

必須

使用不可

コネクションリソースを選択します。

[追加]

新規にコネクションリソースを追加します。

[一覧の編集]

> HULFT INTEGRATE > コネクションで、コネクションリソースの設定を編集することができます。

  • [認証方式]に[ベーシック認証]を選択した場合、表示されます。

エンティティタイプ

必須

使用可

読み取るリソースパスの型となるエンティティタイプを選択または入力します。

 

プロパティ一覧

必須

-

[エンティティタイプ]で指定したエンティティタイプのプロパティ一覧を表示します。

 

プロパティ一覧/入力スキーマ対象

必須

使用不可

入力スキーマ対象に含めるかどうかを選択します。

[チェックあり]

(デフォルト)

入力スキーマ対象に含めます。

[チェックなし]

入力スキーマ対象に含めません。

  • チェックを入れたプロパティの名前がMapperのスキーマに表示されます。

  • ヘッダに表示されたチェックボックスをクリックすることで、一括操作を行うことができます。

  • 1つ以上のプロパティにチェックが入っている必要があります。

プロパティ一覧/キー

必須

使用不可

プロパティがキーかどうかを表示します。

 

プロパティ一覧/名前

必須

使用不可

プロパティの名前を表示します。

 

プロパティ一覧/Edm.Type

必須

使用不可

プロパティのEdm.Typeを表示します。

 

プロパティ一覧/Null許容

必須

使用不可

プロパティがNullを許容するかどうかを表示します。

 

リソースパス

必須

使用可

実行対象となるODataサービスAPIのリソースパスを入力します。

 

エンティティキー一覧

必須

-

[エンティティタイプ]で指定したエンティティタイプのエンティティキー一覧を表示します。

  • [エンティティキーをリソースパスに含める]が[チェックあり]の場合、有効になります。

エンティティキー一覧/名前

必須

使用不可

エンティティキーの名前を表示します。

 

エンティティキー一覧/Edm.Type

必須

使用不可

エンティティキーのEdm.Typeを表示します。

 

エンティティキー一覧/値の指定方式

必須

使用不可

エンティティキーの値の指定方式を選択します。

[直接指定]

(デフォルト)

[エンティティキー一覧/値]に入力された値をエンティティキーとして参照します。

[入力データ]

入力データの値をエンティティキーとして参照します。

 

エンティティキー一覧/値

省略可

使用不可

エンティティキーの値を入力します。

  • [エンティティキー一覧/値の指定方式]が[入力データ]の場合、入力された値は無視されます。

プロパティアクション

項目名

説明

備考

エンティティタイプ一覧を取得

指定した接続先のODataサービスからメタデータを取得して、[エンティティタイプ]に設定します。

  • 以下のプロパティ項目がすべて設定されている場合、有効になります。

    • [接続先]

    • [ベーシック認証設定]または[OAuth 2.0認証設定]

エンティティタイプからプロパティ一覧を取得

指定したエンティティタイプからプロパティ一覧を取得して、[プロパティ一覧]に設定します。

  • 以下のプロパティ項目がすべて設定されている場合、有効になります。

    • [接続先]

    • [ベーシック認証設定]または[OAuth 2.0認証設定]

    • [エンティティタイプ]

リクエスト設定

項目名

必須/省略可

変数の使用

説明

備考

クエリパラメーター

省略可

-

リクエストに含めるクエリパラメーターを指定します。

各クエリパラメーターは以下のボタンで操作することができます。

[上へ]

選択しているクエリパラメーターの順序を一つ上に上げます。

[下へ]

選択しているクエリパラメーターの順序を一つ下に下げます。

[追加]

クエリパラメーターを追加します。

[削除]

クエリパラメーターを削除します。

 

クエリパラメーター/名前

省略可

使用可

クエリパラメーターの名前を入力します。

  • 省略した場合、クエリパラメーターはリクエストに含まれません。

クエリパラメーター/値

省略可

使用可

クエリパラメーターの値を入力します。

 

リクエストヘッダ

省略可

-

リクエストに含めるHTTPヘッダを指定します。

各リクエストヘッダは以下のボタンで操作することができます。

[追加]

リクエストヘッダを追加します。

[上へ]

選択しているリクエストヘッダの順序を一つ上に上げます。

[下へ]

選択しているリクエストヘッダの順序を一つ下に下げます。

[削除]

リクエストヘッダを削除します。

 

リクエストヘッダ/名前

省略可

使用可

リクエストヘッダの名前を入力します。

  • 省略した場合、リクエストヘッダはリクエストに含まれません。

リクエストヘッダ/値

省略可

使用可

リクエストヘッダの値を入力します。

 

同時実行制御を有効にする

省略可

使用不可

同時実行制御を有効にするかどうかを選択します。

[チェックあり]

(デフォルト)

同時実行制御を有効にします。

[チェックなし]

同時実行制御を無効にします。

 

ETag送信設定

省略可

使用不可

If-Matchヘッダに指定する値の指定方式を選択します。

[If-Matchヘッダにワイルドカード文字(*)を指定する]

(デフォルト)

If-Matchヘッダに、ワイルドカード文字(*)を指定します。

[If-MatchヘッダにETag値を指定する]

If-Matchヘッダに、[ETag値]に入力された値を指定します。

  • [同時実行制御を有効にする]が[チェックあり]の場合、有効になります。

ETag値

省略可

使用可

If-Matchヘッダに指定するETag値を入力します。

  • [ETag送信設定]で[If-MatchヘッダにETag値を指定する]が選択されている場合、有効になります。

レスポンス設定

項目名

必須/省略可

変数の使用

説明

備考

レスポンスのステータスコードが4xx、5xxの場合エラーにする

省略可

使用不可

レスポンスのステータスコードが「4xx」または「5xx」の場合、処理をエラーにするかどうかを選択します。

[チェックあり]

処理をエラーにします。

[チェックなし]

(デフォルト)

処理をエラーにしません。

 

レスポンスヘッダ

省略可

-

レスポンスに含まれるHTTPヘッダのうち、取得したいヘッダの名前を指定します。

各レスポンスヘッダは以下のボタンで操作することができます。

[追加]

レスポンスヘッダを追加します。

[上へ]

選択しているレスポンスヘッダの順序を一つ上に上げます。

[下へ]

選択しているレスポンスヘッダの順序を一つ下に下げます。

[削除]

レスポンスヘッダを削除します。

  • レスポンスヘッダは[名前]で入力した名前のコンポーネント変数として定義されます。

レスポンスヘッダ/名前

省略可

環境変数のみ使用可

レスポンスヘッダの名前を入力します。

  • 大文字小文字は区別しません。

  • 省略した場合、コンポーネント変数として定義されません。

  • 名前の前後に半角空白・タブ・改行がある場合、トリムしてコンポーネント変数として定義されます。

データ処理方式

項目名

必須/省略可

変数の使用

説明

備考

データ処理方式

必須

使用不可

データ処理方式を選択します。

[スクリプトの設定を使用する]

(デフォルト)

スクリプトプロパティの大容量データ処理の設定をコネクターに使用します。

[大容量データ処理を行わない]

大容量データ処理を行いません。

[大容量データ処理を行う]

大容量データ処理を行います。

 

コメント

項目名

必須/省略可

変数の使用

説明

備考

コメント

省略可

使用不可

このコネクターの簡単な説明を記述することができます。

 

スキーマ

OData V2

入力スキーマ 

<?xml version="1.0" encoding="utf-8"?>
<entry xmlns="http://www.w3.org/2005/Atom"
       xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"
       xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
    <content>
        <m:properties>
            <d:プロパティ名 m:null="" />
        </m:properties>
    </content>
</entry>

要素名

属性名

必須/省略可

説明

備考

entry

-

必須

 

 

content

-

必須

 

 

m:properties

-

必須

 

 

d:プロパティ名

-

必須

プロパティ値を入力します。

 

m:null

省略可

プロパティ値がnullの場合「true」を入力します。

省略した場合「false」になります。

出力スキーマ 

<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices"
      xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
    <entry>
        <content>
            <m:properties>
                <d:プロパティ名 m:null="" />
            </m:properties>
        </content>
    </entry>
</feed>

要素名

属性名

説明

備考

feed

-

 

 

entry

-

 

 

content

-

 

 

m:properties

-

 

 

d:プロパティ名

-

レスポンスで返ってきたエンティティのプロパティ値を出力します。

 

m:null

プロパティ値がnullの場合「true」を出力します。

 

OData V4

入力スキーマ 

<?xml version="1.0" encoding="utf-8"?>
<root>
    <value>
        <!-- Edm.Typeがプリミティブ型の場合 -->
        <<プロパティ名 null="" />
        <!-- Edm.TypeがCollectionの場合 -->
        <Collectionのプロパティ名>
            <item>
                <プロパティ名 null="" />
            </item>
        </Collectionのプロパティ名 />
    </value>
</root>

要素名

属性名

必須/省略可

説明

備考

root

-

必須

 

 

value

-

必須

 

 

プロパティ名

-

必須

エンティティのプロパティ値を入力します。

 

null

省略可

プロパティ値がnullの場合「true」を入力します。

省略した場合「false」になります。

item

-

省略可

Edm.TypeがCollectionの場合、コレクションの要素を表します。

省略した場合、空のコレクションになります。

出力スキーマ 

<?xml version="1.0" encoding="utf-8"?>
<root>
    <value>
        <!-- Edm.Typeがプリミティブ型の場合 -->
        <プロパティ名 null="" />
        <!-- Edm.TypeがCollectionの場合 -->
        <Collectionのプロパティ名>
            <item>
                <プロパティ名 null="" />
            </item>
        </Collectionのプロパティ名 />
    </value>
</root>

要素名

属性名

説明

備考

root

-

 

 

value

-

 

 

プロパティ名

-

レスポンスで返ってきたエンティティのプロパティ値を出力します。

 

null

プロパティ値がnullの場合「true」を出力します。

 

item

-

Edm.TypeがCollectionの場合、コレクションの要素を表します。

 

Mapperでのスキーマ読み込み

スキーマは自動で読み込まれます。

= 備考 =

自動で読み込まれたスキーマは編集可能です。

詳細については、「スキーマ編集」を参照してください。

大容量データ処理

大容量データ処理に対応しています。

トランザクション

トランザクションはサポートしていません。

PSPでの使用について

PSPでは使用できません。

使用できるコンポーネント変数

コンポーネント変数名

説明

備考

status_code

レスポンスのHTTPステータスコードが格納されます。

  • デフォルト値はnullです。

error_response_body

レスポンスのステータスコードが「4xx」または「5xx」の場合のレスポンスボディが格納されます。

  • デフォルト値はnullです。

message_category

エラー発生時、発生したエラーに対応するメッセージコードのカテゴリが格納されます。

  • デフォルト値はnullです。

message_code

エラー発生時、発生したエラーに対応するメッセージコードのコードが格納されます。

  • デフォルト値はnullです。

message_level

エラー発生時、発生したエラーに対応するメッセージコードの重要度が格納されます。

  • デフォルト値はnullです。

error_type

エラー発生時、発生したエラーの種類が格納されます。

  • デフォルト値はnullです。

  • エラーの種類は、以下のような形式となります。

    例:「java.io.FileNotFoundException」

error_message

エラー発生時、発生したエラーのメッセージが格納されます。

  • デフォルト値はnullです。

error_trace

エラー発生時、発生したエラーのトレース情報が格納されます。

  • デフォルト値はnullです。

メッセージコード、例外メッセージ、制限事項

コネクター

メッセージコード

エラーメッセージ

制限事項

SAP ODataコネクターのメッセージおよび制限事項

check

check

check

サイトポリシー     (c) Saison Technology Co.,Ltd. 2021

TOP