Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

スマート・テキストの作成

post

/crmRestApi/resources/11.13.18.05/smartTexts

リクエスト

ヘッダー・パラメータ

Metadata-Context:

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version:

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
Upsert-Mode:

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

BuOrgId: integer (int64)

主にスマート・テキストを使用するビジネス・ユニットの一意の識別子。
Domain: string

最大長: 30

スマート・テキストが属するドメインまたはカテゴリ(ORA_GENERICなど)。
EnabledFlag: boolean

最大長: 1

デフォルト値: true

標準テキストが使用可能かどうかを示します。
EndDate: 文字列(日付)

スマート・テキストの使用が失効する日付。
FolderId: integer (int64)

標準テキストが割り当てられるフォルダの一意の識別子。
HtmlFlag: boolean

最大長: 20

デフォルト値: false

標準テキストがリッチ・テキストかプレーン・テキストかを示します。可能な値ははいおよびいいえです。値がはいの場合、標準テキストはリッチ・テキスト形式になります。
Language: string

最大長: 4

翻訳可能な列の内容の翻訳先となる言語のコードを示します。
Object: string

最大長: 150

ServiceRequestなど、スマート・テキストを使用するプライマリ・オブジェクト。
Scope: string

最大長: 20

デフォルト値: ORA_SVC_USER

スマート・テキストがグローバルにアクセス可能か、特定のユーザーにアクセス可能かを示します。指定可能な値は、ORA_SVC_GLOBALおよびORA_SVC_USERです。値がORA_SVC_USERの場合、スマート・テキストは特定のユーザーがアクセスできます。ユーザーのパーティIDは、USER_PARTY_ID属性で設定されます。
StartDate: 文字列(日付)

スマート・テキストの使用が開始する日付。
StdtxtName: string

最大長: 50

標準テキストの簡単な説明。
StripeCd: string

最大長: 30

ORA_SVC_CRMやORA_SVC_HCMなど、スマート・テキストが属するストライプを示します。
テキスト: 文字列(バイト)

スマート・テキストを形成する言語依存および翻訳可能な標準テキスト。
UniqueNumber: string

最大長: 30

行の一意の識別子。
UserPartyId: integer (int64)

スマート・テキストのスコープがORA_SVC_USERに設定されている場合に、スマート・テキストにアクセスできるユーザー。

{
    "type":"object",
    "properties":{
        "Text":{
            "type":"string",
            "description":"The language dependent and translatable standard text that forms the smart text.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "UniqueNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the row.",
            "nullable":false
        },
        "FolderId":{
            "type":"integer",
            "description":"The unique identifier of the folder to which the standard text is assigned.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "HtmlFlag":{
            "maxLength":20,
            "type":"boolean",
            "description":"Indicates if the standard text is rich text or plain text. Possible values are Yes and No. If the values is Yes, then the standard text is in rich text format.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EndDate":{
            "type":"string",
            "description":"The date when the use of the smart text expires.",
            "format":"date",
            "nullable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The date when the use of the smart text begins.",
            "format":"date",
            "nullable":false
        },
        "Scope":{
            "maxLength":20,
            "type":"string",
            "description":"Indicates if the smart text is accessible globally or to a specific user. The possible values are ORA_SVC_GLOBAL and ORA_SVC_USER. If the value is ORA_SVC_USER, then the smart text is accessible to a specific user. The user's party Id is set in the USER_PARTY_ID attribute.",
            "nullable":false,
            "default":"ORA_SVC_USER"
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Indicates the code of the language into which the contents of the translatable columns are translated.",
            "nullable":false
        },
        "StripeCd":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the stripe to which the smart text belongs to, such as ORA_SVC_CRM or ORA_SVC_HCM.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Object":{
            "maxLength":150,
            "type":"string",
            "description":"The primary object for which the smart text is used for, such as ServiceRequest.",
            "nullable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the standard text is enabled for use.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Domain":{
            "maxLength":30,
            "type":"string",
            "description":"The domain or category to which the smart text belongs to, such as ORA_GENERIC.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BuOrgId":{
            "type":"integer",
            "description":"The unique identifier of the business unit that primarily uses the smart text.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "UserPartyId":{
            "type":"integer",
            "description":"The user who can access the smart text, when the Scope of the smart text is set to ORA_SVC_USER.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "StdtxtName":{
            "maxLength":50,
            "type":"string",
            "description":"A short description of the standard text.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

Metadata-Context(required):

REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
REST-Framework-Version(required):

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : smartTexts-item-response

タイプ: object

ソースを表示

BuOrgId: integer (int64)

主にスマート・テキストを使用するビジネス・ユニットの一意の識別子。
CreatedBy: string

読取り専用: true

最大長: 64

スマート・テキストを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

スマート・テキストが作成された日時。
Domain: string

最大長: 30

スマート・テキストが属するドメインまたはカテゴリ(ORA_GENERICなど)。
EnabledFlag: boolean

最大長: 1

デフォルト値: true

標準テキストが使用可能かどうかを示します。
EndDate: 文字列(日付)

スマート・テキストの使用が失効する日付。
FolderId: integer (int64)

標準テキストが割り当てられるフォルダの一意の識別子。
HtmlFlag: boolean

最大長: 20

デフォルト値: false

標準テキストがリッチ・テキストかプレーン・テキストかを示します。可能な値ははいおよびいいえです。値がはいの場合、標準テキストはリッチ・テキスト形式になります。
Language: string

最大長: 4

翻訳可能な列の内容の翻訳先となる言語のコードを示します。
LastUpdateDate: string (date-time)

読取り専用: true

スマート・テキストが最後に更新された日付。
LastUpdatedBy: string

読取り専用: true

最大長: 64

スマート・テキストを最後に更新したユーザー。
LastUpdateLogin: string

読取り専用: true

最大長: 32

スマート・テキストを最後に更新したユーザーのログイン。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
Object: string

最大長: 150

ServiceRequestなど、スマート・テキストを使用するプライマリ・オブジェクト。
Scope: string

最大長: 20

デフォルト値: ORA_SVC_USER

スマート・テキストがグローバルにアクセス可能か、特定のユーザーにアクセス可能かを示します。指定可能な値は、ORA_SVC_GLOBALおよびORA_SVC_USERです。値がORA_SVC_USERの場合、スマート・テキストは特定のユーザーがアクセスできます。ユーザーのパーティIDは、USER_PARTY_ID属性で設定されます。
StandardTextId: integer (int64)

読取り専用: true

言語とともにスマート・テキスト翻訳エンティティの一意の識別子。
StartDate: 文字列(日付)

スマート・テキストの使用が開始する日付。
StdTxtId: integer (int64)

読取り専用: true

スマート・テキストの一意の識別子。これを使用して、スマート・テキストを取得できます。
StdtxtName: string

最大長: 50

標準テキストの簡単な説明。
StripeCd: string

最大長: 30

ORA_SVC_CRMやORA_SVC_HCMなど、スマート・テキストが属するストライプを示します。
テキスト: 文字列(バイト)

スマート・テキストを形成する言語依存および翻訳可能な標準テキスト。
Tooltip: string

読取り専用: true

最大長: 4000

テキスト値から導出されたツールチップ・テキスト。
UniqueNumber: string

最大長: 30

行の一意の識別子。
UserPartyId: integer (int64)

スマート・テキストのスコープがORA_SVC_USERに設定されている場合に、スマート・テキストにアクセスできるユーザー。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the smart text.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the smart text was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the smart text.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Tooltip":{
            "maxLength":4000,
            "type":"string",
            "description":"Tooltip text derived from text value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StandardTextId":{
            "type":"integer",
            "description":"The unique identifier of the smart text translation entity along with the language.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Text":{
            "type":"string",
            "description":"The language dependent and translatable standard text that forms the smart text.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "UniqueNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the row.",
            "nullable":false,
            "x-queryable":true
        },
        "FolderId":{
            "type":"integer",
            "description":"The unique identifier of the folder to which the standard text is assigned.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HtmlFlag":{
            "maxLength":20,
            "type":"boolean",
            "description":"Indicates if the standard text is rich text or plain text. Possible values are Yes and No. If the values is Yes, then the standard text is in rich text format.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The date when the use of the smart text expires.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The date when the use of the smart text begins.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "Scope":{
            "maxLength":20,
            "type":"string",
            "description":"Indicates if the smart text is accessible globally or to a specific user. The possible values are ORA_SVC_GLOBAL and ORA_SVC_USER. If the value is ORA_SVC_USER, then the smart text is accessible to a specific user. The user's party Id is set in the USER_PARTY_ID attribute.",
            "nullable":false,
            "default":"ORA_SVC_USER",
            "x-queryable":true
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Indicates the code of the language into which the contents of the translatable columns are translated.",
            "nullable":false,
            "x-queryable":true
        },
        "StripeCd":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the stripe to which the smart text belongs to, such as ORA_SVC_CRM or ORA_SVC_HCM.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StdTxtId":{
            "type":"integer",
            "description":"The unique identifier of the smart text. You can use this to retrieve a smart text.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Object":{
            "maxLength":150,
            "type":"string",
            "description":"The primary object for which the smart text is used for, such as ServiceRequest.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the standard text is enabled for use.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Domain":{
            "maxLength":30,
            "type":"string",
            "description":"The domain or category to which the smart text belongs to, such as ORA_GENERIC.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BuOrgId":{
            "type":"integer",
            "description":"The unique identifier of the business unit that primarily uses the smart text.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserPartyId":{
            "type":"integer",
            "description":"The user who can access the smart text, when the Scope of the smart text is set to ORA_SVC_USER.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the smart text was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the smart text.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StdtxtName":{
            "maxLength":50,
            "type":"string",
            "description":"A short description of the standard text.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

href: string

タイトル: hyperlink reference

関連リソースへのURI。
kind: string

タイトル: kind

許可された値: [ "collection", "item", "describe", "other" ]

関連リソースの種類。
name: string

タイトル: name

関連リソースへのリンクの名前。
properties: object properties
rel: string

タイトル: relation

許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

リソース・インスタンスとの関係の名前。例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

changeIndicator: string

リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

リンク

processSmartText

操作: /crmRestApi/resources/11.13.18.05/smartTexts/{smartTextsUniqID}/action/processSmartText

パラメータ:

smartTextsUniqID: $request.path.smartTextsUniqID

このアクションは、スマート・テキストおよび参照オブジェクトの主キーを含むjsonStringを受け入れます。このアクションは、スマート・テキストの変数を参照オブジェクトから取得したデータに置き換えます。または、主キーのかわりにPUIDを使用して、スマート・テキストを参照できます。

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するポスト・リクエストを発行してスマート・テキストを作成する方法を示しています。

cURLコマンド

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

リクエスト本文の例

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

{
    "StdtxtName": "Customer Smarttext UseCase",
    "UniqueNumber":"CUST_0001",
    "HtmlFlag": "Y",
    "Scope": "ORA_SVC_GLOBAL",
    "FolderId": 300100543139872,
    "Object": "ServiceRequestVO",
    "BuOrgId": 204,
    "Text": "RGVhciBbW1NlcnZpY2VSZXF1ZXN0Vk8uUHJpbWFyeUNvbnRhY3RQYXJ0eU5hbWVdXTo8YnIgLz48YnIgLz5Zb3VyIGNvZGUgcmVxdWVzdCBOdW1iZXIgW1tTZXJ2aWNlUmVxdWVzdFZPLlNyTnVtYmVyXV0gaXMgYmVpbmcgYXR0ZW5kZWQuPGJyIC8+PGJyIC8+UmVnYXJkcyw=",
    "Language": "US"
}

レスポンス本文の例

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

{
    "StdTxtId": 300100547184758,
    "CreatedBy": "SALES_ADMIN",
    "CreationDate": "2021-05-06T15:01:35+00:00",
    "LastUpdatedBy": "SALES_ADMIN",
    "LastUpdateDate": "2021-05-06T15:01:35.040+00:00",
    "LastUpdateLogin": "C1790815EA079FCAE053773AF80ABE96",
    "StdtxtName": "Customer Smarttext Example",
    "HtmlFlag": true,
    "FolderId": 300100543810122,
    "Scope": "ORA_SVC_GLOBAL",
    "UserPartyId": null,
    "EnabledFlag": true,
    "StartDate": "2021-05-06",
    "EndDate": null,
    "Domain": "ORA_GENERIC",
    "Object": "ServiceRequestVO",
    "StripeCd": "ORA_SVC_CRM",
    "BuOrgId": 204,
    "Language": "US",
    "StandardTextId": null,
    "UniqueNumber": "CUST_0001",
    "links": [
        {
            "rel": "self",
            "href": "https:/myapplicationdomain.com:port/crmRestApi/resources/11.13.18.05/smartTexts/00020000000255530000000EACED00057708000110F09A830876",
            "name": "smartTexts",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https:/myapplicationdomain.com:port/crmRestApi/resources/11.13.18.05/smartTexts/00020000000255530000000EACED00057708000110F09A830876",
            "name": "smartTexts",
            "kind": "item"
        },
        {
            "rel": "action",
            "href": "https:/myapplicationdomain.com:port/crmRestApi/resources/11.13.18.05/smartTexts/00020000000255530000000EACED00057708000110F09A830876/action/processSmartText",
            "name": "processSmartText",
            "kind": "other"
        },
        {
            "rel": "enclosure",
            "href": "https:/myapplicationdomain.com:port/crmRestApi/resources/11.13.18.05/smartTexts/00020000000255530000000EACED00057708000110F09A830876/enclosure/Text",
            "name": "Text",
            "kind": "other"
        }
    ]
}

「トップに戻る」