Get all smart texts

get

/crmRestApi/resources/11.13.18.05/smartTexts

Request

Query Parameters
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • FindAllMyHtmlSmartTexts: Finds a global and user HTML-flagged smart texts for all languages.
      Finder Variables:
      • BuOrgEnabled; string; The flag value of Y or N allowing the ability to override the default value.
      • BuOrgId; string; The business unit organization identifier for the query to run against.
      • Domain; string; The domain or category to which the smart text belongs to, such as ORA_GENERIC.
      • Object; string; The primary object for which the smart text is used for, such as ServiceRequest.
      • Scope; string; The scope to which the Smart Text belongs, such as ORA_SVC_GLOBAL and ORA_SVC_USER.
      • StdtxtName; string; A short description of the smart text.
      • StripeCd; string; The stripe code to which the Smart Text belongs, such as ORA_SVC_CRM and ORA_SVC_HCM.
    • FindAllMyHtmlSmartTextsByLang: Finds a global and user HTML-flagged Smart Texts for a particular language or by default the user's language.
      Finder Variables:
      • BuOrgEnabled; string; The flag value of Y or N allowing the ability to override the default value.
      • BuOrgId; string; The business unit organization identifier for the query to run against.
      • Domain; string; The domain or category to which the Smart Text belongs to, such as ORA_GENERIC.
      • Language; string; Indicates the code of the language into which the contents of the translatable columns are translated.
      • Object; string; The primary object for which the Smart Text is used for, such as ServiceRequest.
      • Scope; string; The scope to which the Smart Text belongs, such as ORA_SVC_GLOBAL and ORA_SVC_USER.
      • StdtxtName; string; A short description of the Smart Text.
      • StripeCd; string; The stripe code to which the Smart Text belongs, such as ORA_SVC_CRM and ORA_SVC_HCM.
    • FindAllMyPlainSmartTexts: Finds global and user plain text Smart Texts in all languages.
      Finder Variables:
      • BuOrgEnabled; string; The flag value of Y or N allowing the ability to override the default value.
      • BuOrgId; string; The business unit organization identifier for the query to run against.
      • Domain; string; The domain or category to which the Smart Text belongs to, such as ORA_GENERIC.
      • Object; string; The primary object for which the Smart Text is used for, such as ServiceRequest.
      • Scope; string; The scope to which the Smart Text belongs, such as ORA_SVC_GLOBAL and ORA_SVC_USER.
      • StdtxtName; string; A short description of the Smart Text.
      • StripeCd; string; The stripe code to which the Smart Text belongs, such as ORA_SVC_CRM and ORA_SVC_HCM.
    • FindAllMyPlainSmartTextsByLang: Finds global and user plain text Smart Texts for a particular language or by default the user's language.
      Finder Variables:
      • BuOrgEnabled; string; The flag value of Y or N allowing the ability to override the default value.
      • BuOrgId; string; The business unit organization identifier for the query to run against.
      • Domain; string; The domain or category to which the Smart Text belongs to, such as ORA_GENERIC.
      • Language; string; Indicates the code of the language into which the contents of the translatable columns are translated.
      • Object; string; The primary object for which the Smart Text is used for, such as ServiceRequest.
      • Scope; string; The scope to which the Smart Text belongs, such as ORA_SVC_GLOBAL and ORA_SVC_USER.
      • StdtxtName; string; A short description of the Smart Text.
      • StripeCd; string; The stripe code to which the Smart Text belongs, such as ORA_SVC_CRM and ORA_SVC_HCM.
    • FindAllMySmartTexts: Finds global and user Smart Texts for all languages.
      Finder Variables:
      • BuOrgEnabled; string; The flag value of Y or N allowing the ability to override the default value.
      • BuOrgId; string; The business unit organization identifier for the query to run against.
      • Domain; string; The domain or category to which the Smart Text belongs to, such as ORA_GENERIC.
      • Object; string; The primary object for which the Smart Text is used for, such as ServiceRequest.
      • Scope; string; The scope to which the Smart Text belongs, such as ORA_SVC_GLOBAL and ORA_SVC_USER.
      • StdtxtName; string; A short description of the Smart Text.
      • StripeCd; string; The stripe code to which the Smart Text belongs, such as ORA_SVC_CRM and ORA_SVC_HCM.
    • FindAllMySmartTextsByLang: Finds global and user Smart Texts for a particular language or by default the user's language.
      Finder Variables:
      • BuOrgEnabled; string; The flag value of Y or N allowing the ability to override the default value.
      • BuOrgId; string; The business unit organization identifier for the query to run against.
      • Domain; string; The domain or category to which the Smart Text belongs to, such as ORA_GENERIC.
      • Language; string; Indicates the code of the language into which the contents of the translatable columns are translated.
      • Object; string; The primary object for which the Smart Text is used for, such as ServiceRequest.
      • Scope; string; The scope to which the Smart Text belongs, such as ORA_SVC_GLOBAL and ORA_SVC_USER.
      • StdtxtName; string; A short description of the Smart Text.
      • StripeCd; string; The stripe code to which the Smart Text belongs, such as ORA_SVC_CRM and ORA_SVC_HCM.
    • FindPrimaryKeyRow: Finds a Smart Text by the unique identifier.
      Finder Variables:
      • Language; string; Indicates the code of the language into which the contents of the translatable columns are translated.
      • StdTxtId; string; The unique identifier of the Smart Text.
    • PrimaryKey: Finds a Smart Text with the specified finder.
      Finder Variables:
      • Language; string; Indicates the code of the language into which the contents of the translatable columns are translated.
      • StandardTextId; integer; The unique identifier of the smart text translation entity along with the Language.
      • StdTxtId; integer; The unique identifier of the Smart Text. You can use this to retrieve a Smart Text.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • BuOrgId; integer; The unique identifier of the business unit that primarily uses the smart text.
    • CreatedBy; string; The user who created the smart text.
    • CreationDate; string; The date and time when the smart text was created.
    • Domain; string; The domain or category to which the smart text belongs to, such as ORA_GENERIC.
    • EnabledFlag; boolean; Indicates whether the standard text is enabled for use.
    • EndDate; string; The date when the use of the smart text expires.
    • FolderId; integer; The unique identifier of the folder to which the standard text is assigned.
    • HtmlFlag; boolean; 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.
    • Language; string; Indicates the code of the language into which the contents of the translatable columns are translated.
    • LastUpdateDate; string; The date when the smart text was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the smart text.
    • LastUpdatedBy; string; The user who last updated the smart text.
    • Object; string; The primary object for which the smart text is used for, such as ServiceRequest.
    • Scope; string; 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.
    • StandardTextId; integer; The unique identifier of the smart text translation entity along with the language.
    • StartDate; string; The date when the use of the smart text begins.
    • StdtxtName; string; A short description of the standard text.
    • StripeCd; string; Indicates the stripe to which the smart text belongs to, such as ORA_SVC_CRM or ORA_SVC_HCM.
    • Tooltip; string; Tooltip text derived from text value.
    • UniqueNumber; string; The unique identifier of the row.
    • UserPartyId; integer; The user who can access the smart text, when the Scope of the smart text is set to ORA_SVC_USER.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested 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.
Back to Top

Examples

The following example shows how to get a smart text 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/00020000000249570000000EACED00057708000110F09A45504D

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.

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