1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Smart Texts

Get a smart text

get

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

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key--- StdTxtId, Language and StandardTextId ---for the Smart Texts resource and used to uniquely identify an instance of Smart Texts. The client should not generate the hash key value. Instead, the client should query on the Smart Texts collection resource with a filter on the primary key values in order to navigate to a specific instance of Smart Texts.

    For example: smartTexts?q=StdTxtId=<value1>;Language=<value2>;StandardTextId=<value3>
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : smartTexts-item-response
Type: object
Show Source
  • The unique identifier of the business unit that primarily uses the smart text.
  • Read Only: true
    Maximum Length: 64
    The user who created the smart text.
  • Read Only: true
    The date and time when the smart text was created.
  • Maximum Length: 30
    The domain or category to which the smart text belongs to, such as ORA_GENERIC.
  • Maximum Length: 1
    Default Value: true
    Indicates whether the standard text is enabled for use.
  • The date when the use of the smart text expires.
  • The unique identifier of the folder to which the standard text is assigned.
  • Maximum Length: 20
    Default Value: false
    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.
  • Maximum Length: 4
    Indicates the code of the language into which the contents of the translatable columns are translated.
  • Read Only: true
    The date when the smart text was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the smart text.
  • Read Only: true
    Maximum Length: 32
    The login of the user who last updated the smart text.
  • Links
  • Maximum Length: 150
    The primary object for which the smart text is used for, such as ServiceRequest.
  • Maximum Length: 20
    Default Value: ORA_SVC_USER
    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.
  • Read Only: true
    The unique identifier of the smart text translation entity along with the language.
  • The date when the use of the smart text begins.
  • Read Only: true
    The unique identifier of the smart text. You can use this to retrieve a smart text.
  • Maximum Length: 50
    A short description of the standard text.
  • Maximum Length: 30
    Indicates the stripe to which the smart text belongs to, such as ORA_SVC_CRM or ORA_SVC_HCM.
  • The language dependent and translatable standard text that forms the smart text.
  • Read Only: true
    Maximum Length: 4000
    Tooltip text derived from text value.
  • Maximum Length: 30
    The unique identifier of the row.
  • The user who can access the smart text, when the Scope of the smart text is set to ORA_SVC_USER.
Links
processSmartText
Parameters:
  • smartTextsUniqID: $request.path.smartTextsUniqID
This action accepts a jsonString with the primary keys of the smart text and the referenced object. The action then substitutes the variables in the smart text with the data obtained from the referenced object. Alternatively, you can use the PUID instead of the primary key to reference the smart text.
Back to Top

Examples

The following example shows how to get all smart texts by submitting a get request on the REST resource using cURL.

cURL Command

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

Example of Request Body

The following shows an example of the request body in JSON format.

None

Example of Response Body

The following shows an example of the response body in JSON format.

    {
    "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": [
...
}
Back to Top