機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. スマート・テキスト・ユーザー変数

すべてのスマート・テキスト・ユーザー変数の取得

get

/crmRestApi/resources/11.13.18.05/smartTextUserVariables

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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>

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

    • FindUserVariables : 部分変数コードによるユーザー変数の大/小文字を区別しない検索。
      ファインダ変数:
      • BuOrgEnabled; string;デフォルト値をオーバーライドできるYまたはNのフラグ値。
      • BuOrgId; string; 実行する問合せのビジネス・ユニット組織識別子。
      • ShowNullBuOrgId; string; YまたはNのフラグ値。ビジネス・ユニット組織識別子にNULL値を持つ行を含めることができます。
      • VariableCode; string;問合せを実行するユーザー変数の部分的な変数コード値。 検索では大/小文字が区別されません。
    • PrimaryKey : 指定された主キーを持つスマート・テキスト・ユーザー変数を検索します。
      ファインダ変数:
      • VariableId; integer; スマート・テキスト・ユーザー変数の一意の識別子。 これを使用して、スマート・テキスト・ユーザー変数を取得できます。
    • UserVarUniqueNumberAltKey : 公開一意識別子を持つスマート・テキスト・ユーザー変数を検索します。
      ファインダ変数:
      • VariableUniqueNumber; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • Attribute; string;置換の値を保持するオブジェクトのフィールドまたは属性。
    • BuOrgId; integer; ユーザー変数に対するビジネス・ユニット組織の一意の識別子。
    • Context; string;この変数が使用されるアプリケーションまたはコンテキスト。
    • CreatedBy; string;スマート・テキスト・ユーザー変数を作成したユーザー。
    • CreationDate; string;スマート・テキスト・ユーザー変数が作成された日時。
    • Description; string;変数の簡単な説明。
    • LastUpdateDate; string;スマート・テキスト・ユーザー変数が最後に更新された日付。
    • LastUpdateLogin; string;スマート・テキスト・ユーザー変数を最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; スマート・テキスト・ユーザー変数を最後に更新したユーザー。
    • Object; string;これは、変数を置換する値を保持するオブジェクトへの参照です。
    • StripeCd; string; CRM、HCM、PRMなどのストライプ・コードを示す参照コード。
    • ValChar; string;変数置換の静的文字値。
    • VariableCode; string; コンテキストを実際の値に置換するためにUIに表示される変数。
    • VariableId; integer; スマート・テキスト・ユーザー変数の一意の識別子。
    • VariableNumber; string;公開サロゲート・キー。
    • VariableUniqueNumber; string;必須の公開一意サロゲート・キー。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : smartTextUserVariables
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : smartTextUserVariables-item-response
タイプ: object
ソースを表示
  • 最大長: 50
    置換の値を保持するオブジェクトのフィールドまたは属性。
  • タイトル: Business Unit
    ユーザー変数に対するビジネス・ユニット組織の一意の識別子。
  • タイトル: Domain
    最大長: 50
    デフォルト値: ORA_SVC_SR
    この変数が使用されるアプリケーションまたはコンテキスト。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    スマート・テキスト・ユーザー変数を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    スマート・テキスト・ユーザー変数が作成された日時。
  • 最大長: 50
    変数の簡単な説明。
  • タイトル: Last Updated Date
    読取り専用: true
    スマート・テキスト・ユーザー変数が最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    スマート・テキスト・ユーザー変数を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    スマート・テキスト・ユーザー変数を最後に更新したユーザーのログイン。
  • Links
  • タイトル: Object
    最大長: 150
    これは、変数に置換する値を保持するオブジェクトへの参照です。
  • タイトル: Stripe Code
    最大長: 30
    CRM、HCM、PRMなどのストライプ・コードを示す参照コード。
  • 最大長: 255
    デフォルト値: Prompt
    導出に使用されるメソッドの摘要値です。 値には、プロンプト、値および評価があります。
  • タイトル: Value
    最大長: 150
    変数置換の静的文字値。
  • タイトル: Variable
    最大長: 50
    コンテキストを実際の値に置換するためにUIに表示される変数。
  • タイトル: Variable ID
    読取り専用: true
    スマート・テキスト・ユーザー変数の一意の識別子。
  • 最大長: 30
    公開サロゲート・キー。
  • 最大長: 30
    必須の公開一意サロゲート・キー。
「トップに戻る」