機械翻訳について

すべてのソース・システム参照の取得

get

/crmRestApi/resources/11.13.18.05/hubSourceSystemReferences

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

    フォーマット : ?fields=Attribute1,Attribute2

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • PrimaryKey : 割当レコードの主キーを使用して、ソース・システム参照割当を検索します。
      ファインダ変数:
      • SourceSystemReferenceId; integer; ソース・システム参照割当ての一意の識別子。
    • SSRById : 割当レコードの識別子を使用して、ソース・システム参照割当を検索します。
      ファインダ変数:
      • SourceSystemReferenceId; integer; ソース・システム参照割当ての一意の識別子。
    • SSRByOsOsrOwnerEntityObject : ソース・システム参照および取引先コミュニティ・オブジェクト名を使用して、ソース・システム参照割当を検索します。
      ファインダ変数:
      • OwnerEntityObject; string; 新しいソース・システム、ソース・システム参照が関連付けられているFusion識別子を保持するTCAエンティティ。 有効な値は、参照タイプORA_ZCH_OWNER_ENTITY_OBJECTの参照コードです。
      • SourceSystem; string;ソース・システムの名前。
      • SourceSystemReferenceValue; string; ソース・システム論理エンティティのソース・システムID。
    • SSRByOsOsrOwnerEntityObjectId : ソース・システム参照および取引先コミュニティ・オブジェクト・レコード識別子値を使用して、ソース・システム参照割当を検索します。
      ファインダ変数:
      • OwnerEntityId; integer; 新しいソース・システムまたはソース・システム参照が関連付けられている所有者エンティティ・オブジェクトのレコードのFusion識別子。 挿入の場合に提供できます。
      • OwnerEntityObject; string; 新しいソース・システム、ソース・システム参照が関連付けられているFusion識別子を保持するTCAエンティティ。 有効な値は、参照タイプORA_ZCH_OWNER_ENTITY_OBJECTの参照コードです。
      • SourceSystem; string;ソース・システムの名前。
      • SourceSystemReferenceValue; string; ソース・システム論理エンティティのソース・システムID。
    • SourceSystemReferenceAltKey : 割当レコードの代替キー・ソース・システム、ソース・システム参照値または所有者エンティティ・オブジェクトを使用して、ソース・システム参照割当を検索します。
      ファインダ変数:
      • OwnerEntityObject; string.
      • SourceSystem; string.
      • SourceSystemReferenceValue; string.
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • Attribute1; string;文字列1にマップされたフレックスフィールドの列に値を格納します。
    • Attribute10; string;文字列10にマップされたフレックスフィールドの列に値を格納します。
    • Attribute11; string;文字列11にマップされたフレックスフィールドの列に値を格納します。
    • Attribute12; string;文字列12にマップされたフレックスフィールドの列に値を格納します。
    • Attribute13; string;文字列13にマップされたフレックスフィールドの列に値を格納します。
    • Attribute14; string;文字列14にマップされたフレックスフィールドの列に値を格納します。
    • Attribute15; string;文字列15にマップされたフレックスフィールドの列に値を格納します。
    • Attribute16; string;文字列16にマップされたフレックスフィールドの列に値を格納します。
    • Attribute17; string;文字列17にマップされたフレックスフィールドの列に値を格納します。
    • Attribute18; string;文字列18にマップされたフレックスフィールドの列に値を格納します。
    • Attribute19; string;文字列19にマップされたフレックスフィールドの列に値を格納します。
    • Attribute2; string;文字列2にマップされたフレックスフィールドの列に値を格納します。
    • Attribute20; string;文字列20にマップされたフレックスフィールドの列に値を格納します。
    • Attribute21; string;文字列21にマップされたフレックスフィールドの列に値を格納します。
    • Attribute22; string;文字列22にマップされたフレックスフィールドの列に値を格納します。
    • Attribute23; string;文字列23にマップされたフレックスフィールドの列に値を格納します。
    • Attribute24; string;文字列24にマップされたフレックスフィールドの列に値を格納します。
    • Attribute25; string;文字列25にマップされたフレックスフィールドの列に値を格納します。
    • Attribute26; string;文字列26にマップされたフレックスフィールドの列に値を格納します。
    • Attribute27; string;文字列27にマップされたフレックスフィールドの列に値を格納します。
    • Attribute28; string;文字列28にマップされたフレックスフィールドの列に値を格納します。
    • Attribute29; string;文字列29にマップされたフレックスフィールドの列に値を格納します。
    • Attribute3; string;文字列3にマップされたフレックスフィールドの列に値を格納します。
    • Attribute30; string;文字列30にマップされたフレックスフィールドの列に値を格納します。
    • Attribute4; string;文字列4にマップされたフレックスフィールドの列に値を格納します。
    • Attribute5; string;文字列5にマップされたフレックスフィールドの列に値を格納します。
    • Attribute6; string;文字列6にマップされたフレックスフィールドの列に値を格納します。
    • Attribute7; string;文字列7にマップされたフレックスフィールドの列に値を格納します。
    • Attribute8; string;文字列8にマップされたフレックスフィールドの列に値を格納します。
    • Attribute9; string;文字列9にマップされたフレックスフィールドの列に値を格納します。
    • AttributeCategory; string;属性は、フレックスフィールドのグループのカテゴリ値を格納します。
    • AttributeDate1; string;日付列1にマップされたフレックスフィールドの列に値を格納します。
    • AttributeDate10; string;日付列10にマップされたフレックスフィールドの列に値を格納します。
    • AttributeDate11; string;日付列11にマップされたフレックスフィールドの列に値を格納します。
    • AttributeDate12; string;日付列12にマップされたフレックスフィールドの列に値を格納します。
    • AttributeDate2; string;日付列2にマップされたフレックスフィールドの列に値を格納します。
    • AttributeDate3; string;日付列3にマップされたフレックスフィールドの列に値を格納します。
    • AttributeDate4; string;日付列4にマップされたフレックスフィールドの列に値を格納します。
    • AttributeDate5; string;日付列5にマップされたフレックスフィールドの列に値を格納します。
    • AttributeDate6; string;日付列6にマップされたフレックスフィールドの列に値を格納します。
    • AttributeDate7; string;日付列7にマップされたフレックスフィールドの列に値を格納します。
    • AttributeDate8; string;日付列8にマップされたフレックスフィールドの列に値を格納します。
    • AttributeDate9; string;日付列9にマップされたフレックスフィールドの列に値を格納します。
    • AttributeNumber1; number;数値列1にマップされたフレックスフィールドの列に値を格納します。
    • AttributeNumber10; number;数値列10にマップされたフレックスフィールドの列に値を格納します。
    • AttributeNumber11; number;数値列11にマップされたフレックスフィールドの列に値を格納します。
    • AttributeNumber12; number;数値列12にマップされたフレックスフィールドの列に値を格納します。
    • AttributeNumber2; number;数値列2にマップされたフレックスフィールドの列に値を格納します。
    • AttributeNumber3; number;数値列3にマップされたフレックスフィールドの列に値を格納します。
    • AttributeNumber4; number;番号列4にマップされたフレックスフィールドの列に値を格納します。
    • AttributeNumber5; number;数値列5にマップされたフレックスフィールドの列に値を格納します。
    • AttributeNumber6; number;番号列6にマップされたフレックスフィールドの列に値を格納します。
    • AttributeNumber7; number;番号列7にマップされたフレックスフィールドの列に値を格納します。
    • AttributeNumber8; number;番号列8にマップされたフレックスフィールドの列に値を格納します。
    • AttributeNumber9; number;番号列9にマップされたフレックスフィールドの列に値を格納します。
    • CreatedBy; string; 行を作成したユーザー。
    • CreatedByModule; string; ソース・システム参照を作成したモジュール。
    • CreationDate; string; 行が作成された日時。
    • EndDateActive; string;ソース・システム参照の終了日。 これは過去の日付にできません。
    • LastUpdateDate; string; 行が最後に更新された日時。
    • LastUpdateLogin; string; 行を最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; 行を最後に更新したユーザー。
    • OwnerEntityId; integer;新しいソース・システム、ソース・システム参照が関連付けられている所有者エンティティ・オブジェクトのレコードのFusion識別子。 挿入の場合に提供できます。
    • OwnerEntityObject; string; 新しいソース・システム、ソース・システム参照が関連付けられているFusion識別子を保持するTCAエンティティ。 有効な値は、参照タイプORA_ZCH_OWNER_ENTITY_OBJECTの参照コードです。
    • ReasonCode; string; これは、MOSR_REASON参照タイプに対して検証されます。
    • SourceSystem; string;ソース・システム名。 挿入の場合に指定します。
    • SourceSystemReferenceId; integer;順次生成された主キー。
    • SourceSystemReferenceValue; string; ソース・システム論理エンティティのソース・システムID。 挿入の場合に指定します。
    • StartDateActive; string;ソース・システム参照の開始日。 将来の日付にできません。
    • Status; string;ソース・システム参照のステータス。 有効な値はアクティブです - 'A'および非アクティブ - 'I'.
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : hubSourceSystemReferences
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : hubSourceSystemReferences-item-response
タイプ: object
ソースを表示
  • 最大長: 150
    文字列1にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列10にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列11にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列12にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列13にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列14にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列15にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列16にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列17にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列18にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列19にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列2にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列20にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列21にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列22にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列23にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列24にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列25にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列26にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列27にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列28にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列29にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列3にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 255
    文字列30にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列4にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列5にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列6にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列7にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列8にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 150
    文字列9にマップされたフレックスフィールドの列に値を格納します。
  • 最大長: 30
    属性には、フレックスフィールドのグループのカテゴリ値が格納されます。
  • 日付列1にマップされたフレックスフィールドの列に値を格納します。
  • 日付列10にマップされたフレックスフィールドの列に値を格納します。
  • 日付列11にマップされたフレックスフィールドの列に値を格納します。
  • 日付列12にマップされたフレックスフィールドの列に値を格納します。
  • 日付列2にマップされたフレックスフィールドの列に値を格納します。
  • 日付列3にマップされたフレックスフィールドの列に値を格納します。
  • 日付列4にマップされたフレックスフィールドの列に値を格納します。
  • 日付列5にマップされたフレックスフィールドの列に値を格納します。
  • 日付列6にマップされたフレックスフィールドの列に値を格納します。
  • 日付列7にマップされたフレックスフィールドの列に値を格納します。
  • 日付列8にマップされたフレックスフィールドの列に値を格納します。
  • 日付列9にマップされたフレックスフィールドの列に値を格納します。
  • 数値列1にマップされたフレックスフィールドの列に値を格納します。
  • 数値列10にマップされたフレックスフィールドの列に値を格納します。
  • 数値列11にマップされたフレックスフィールドの列に値を格納します。
  • 数値列12にマップされたフレックスフィールドの列に値を格納します。
  • 数値列2にマップされたフレックスフィールドの列に値を格納します。
  • 数値列3にマップされたフレックスフィールドの列に値を格納します。
  • 数値列4にマップされたフレックスフィールドの列に値を格納します。
  • 数値列5にマップされたフレックスフィールドの列に値を格納します。
  • 数値列6にマップされたフレックスフィールドの列に値を格納します。
  • 数値列7にマップされたフレックスフィールドの列に値を格納します。
  • 数値列8にマップされたフレックスフィールドの列に値を格納します。
  • 数値列9にマップされたフレックスフィールドの列に値を格納します。
  • 読取り専用: true
    最大長: 64
    行を作成したユーザー。
  • 最大長: 30
    デフォルト値: ORA_ZCH_WS
    ソース・システム参照を作成したモジュール。
  • タイトル: Creation Date
    読取り専用: true
    行が作成された日時。
  • ソース・システム参照の終了日。 これは過去の日付にできません。
  • OSRベース表にすでに存在する参照ソース・システム。 挿入の場合に提供できます。
  • OSRベース表にすでに存在する参照ソース・システム参照。 挿入の場合に提供できます。 既存のソース・システムおよび既存のソース・システム参照は、新しいソース・システム参照が作成されるFusion識別子を識別するために使用されます。
  • 読取り専用: true
    行が最後に更新された日時。
  • 読取り専用: true
    最大長: 64
    行を最後に更新したユーザー。
  • 読取り専用: true
    最大長: 32
    行を最後に更新したユーザーのログイン。
  • Links
  • 新規ソース・システム、ソース・システム参照が関連付けられている所有者エンティティ・オブジェクトのレコードのFusion識別子。 挿入の場合に提供できます。
  • 最大長: 30
    新しいソース・システム、ソース・システム参照が関連付けられているFusion識別子を保持するTCAエンティティ。 有効な値は、参照タイプORA_ZCH_OWNER_ENTITY_OBJECTの参照コードです。
  • 最大長: 30
    これは、MOSR_REASON参照タイプに対して検証されます。
  • タイトル: Source System
    最大長: 30
    ソース・システム名。 挿入の場合に指定します。
  • 読取り専用: true
    順次生成された主キー。
  • 最大長: 255
    ソース・システム論理エンティティのソース・システムID。 挿入の場合に指定します。
  • ソース・システム参照の開始日。 将来の日付にできません。
  • 読取り専用: true
    最大長: 1
    デフォルト値: A
    ソース・システム参照のステータス。 有効な値はアクティブです - 'A'および非アクティブ - 'I'.
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、すべてのソース・システム参照を取得する方法を示しています。 cURLの詳細は、「cURLの使用」を参照してください

curl -user sales_cloud_user -X GET  https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubSourceSystemReferences

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています:

{
    "items": [
        {
            "SourceSystemReferenceId": 10766,
            "SourceSystem": "Pinnacle_Data",
            "SourceSystemReferenceValue": "1393",
            "OwnerEntityObject": "ORA_CUST_ACCT_SITES_ALL",
            "OwnerEntityId": 1394,
            "ExistingSourceSystem": null,
            "ExistingSourceSystemReferenceValue": null,
            "StartDateActive": "2004-02-23",
            "EndDateActive": "4712-12-31",
            "Status": "A",
            "ReasonCode": null,
            "CreatedBy": "2045",
            "CreationDate": "1999-10-06T03:54:14+00:00",
            "LastUpdatedBy": "2045",
            "LastUpdateDate": "1999-10-06T03:54:14+00:00",
            "LastUpdateLogin": "357171",
            "CreatedByModule": "TCA",
            "AttributeCategory": null,
            "Attribute1": null,
            ...
            "AttributeDate1": null,
            "AttributeDate2": null,
            "AttributeDate3": null,
            "AttributeDate4": null,
            "AttributeDate5": null,
            "AttributeDate6": null,
            "AttributeDate7": null,
            "AttributeDate8": null,
            "AttributeDate9": null,
            "AttributeDate10": null,
            "AttributeDate11": null,
            "AttributeDate12": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubSourceSystemReferences/10766",
                    "name": "hubSourceSystemReferences",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A61766176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/hubSourceSystemReferences/10766",
                    "name": "hubSourceSystemReferences",
                    "kind": "item"
                }
            ]
        },
...
}
「トップに戻る」