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

スマート・テキストの取得

get

/crmRestApi/resources/11.13.18.05/smartTexts/{smartTextsUniqID}

リクエスト

パス・パラメータ
  • これは、スマート・テキスト・リソースに対してコンポジット・キー(StdTxtId、LanguageおよびStandardTextId)を構成する属性のハッシュ・キーで、スマート・テキストのインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、スマート・テキストの特定のインスタンスにナビゲートするために、主キー値に対するフィルタを使用してスマート・テキスト・コレクション・リソースを問い合せる必要があります。

    次に例を示します: smartTexts?q=StdTxtId=<value1>;Language=<value2>;StandardTextId=<value3>
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: 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
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : 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に設定されている場合に、スマート・テキストにアクセスできるユーザー。
リンク
processSmartText
パラメータ:
  • smartTextsUniqID: $request.path.smartTextsUniqID
このアクションは、スマート・テキストおよび参照オブジェクトの主キーを含む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

リクエスト本文の例

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

None

レスポンス本文の例

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

    {
    "items": [
        {
            "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": [
                {
                    "rel": "self",
                    "href": "https://fuscdrmsmc196-https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/smartTexts/00020000000249570000000EACED00057708000110F09A45504D",
                    "name": "smartTexts",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://fuscdrmsmc196-https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/smartTexts/00020000000249570000000EACED00057708000110F09A45504D",
                    "name": "smartTexts",
                    "kind": "item"
                },
                {
                    "rel": "action",
                    "href": "https://fuscdrmsmc196-https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/smartTexts/00020000000249570000000EACED00057708000110F09A45504D/action/processSmartText",
                    "name": "processSmartText",
                    "kind": "other"
                },
                {
                    "rel": "enclosure",
                    "href": "https://fuscdrmsmc196-https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/smartTexts/00020000000249570000000EACED00057708000110F09A45504D/enclosure/Text",
                    "name": "Text",
                    "kind": "other"
                }
            ]
        },
        {
            "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": "KO",
            "StandardTextId": 300100543139917,
            "UniqueNumber": "CDRM_3",
            "links": [
...
}
「トップに戻る」