機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 世帯
  4. 関係

すべての関係の取得

get

/crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Relationship

リクエスト

パス・パラメータ
  • 世帯パーティの一意のプライマリ識別子。 プロファイル・オプションHZ_GENERATE_PARTY_NUMBERは、属性値をシステム生成にできるか、作成中にユーザー指定にできるかを制御します。 「設定およびメンテナンス」作業領域、「取引先コミュニティ共通プロファイル・オプションの管理」タスクを使用して、この属性の値をレビューおよび更新します。 非アクティブなレコードは更新できません。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

    フォーマット: <attr1>=<val1>,<attr2>=<value2>
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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 : 指定した主キーとの関係を検索します。
      ファインダ変数:
      • RelationshipRecId; integer;関係の一意の識別子。
    • Relationship2AltKey : 指定したパラメータとの関係を検索します。
      ファインダ変数:
      • ObjectPartyId; integer;この関係にあるオブジェクトの識別子。
      • RelationshipCode; string; これがフォワード関係コードかバック・ワード関係コードかを示します。
      • RelationshipType; string;関係タイプ名。
      • SubjectPartyNumber; string; 関係のサブジェクト・パーティの一意の識別番号。
    • Relationship3AltKey : 指定したパラメータとの関係を検索します。
      ファインダ変数:
      • ObjectPartyId; integer;この関係にあるオブジェクトの識別子。
      • RelationshipCode; string; これがフォワード関係コードかバック・ワード関係コードかを示します。
      • RelationshipType; string;関係タイプ名。
      • SubjectSourceSystem; string;関係におけるサブジェクト・パーティの外部ソース・システムの名前。
      • SubjectSourceSystemReferenceValue; string;外部ソース・システムからの関係におけるサブジェクト・パーティの識別子。
    • Relationship4AltKey : 指定したパラメータとの関係を検索します。
      ファインダ変数:
      • ObjectPartyNumber; string; 関係のオブジェクト・パーティの一意の識別番号。
      • RelationshipCode; string; これがフォワード関係コードかバック・ワード関係コードかを示します。
      • RelationshipType; string;関係タイプ名。
      • SubjectPartyId; integer;関係内のサブジェクトの識別子。
    • Relationship5AltKey: 指定したパラメータとの関係を検索します。
      ファインダ変数:
      • ObjectPartyNumber; string; 関係のオブジェクト・パーティの一意の識別番号。
      • RelationshipCode; string; これがフォワード関係コードかバック・ワード関係コードかを示します。
      • RelationshipType; string;関係タイプ名。
      • SubjectPartyNumber; string; 関係のサブジェクト・パーティの一意の識別番号。
    • Relationship6AltKey : 指定したパラメータとの関係を検索します。
      ファインダ変数:
      • ObjectPartyNumber; string; 関係のオブジェクト・パーティの一意の識別番号。
      • RelationshipCode; string; これがフォワード関係コードかバック・ワード関係コードかを示します。
      • RelationshipType; string;関係タイプ名。
      • SubjectSourceSystem; string;関係におけるサブジェクト・パーティの外部ソース・システムの名前。
      • SubjectSourceSystemReferenceValue; string;外部ソース・システムからの関係におけるサブジェクト・パーティの識別子。
    • Relationship7AltKey : 指定したパラメータとの関係を検索します。
      ファインダ変数:
      • ObjectSourceSystem; string; 関係におけるオブジェクト・パーティの外部ソース・システムの名前。
      • ObjectSourceSystemReferenceValue; string;外部ソース・システムからの関係におけるオブジェクト・パーティの識別子。
      • RelationshipCode; string; これがフォワード関係コードかバック・ワード関係コードかを示します。
      • RelationshipType; string;関係タイプ名。
      • SubjectPartyId; integer;関係内のサブジェクトの識別子。
    • Relationship8AltKey : 指定したパラメータとの関係を検索します。
      ファインダ変数:
      • ObjectSourceSystem; string; 関係におけるオブジェクト・パーティの外部ソース・システムの名前。
      • ObjectSourceSystemReferenceValue; string;外部ソース・システムからの関係におけるオブジェクト・パーティの識別子。
      • RelationshipCode; string; これがフォワード関係コードかバック・ワード関係コードかを示します。
      • RelationshipType; string;関係タイプ名。
      • SubjectPartyNumber; string; 関係のサブジェクト・パーティの一意の識別番号。
    • Relationship9AltKey : 指定したパラメータとの関係を検索します。
      ファインダ変数:
      • ObjectSourceSystem; string; 関係におけるオブジェクト・パーティの外部ソース・システムの名前。
      • ObjectSourceSystemReferenceValue; string;外部ソース・システムからの関係におけるオブジェクト・パーティの識別子。
      • RelationshipCode; string; これがフォワード関係コードかバック・ワード関係コードかを示します。
      • RelationshipType; string;関係タイプ名。
      • SubjectSourceSystem; string;関係におけるサブジェクト・パーティの外部ソース・システムの名前。
      • SubjectSourceSystemReferenceValue; string;外部ソース・システムからの関係におけるサブジェクト・パーティの識別子。
    • RelationshipAltKey : 指定したパラメータとの関係を検索します。
      ファインダ変数:
      • ObjectPartyId; integer;この関係にあるオブジェクトの識別子。
      • RelationshipCode; string; これがフォワード関係コードかバック・ワード関係コードかを示します。
      • RelationshipType; string;関係タイプ名。
      • SubjectPartyId; integer;関係内のサブジェクトの識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • BackwardRole; string;関係を記述するために使用されるバック・ワード関係コード。 たとえば、SUPPLIER_OFです。
    • Comments; string; ユーザーが入力したコメント。
    • ConflictId; integer; 関係レコードの競合の一意の識別子。 この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。
    • CreatedBy; string; レコードを作成したユーザー。
    • CreatedByModule; string; 関係レコードを作成したアプリケーション・モジュール。 すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。 有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。 設定およびメンテナンス・タスクの取引先コミュニティ共通参照の管理を使用して、コードをレビューおよび更新できます。
    • CreationDate; string; レコードが作成された日時。
    • DependentFlag; string;あるパーティが別のパーティに依存しているかどうかを示します。 デフォルト値はNです。
    • DirectionCode; string;関係方向のコード。 受け入れられる値のリストは、参照DIRECTION_CODEで定義されます。 有効な値は、P-Parent、C-Child、N-Not Directionalです。
    • EndDate; string;関係が終了する日付。
    • HeadOfHouseholdFlag; string; 個人が所属する世帯の責任者かどうかを示します。 これはMEMBERSHIP関係にのみ適用され、どのメンバーが世帯主であるかを示すために使用されます。 当該会社の実装によっては、複数の世帯主が存在する場合があります。
    • InfluenceLevel; string;購買関係における営業担当者の影響。 サンプル値は、内部円、政治構造、なしです。
    • JobDefinitionName; string;ジョブ名の定義。
    • JobDefinitionPackage; string;ジョブ・パッケージの定義。
    • LastUpdateDate; string; レコードが最後に更新された日時。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン詳細。
    • LastUpdatedBy; string; レコードを最後に更新したユーザー。
    • ObjectPartyId; integer; この関係にあるオブジェクトの一意の識別子。
    • ObjectPartyName; string;オブジェクト・パーティの名前。
    • ObjectPartyNumber; string;関係のオブジェクト・パーティの代替キー識別子。
    • ObjectSourceSystem; string;関係におけるオブジェクト・パーティの外部ソース・システムの名前で、システム設定の一部として管理者が定義します。
    • ObjectSourceSystemReferenceValue; string;外部ソース・システムからの関係におけるオブジェクト・パーティの一意の識別子。
    • ObjectTableName; string; この関係におけるオブジェクト・パーティのソース表名。
    • ObjectType; string; ORGANIZATION、PERSONなどの関係のオブジェクト・タイプ。
    • ObjectUsageCode; string;関係におけるオブジェクト・パーティの使用法コード。
    • ObjectVersionNumber; integer; 関係レコードのオプティミスティック・ロックの実装に使用される数値。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
    • ObjectVersionNumber1; integer; 関係レコードのオプティミスティック・ロックの実装に使用される代替番号。
    • ObjectVersionNumber2; integer; 関係レコードのオプティミスティック・ロックを実装する代替番号。
    • PartyId; integer; 関連付けられたパーティ・レコードの代替の一意の識別子。
    • PartyId1; integer;関連パーティ・レコードの代替識別子。
    • PercentageOwnership; number。親エンティティが所有する子エンティティの割合。
    • RelationshipCode; string; これがフォワード関係コードかバック・ワード関係コードかを示すコード。
    • RelationshipId; integer;関係の一意の識別子。
    • RelationshipRecId; integer; 関係レコードの一意の識別子。
    • RelationshipType; string;関係のタイプの名前。 たとえば、CUSTOMER_SUPPLIERです。
    • RequestId; integer; 関係レコードに対するリクエストの一意の識別子。
    • SSROwnerTableName; string; レコード・データを保持し、ソース・システム参照を管理するために参照される表の名前。
    • StartDate; string;関係が開始する日付。
    • ステータス;文字列;関係のステータス、Aはアクティブ、Iは非アクティブ。
    • SubjectPartyId; integer; この関係のサブジェクトの一意の識別子。
    • SubjectPartyName; string;サブジェクト・パーティの名前。
    • SubjectPartyNumber; string;関係のサブジェクト・パーティの代替キー識別子。
    • SubjectSourceSystem; string;関係におけるサブジェクト・パーティの外部ソース・システムの名前。システム設定の一部として管理者によって定義されます。
    • SubjectSourceSystemReferenceValue; string;外部ソース・システムからの関係におけるサブジェクト・パーティの一意の識別子。
    • SubjectTableName; string; この関係におけるサブジェクト・パーティのソース表名。
    • SubjectType; string; ORGANIZATION、PERSONなどの関係のサブジェクト・タイプ。
    • SubjectUsageCode; string;関係におけるサブジェクト・パーティの使用コード。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : households-Relationship
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : households-Relationship-item-response
タイプ: object
ソースを表示
  • タイトル: Backward Role
    読取り専用: true
    関係の記述に使用されるバック・ワード関係コード。 たとえば、SUPPLIER_OFです。
  • タイトル: Comments
    最大長: 2000
    ユーザーによって提供されたコメント。
  • デフォルト値: 0
    関係レコードの競合の一意の識別子。 この番号は、webサービスを消費するモバイル・アプリケーションまたはポータブル・アプリケーションで使用されます。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    レコードを作成したユーザー。
  • タイトル: Created by Application
    最大長: 30
    デフォルト値: HZ_WS
    関係レコードを作成したアプリケーション・モジュール。 すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。 有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。 設定およびメンテナンス・タスクの取引先コミュニティ共通参照の管理を使用して、コードをレビューおよび更新できます。
  • タイトル: Creation Date
    読取り専用: true
    レコードが作成された日時。
  • タイトル: Dependent Indicator
    最大長: 1
    デフォルト値: N
    1つのパーティが別のパーティに依存しているかどうかを示します。 デフォルト値はNです。
  • 読取り専用: true
    最大長: 30
    関係方向のコード。 受け入れられる値のリストは、参照DIRECTION_CODEで定義されます。 有効な値は、P-Parent、C-Child、N-Not Directionalです。
  • タイトル: To Date
    関係が終了する日付。
  • タイトル: Head of Household Indicator
    最大長: 1
    デフォルト値: N
    個人が所属する世帯主であるかどうかを示します。 これはMEMBERSHIP関係にのみ適用され、どのメンバーが世帯主であるかを示すために使用されます。 当該会社の実装によっては、複数の世帯主が存在する場合があります。
  • タイトル: Influence Level
    販売担当者が購買関係に与える影響。 サンプル値は、内部円、政治構造、なしです。
  • 最大長: 100
    ジョブ名の定義。
  • 最大長: 900
    ジョブ・パッケージの定義。
  • タイトル: Last Updated Date
    読取り専用: true
    レコードが最後に更新された日時。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    レコードを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    レコードを最後に更新したユーザーのログイン詳細。
  • Links
  • この関係にあるオブジェクトの一意の識別子。
  • タイトル: Object Party Name
    読取り専用: true
    最大長: 360
    オブジェクト・パーティの名前。
  • タイトル: Object Registry ID
    最大長: 30
    関係のオブジェクト・パーティの代替キー識別子。
  • タイトル: Object Source System
    関係のオブジェクト・パーティの外部ソース・システムの名前で、システム設定の一部として管理者が定義します。
  • タイトル: Object Source System Reference
    外部ソース・システムからの関係におけるオブジェクト・パーティの一意の識別子。
  • 最大長: 30
    この関係のオブジェクト・パーティのソース表名。
  • 最大長: 30
    ORGANIZATION、PERSONなどの関係のオブジェクト・タイプ。
  • 最大長: 30
    関係におけるオブジェクト・パーティの使用コード。
  • 関係レコードのオプティミスティック・ロックの実装に使用される番号。 この番号は、行を更新するたびに増分されます。 問合せされてから別のセッションによって行が更新されたかどうかを検出するために、トランザクションの開始時と終了時の番号が比較されます。
  • 読取り専用: true
    関係レコードのオプティミスティック・ロックの実装に使用される代替番号。
  • 読取り専用: true
    関係レコードのオプティミスティック・ロックを実装する代替番号。
  • 読取り専用: true
    関連パーティ・レコードの代替一意識別子。
  • 読取り専用: true
    関連パーティ・レコードの代替識別子。
  • タイトル: Ownership Percentage
    親エンティティが所有する子エンティティのパーセンテージ。
  • 最大長: 10
    デフォルト値: false
    この担当者個人が顧客のプライマリ担当者であるかどうかを示します。 受け入れられる値はYおよびNです。 デフォルト値はNです。
  • 最大長: 10
    デフォルト値: false
    この顧客が担当者のプライマリ顧客かどうかを示します。 受け入れられる値はYおよびNです。 デフォルト値はNです。
  • タイトル: Relationship Code
    最大長: 30
    これがフォワード関係コードかバック・ワード関係コードかを示すコード。
  • 読取り専用: true
    関係の一意の識別子。
  • 関係レコードの一意の識別子。
  • システム設定の一部として管理者が定義する、関係の外部ソース・システムの名前。
  • 外部ソース・システムからの関係の一意の識別子。
  • タイトル: Relationship Type
    最大長: 30
    関係のタイプの名前。 たとえば、CUSTOMER_SUPPLIERです。
  • 関係レコードのリクエストの一意の識別子。
  • タイトル: Role
    サブジェクト・パーティとオブジェクト・パーティ間のロール。
  • 読取り専用: true
    最大長: 255
    デフォルト値: HZ_PARTIES
    レコード・データを保持し、ソース・システム参照を管理するために参照される表の名前。
  • タイトル: From Date
    関係が開始する日付。
  • 読取り専用: true
    最大長: 1
    デフォルト値: A
    関係のステータス、Aはアクティブ、Iは非アクティブ。
  • この関係のサブジェクトの一意の識別子。
  • タイトル: Subject Party Name
    読取り専用: true
    最大長: 360
    件名パーティの名前。
  • タイトル: Subject Registry ID
    最大長: 30
    関係のサブジェクト・パーティの代替キー識別子。
  • タイトル: Subject Source System
    関係のサブジェクト・パーティの外部ソース・システムの名前で、システム設定の一部として管理者が定義します。
  • タイトル: Subject Source System Reference
    外部ソース・システムからの関係におけるサブジェクト・パーティの一意の識別子。
  • 最大長: 30
    この関係のサブジェクト・パーティのソース表名。
  • 最大長: 30
    ORGANIZATION、PERSONなどの関係のサブジェクト・タイプ。
  • 最大長: 30
    関係のサブジェクト・パーティの使用コード。
トップに戻る

例:

cURLコマンド

次の例は、cURLを使用してRESTリソースに対するgetリクエストを発行することによって、すべての関係を取得する方法を示しています。 

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/households/CDRM_61285/child/Relationship/

レスポンス本文の例

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

{
    "ObjectPartyId": 300100019165126,
    "SubjectPartyId": 300100019165045,
    "RelationshipType": "HOUSEHOLD",
    "RelationshipCode": "ORA_OTHER_IN",
    "Status": "A",
    "CreatedBy": "DATA_STEWARD_MGR",
    "SubjectPartyNumber": "CDRM_61276",
    "ObjectPartyNumber": "CDRM_61285",
    ...
}
「トップに戻る」