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

すべてのスマート・テキストを取得

get

/crmRestApi/resources/11.13.18.05/smartTexts

リクエスト

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

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

    • FindAllMyHtmlSmartTexts : すべての言語を対象とした、グローバルでユーザー向けのHTMLフラグ付きスマート・テキストを検索します。
      ファインダ変数:
      • BuOrgEnabled; string;デフォルト値をオーバーライドできるYまたはNのフラグ値。
      • BuOrgId; string; 実行する問合せのビジネス・ユニット組織識別子。
      • ドメイン、文字列。スマート・テキストが属するドメインまたはカテゴリ(ORA_GENERICなど)。
      • オブジェクト、文字列。ServiceRequestなど、スマート・テキストを使用するプライマリ・オブジェクト。
      • スコープ、文字列。スマート・テキストが属するスコープ(ORA_SVC_GLOBALやORA_SVC_USERなど)。
      • StdtxtName; string;スマート・テキストの簡単な説明。
      • StripeCd; string; ORA_SVC_CRMやORA_SVC_HCMなど、スマート・テキストが属するストライプ・コード。
    • FindAllMyHtmlSmartTextsByLang : 特定の言語またはユーザーの言語について、グローバルおよびユーザーのHTMLフラグ付きスマート・テキストを検索します。
      ファインダ変数:
      • BuOrgEnabled; string;デフォルト値をオーバーライドできるYまたはNのフラグ値。
      • BuOrgId; string; 実行する問合せのビジネス・ユニット組織識別子。
      • ドメイン、文字列。スマート・テキストが属するドメインまたはカテゴリ(ORA_GENERICなど)。
      • Language; string;翻訳可能列の内容の翻訳先となる言語のコードを示します。
      • オブジェクト、文字列。ServiceRequestなど、スマート・テキストを使用するプライマリ・オブジェクト。
      • スコープ、文字列。スマート・テキストが属するスコープ(ORA_SVC_GLOBALやORA_SVC_USERなど)。
      • StdtxtName; string; スマート・テキストの簡単な説明。
      • StripeCd; string; ORA_SVC_CRMやORA_SVC_HCMなど、スマート・テキストが属するストライプ・コード。
    • FindAllMyPlainSmartTexts : グローバルおよびユーザー・プレーン・テキストのスマート・テキストをすべての言語で検索します。
      ファインダ変数:
      • BuOrgEnabled; string;デフォルト値をオーバーライドできるYまたはNのフラグ値。
      • BuOrgId; string; 実行する問合せのビジネス・ユニット組織識別子。
      • ドメイン、文字列。スマート・テキストが属するドメインまたはカテゴリ(ORA_GENERICなど)。
      • オブジェクト、文字列。ServiceRequestなど、スマート・テキストを使用するプライマリ・オブジェクト。
      • スコープ、文字列。スマート・テキストが属するスコープ(ORA_SVC_GLOBALやORA_SVC_USERなど)。
      • StdtxtName; string; スマート・テキストの簡単な説明。
      • StripeCd; string; ORA_SVC_CRMやORA_SVC_HCMなど、スマート・テキストが属するストライプ・コード。
    • FindAllMyPlainSmartTextsByLang : 特定の言語またはユーザーの言語について、グローバルおよびユーザーのプレーン・テキストのスマート・テキストを検索します。
      ファインダ変数:
      • BuOrgEnabled; string;デフォルト値をオーバーライドできるYまたはNのフラグ値。
      • BuOrgId; string; 実行する問合せのビジネス・ユニット組織識別子。
      • ドメイン、文字列。スマート・テキストが属するドメインまたはカテゴリ(ORA_GENERICなど)。
      • Language; string;翻訳可能列の内容の翻訳先となる言語のコードを示します。
      • オブジェクト、文字列。ServiceRequestなど、スマート・テキストを使用するプライマリ・オブジェクト。
      • スコープ、文字列。スマート・テキストが属するスコープ(ORA_SVC_GLOBALやORA_SVC_USERなど)。
      • StdtxtName; string; スマート・テキストの簡単な説明。
      • StripeCd; string; ORA_SVC_CRMやORA_SVC_HCMなど、スマート・テキストが属するストライプ・コード。
    • FindAllMySmartTexts : すべての言語のグローバルおよびユーザー・スマート・テキストを検索します。
      ファインダ変数:
      • BuOrgEnabled; string;デフォルト値をオーバーライドできるYまたはNのフラグ値。
      • BuOrgId; string; 実行する問合せのビジネス・ユニット組織識別子。
      • ドメイン、文字列。スマート・テキストが属するドメインまたはカテゴリ(ORA_GENERICなど)。
      • オブジェクト、文字列。ServiceRequestなど、スマート・テキストを使用するプライマリ・オブジェクト。
      • スコープ、文字列。スマート・テキストが属するスコープ(ORA_SVC_GLOBALやORA_SVC_USERなど)。
      • StdtxtName; string; スマート・テキストの簡単な説明。
      • StripeCd; string; ORA_SVC_CRMやORA_SVC_HCMなど、スマート・テキストが属するストライプ・コード。
    • FindAllMySmartTextsByLang : 特定の言語またはユーザーの言語について、グローバルおよびユーザーのスマート・テキストを検索します。
      ファインダ変数:
      • BuOrgEnabled; string;デフォルト値をオーバーライドできるYまたはNのフラグ値。
      • BuOrgId; string; 実行する問合せのビジネス・ユニット組織識別子。
      • ドメイン、文字列。スマート・テキストが属するドメインまたはカテゴリ(ORA_GENERICなど)。
      • Language; string;翻訳可能列の内容の翻訳先となる言語のコードを示します。
      • オブジェクト、文字列。ServiceRequestなど、スマート・テキストを使用するプライマリ・オブジェクト。
      • スコープ、文字列。スマート・テキストが属するスコープ(ORA_SVC_GLOBALやORA_SVC_USERなど)。
      • StdtxtName; string; スマート・テキストの簡単な説明。
      • StripeCd; string; ORA_SVC_CRMやORA_SVC_HCMなど、スマート・テキストが属するストライプ・コード。
    • FindPrimaryKeyRow : 一意の識別子でスマート・テキストを検索します。
      ファインダ変数:
      • Language; string;翻訳可能列の内容の翻訳先となる言語のコードを示します。
      • StdTxtId; string;スマート・テキストの一意の識別子。
    • PrimaryKey : 指定されたファインダを持つスマート・テキストを検索します。
      ファインダ変数:
      • Language; string;翻訳可能列の内容の翻訳先となる言語のコードを示します。
      • StandardTextId; integer; 言語とともにスマート・テキスト翻訳エンティティの一意の識別子。
      • StdTxtId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • BuOrgId; integer; 主にスマート・テキストを使用するビジネス・ユニットの一意の識別子。
    • CreatedBy; string;スマート・テキストを作成したユーザー。
    • CreationDate; string;スマート・テキストが作成された日時。
    • ドメイン、文字列。スマート・テキストが属するドメインまたはカテゴリ(ORA_GENERICなど)。
    • EnabledFlag; boolean;標準テキストが使用可能かどうかを示します。
    • EndDate; string;スマート・テキストの使用が期限切れになる日付。
    • FolderId; integer; 標準テキストが割り当てられるフォルダの一意の識別子。
    • HtmlFlag; boolean。標準テキストがリッチ・テキストかプレーン・テキストかを示します。 可能な値ははいおよびいいえです。値がはいの場合、標準テキストはリッチ・テキスト形式になります。
    • Language; string;翻訳可能列の内容の翻訳先となる言語のコードを示します。
    • LastUpdateDate; string;スマート・テキストが最後に更新された日付。
    • LastUpdateLogin; string;スマート・テキストを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string;スマート・テキストを最後に更新したユーザー。
    • オブジェクト、文字列。ServiceRequestなど、スマート・テキストを使用するプライマリ・オブジェクト。
    • スコープ、文字列。スマート・テキストがグローバルにアクセスできるか、特定のユーザーがアクセスできるかを示します。 指定可能な値は、ORA_SVC_GLOBALおよびORA_SVC_USERです。 値がORA_SVC_USERの場合、スマート・テキストは特定のユーザーがアクセスできます。 ユーザーのパーティIDは、USER_PARTY_ID属性で設定されます。
    • StandardTextId; integer; 言語とともにスマート・テキスト翻訳エンティティの一意の識別子。
    • StartDate; string;スマート・テキストの使用が開始される日付。
    • StdtxtName; string; 標準テキストの簡単な説明。
    • StripeCd; string; ORA_SVC_CRMやORA_SVC_HCMなど、スマート・テキストが属するストライプを示します。
    • ツールチップ、文字列、テキスト値から導出されたツールチップ・テキスト。
    • UniqueNumber; string;行の一意の識別子。
    • UserPartyId; integer; スマート・テキストのスコープがORA_SVC_USERに設定されている場合に、スマート・テキストにアクセスできるユーザー。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : smartTexts
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : smartTexts-item-response
タイプ: object
ソースを表示
  • 主にスマート・テキストを使用するビジネス・ユニットの一意の識別子。
  • 読取り専用: true
    最大長: 64
    スマート・テキストを作成したユーザー。
  • 読取り専用: true
    スマート・テキストが作成された日時。
  • 最大長: 30
    スマート・テキストが属するドメインまたはカテゴリ(ORA_GENERICなど)。
  • 最大長: 1
    デフォルト値: true
    標準テキストが使用可能かどうかを示します。
  • スマート・テキストの使用が失効する日付。
  • 標準テキストが割り当てられるフォルダの一意の識別子。
  • 最大長: 20
    デフォルト値: false
    標準テキストがリッチ・テキストかプレーン・テキストかを示します。 可能な値ははいおよびいいえです。値がはいの場合、標準テキストはリッチ・テキスト形式になります。
  • 最大長: 4
    翻訳可能な列の内容の翻訳先となる言語のコードを示します。
  • 読取り専用: true
    スマート・テキストが最後に更新された日付。
  • 読取り専用: true
    最大長: 64
    スマート・テキストを最後に更新したユーザー。
  • 読取り専用: true
    最大長: 32
    スマート・テキストを最後に更新したユーザーのログイン。
  • Links
  • 最大長: 150
    ServiceRequestなど、スマート・テキストを使用するプライマリ・オブジェクト。
  • 最大長: 20
    デフォルト値: ORA_SVC_USER
    スマート・テキストがグローバルにアクセス可能か、特定のユーザーにアクセス可能かを示します。 指定可能な値は、ORA_SVC_GLOBALおよびORA_SVC_USERです。 値がORA_SVC_USERの場合、スマート・テキストは特定のユーザーがアクセスできます。 ユーザーのパーティIDは、USER_PARTY_ID属性で設定されます。
  • 読取り専用: true
    言語とともにスマート・テキスト翻訳エンティティの一意の識別子。
  • スマート・テキストの使用が開始する日付。
  • 読取り専用: true
    スマート・テキストの一意の識別子。 これを使用して、スマート・テキストを取得できます。
  • 最大長: 50
    標準テキストの簡単な説明。
  • 最大長: 30
    ORA_SVC_CRMやORA_SVC_HCMなど、スマート・テキストが属するストライプを示します。
  • スマート・テキストを形成する言語依存および翻訳可能な標準テキスト。
  • 読取り専用: true
    最大長: 4000
    テキスト値から導出されたツールチップ・テキスト。
  • 最大長: 30
    行の一意の識別子。
  • スマート・テキストのスコープがORA_SVC_USERに設定されている場合に、スマート・テキストにアクセスできるユーザー。
リンク
fetchSmartTextVarValues
このアクションは、スマート・テキストおよび参照オブジェクトの主キーを含むjsonStringを受け入れます。 レスポンスには、変数のコレクションとその導出値、およびそれぞれの表示名を持つプロンプト変数のコレクションが含まれます。
processSmartTextById
このアクションは、スマート・テキストおよび参照オブジェクトの主キーを含むjsonStringを受け入れます。 次に、スマート・テキストの変数を参照オブジェクトから取得したデータに置き換えます。 または、主キーのかわりにPUIDを使用して、スマート・テキストを参照できます。
トップに戻る

例:

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

cURLコマンド

curl -u <username:password> \ -X GET -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/smartTexts/00020000000249570000000EACED00057708000110F09A45504D

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

None

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
    "StdTxtId": 300100543139917,
    "CreatedBy": "SALES_ADMIN",
    "CreationDate": "2021-07-22T06:10:30+00:00",
    "LastUpdatedBy": "SALES_ADMIN",
    "LastUpdateDate": "2021-07-22T06:11:36.288+00:00",
    "LastUpdateLogin": "C78750D660F2EBC7E0530740F00AD229",
    "StdtxtName": "Test",
    "HtmlFlag": true,
    "FolderId": 300100543139872,
    "Scope": "ORA_SVC_GLOBAL",
    "UserPartyId": null,
    "EnabledFlag": true,
    "StartDate": "2021-07-22",
    "EndDate": null,
    "Domain": "ORA_GENERIC",
    "Object": "ServiceRequestVO",
    "StripeCd": "ORA_SVC_CRM",
    "BuOrgId": 204,
    "Language": "IW",
    "StandardTextId": 300100543139917,
    "UniqueNumber": "CDRM_3",
    "links": [ 
...
}
「トップに戻る」