REST ダイナミックコネクターのプロパティ


プロパティ 説明
ベース ユーザー URI REST サービスへのサーバーとエンドポイントのルート
すべてのユーザー GET の URI すべてのユーザーを読み込むルート。このプロパティは必須です。1 人のユーザーの GET と PUT に同じ URI を使用する場合、{id} を使ってユーザー キーの場所を特定します。例: /api/v1/users
すべてのユーザー パターンの GET

同期のためにすべてのユーザーを取得するパターン。 USER_DATA とは、すべてのユーザー データが「すべてのユーザーの GET の URI」とともに返されることを意味します。

1 人のユーザー GET の URI 1 人のユーザーを読み込むルート。デフォルトは、すべてのユーザー GET の URI の最後に ID を追加して使用するものです。ユーザー キーの場所を特定するために、{id} を使用します。例: /api/v1/users/{id}
1 人のユーザー GET のパターン

このパターンは 1 人のユーザー GET のための URI を使って 1 人のユーザーを取得します。

  • ARRAY — ユーザー オブジェクトがアレイにあることを予想します。
  • OBJECT — ユーザー オブジェクトがアレイを含まずに返されることを予想します。
更新 URI ユーザー データを更新するルート。デフォルトは 1 人のユーザー GET のための URI です。ユーザー キーの場所を特定するために、{id} を使用します。
更新パターン

ユーザー データの更新パターンです。更新パターンには 3 つの部分があり、以下の順序にする必要があります。

  1. METHOD — REST の更新メソッドで、PUT、POST、または PATCH です。
  2. DATAUPDATE — ユーザーのすべての値が更新時、または変更時のみに送信されるかどうかを決めます。
  3. JSONPATTERN — JSON でユーザーをどのように記述するかを決めます (ARRAY の要素として、OBJECT として、またはネストされた SUBOBJECT として)。

コンマ、セミコロン、またはスペースで区切ることができます。デフォルトは以下のパターンです。

METHOD=PUT, DATAUPDATE=CHANGES, JSONPATTERN=OBJECT
削除 URI ユーザー データを削除するルート。デフォルトは 1 人のユーザー GET のための URI です。ユーザー キーの場所を特定するために、{id} を使用します。
画像 In2Ex 更新パターン

PureCloud からカスタマーのシステムにコピーする際の画像の作成方法および更新方法を指定します。 

  • NONE — 画像の更新はサポートされていません。
  • BYTE — JSON ボディでバイト アレイとして送信します。
  • BASE64 — Base64 として送信します。
  • URL — 別個の PUT または POST として送信します。
  • URL_POST_MULTIPART — 画像 In2Ex 更新リクエスト テンプレートを使って、複数の部分の更新を行います。
画像 In2Ex 更新リクエスト テンプレート

画像の更新または作成のためのリクエスト テンプレート。ユーザー キーの置き換え文字列を示すために、{{id}} を使用します。複数部分を POST する形式で定義している場合、複数部分のセパレータを含むために {{multiPartSep}} を使用します。

リクエストの最後の部分は常にコンテンツ タイプ ヘッダー、画像データ、最後のセパレータになります。値を指定しないと、デフォルトは以下のようになります。

Content-Disposition: form-data; name="fileUpload"; filename="imageFile.jpg" Content-Type: image/jpg 
プライベート画像の PUT の URI プライベート画像を更新するルート。ユーザー キーの場所を特定するために、{id} を使用します。
画像プロフィール URI の PUT

プロフィール画像を更新するルート。ユーザー キーの場所を特定するために、{id} を使用します。例:

/api/v1/images/{id}/imageProfile.jpg?autoCreate=true
プライベート画像の POST の URI プライベート画像を追加するルート。ユーザー キーの場所を特定するために、{id} を使用します。PUT で自動作成がサポートされている場合、それを含めて、PUT を設定しないようにします。
画像プロフィール POST の URI プロフィール画像を追加するルート。ユーザー キーの場所を特定するために、{id} を使用します。PUT で自動作成がサポートされている場合、それを含めて、PUT を設定しないようにします。
ユーザー キー フィールド ユーザー キー フィールド名。マッピングの外部フィールド名のように、この名前にはプロバイダーの接頭辞である User. を含めます。
ユーザー キー フィールド タイプ ユーザー キー フィールドのタイプ。外部タイプが MAPPING にない場合、これは必須です。許可されたタイプは STRING と INTEGER です。
JSON ユーザー アレイ/オブジェクト名 ユーザー データの JSON アレーまたはオブジェクト名。コネクターはデフォルトで User という名前が付いた最初のアレイになるか、特定の名前が指定されない場合は、見つかった最初のアレイになります。この名前は、_OBJECT の UPDATE と CREATE パターンの OBJECT としても使用されます。
サービス認証タイプ

REST サービスで使用する認証タイプを指定します。可能な値には以下のものがあります。

  • BASIC と DIGEST — ログイン情報が設定されていることが必要です。
  • POSTLOGIN — LoginJsonTemplet 本体を使って、ログイン POST リクエストを LoginUriTemplate に送信し、残りのセッションのために cookie を保存します。ログイン情報が設定されていることが必要です。
  • OAUTH2 — ログインに OAuth 2.0 仕様を使用します。クライアント ログイン情報識別子とシークレットが設定されている必要があります。
  • OAUTH2_CLIENTURLENCODED — クライアント ログイン情報識別子とシークレットが設定されていることが必要です。
  • OAUTH2_JWTBEARER — ログイン情報ユーザー ID を iss として、クライアント識別子を範囲として、シークレットを JWT にサインする秘密キーとして使用する JWT を使用して、urn:ietf:params:oauth:grant-type:jwt-bearer の付与タイプを作成します。
ログイン URI ログインのルート。ルートにユーザー識別子またはパスワードの引数が必要な場合、{credUser}{credPwd} パラメーターを使用します。
ログイン リクエスト ボディのテンプレート

ログイン メソッド/ルート URI と一緒に使用するオプションの JSON または Form URI エンコード ボディ。ボディにユーザー識別子またはパスワードが必要な場合、テンプレートには {{credUser}}{{credPwd}} パラメーターを使用します。値が設定されていない場合、空白のボディがリクエストとともに送信されます。

コンテンツ タイプは、以下のようにサービス認証タイプによって異なります。

  • POSTLOGIN — JSON リクエストを使用します。
  • OAUTH2 — OAUTH2 ログインでユーザーとパスワードの URL が使用されるため、この値はオプションです。orgName または subAccount などの追加のパラメーターが必要です。
セッション ヘッダー テンプレート

オプションのヘッダー リストと、ログインとセッションとともに使用する必要のあるテンプレートの値。ログインの前に解決されるヘッダー (引数入力) は、ログインで使用されます。HTTP 応答に基づいて残りのヘッダーが解決されない場合、ログインは失敗します。テンプレートのパラメーターは {} で囲まれており、データへの Linq パスでなければなりません。ヘッダーは Name=Value で、コンマまたはセミコロンで区切られている必要があります。 例:

Authenticate=bearer {res.X-Company-Auth-Key};SessionId={res.X-Company-Session-Id}
TSL/SSL の使用 サービスへのセッションを TLS/SSL にする必要があるかどうかを指定します。これは、認証タイプが BASIC および POSTLOGIN の場合に必要です。
ページ パターン

データをページするパターンで、以下のものがあります。

  • PAGE_NEXT — [ページ情報フィールド] が Next Page という名前または URI であることを予想します。
  • PAGE_OFFSET — [次ページ URI] で使用する {pageOffset} 引数を提供します。これはゼロから開始し、[ページ オフセット増分] で設定された単位で増加します。
ページ情報フィールド名 次のページの名前を含むか、次のページまたはページ番号を GET する完全な URL を含む [次ページ] もしくは [ページ番号フィールド]。
ページ オフセット増分 PAGE_OFFSET で使用するサイズをオフセットします。デフォルトは 25 です。[次ページ URI] テンプレートで {pageOffset} パラメーターを使用します。
次ページ URI 次のページの名前の代わりに使用する URI テンプレート。{moniker} パラメーターは、[ページ情報フィールド] の名前で置き換えられます。[次ページ URI] を [ページ情報フィールド] とともに設定すると、コネクターでは [ページ情報フィールド] に名前が含まれていること、および名前が [次ページ URI] で置き換えられ、結果としての次ページを取得できるものと想定されます。PAGE_OFFSET ページ パターンを使用する場合、{pageOffset} を使用します。
URI を作成 新しいデータをポストするルート。デフォルトは 1 人のユーザー GET の URI です。
作成パターン

ユーザー データの作成パターンです。 作成パターンには 3 つの部分があり、以下の順序にする必要があります。

  1. METHOD — REST の更新メソッドで、PUT、POST、または PATCH です。
  2. DATAUPDATE — ユーザーのすべての値 (ヌルを含む) が作成時、または CHANGES の時のみ (新規値) に送信されるかどうかを決めます。
  3. JSONPATTERN — JSON でユーザーをどのように記述するかを決めます (ARRAY の要素として、OBJECT として、またはネストされた SUBOBJECT として)。

コンマ、セミコロン、またはスペースで区切ることができます。 デフォルトは以下のパターンです。

METHOD=PUT, DATAUPDATE=CHANGES, JSONPATTERN=OBJECT