機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 値リスト
  4. CRMビジネス・ユニット
  5. 共通セットID参照

すべての共通セットID使用可能参照値の取得

get

/crmRestApi/resources/11.13.18.05/crmBusinessUnits/{crmBusinessUnitsUniqID}/child/fndCommonSetIdLookups

リクエスト

パス・パラメータ
  • これは、CRMビジネス・ユニット・リソースのコンポジット・キーを構成し、CRMビジネス・ユニットのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、ハッシュ・キーを取得するためにCRMビジネス・ユニットの特定のインスタンスに移動するために、CRMビジネス・ユニットの収集リソースを問い合せる必要があります。
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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>

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

    • CommonSetIdLOVFinder: 参照タイプ、参照グループ名などの属性の組合せによって、使用可能およびアクティブな参照値が検索されます。 また、子参照値を親参照タイプに基づいてフィルタする必要があるカスケード固定選択リストでも使用されます。
      ファインダ変数:
      • Bind_ParentLookupCode; string;カスケード固定選択リストの親固定選択リストの参照コード。
      • Bind_ParentSetidDetermType; string;カスケード固定選択リスト内の親固定選択リストの決定要因タイプ。
      • Bind_ParentSetidDetermValue; string;カスケード固定選択リスト内の親固定選択リストの決定要因値。
      • Bind_RelationshipId; integer; カスケードLOVシナリオで親および子の固定選択リスト間の関係を示すために使用される関係識別子。
      • pBusinessUnitId; integer; 有効およびアクティブな参照値の検索に使用されるビジネス・ユニットの一意の識別子。
      • pEffectiveDate; string;参照タイプが有効になる日付。
      • pEnabledFlag; string; 参照タイプが有効かどうかを示します。
      • pLookupType; string.
      • pReferenceGroupName; string;子参照値をフィルタ処理するために有効およびアクティブな参照値の検索に使用される参照グループの名前。
    • CommonSetIdWithBUIdFinder: 参照タイプ、参照グループ名、ビジネス・ユニット識別子などの属性の組合せによって、使用可能およびアクティブな参照値が検索されます。 また、子参照値を親参照タイプに基づいてフィルタする必要があるカスケード固定選択リストでも使用されます。
      ファインダ変数:
      • Bind_ParentLookupCode; string;カスケード固定選択リストの親固定選択リストの参照コード。
      • Bind_ParentSetidDetermType; string;カスケード固定選択リスト内の親固定選択リストの決定要因タイプ。
      • Bind_ParentSetidDetermValue; string;カスケード固定選択リスト内の親固定選択リストの決定要因値。
      • Bind_RelationshipId; integer; カスケードLOVシナリオで親および子の固定選択リスト間の関係を示すために使用される関係識別子。
      • pBusinessUnitId; integer;ビジネス・ユニットの一意の識別子。
      • pEffectiveDate; string;参照タイプが有効になる日付。
      • pEnabledFlag; string; 参照タイプが有効かどうかを示します。
      • pLookupType; string.
      • pReferenceGroupName; string;有効およびアクティブな参照値の検索に使用される参照グループの名前。
    • PrimaryKey : 指定した主キーを持つレコードを検索します。
      ファインダ変数:
      • LookupCode; string; 参照の識別に使用されるコード。
      • LookupType; string; 参照値に関連付けられた参照タイプ。
      • SetId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • BUId; integer;ビジネス・ユニットの一意の識別子。
    • CreatedBy; string; レコードを作成したユーザー。
    • CreationDate; string; レコードが作成された日時。
    • Description; string;参照タイプの摘要。
    • DisplaySequence; integer;参照タイプがリスト順序に表示される場所を示す数値。
    • EndDateActive; string; 参照タイプが非アクティブになる日付。
    • LastUpdateDate; string; レコードが最後に更新された日時。
    • LastUpdateLogin; string; レコードを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; レコードを最後に更新したユーザー。
    • LookupCode; string; 参照の識別に使用されるコード。
    • LookupType; string; 参照値に関連付けられた参照タイプ。
    • 内容;文字列;参照タイプの意味。
    • SetId; integer;参照値の参照データ・セットの識別子。
    • StartDateActive; string; 参照タイプが有効であった日付。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : crmBusinessUnits-fndCommonSetIdLookups
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : crmBusinessUnits-fndCommonSetIdLookups-item-response
タイプ: object
ソースを表示
「トップに戻る」