Jump to

• Request
• Response

Get Smart Text Variable Values

post

/crmRestApi/resources/11.13.18.05/smartTexts/action/fetchSmartTextVarValues

This action accepts a jsonString with the primary keys of the Smart Text and the referenced object. The response contains a collection of variables with their derived values and a collection of prompt variables with their respective display names.

Request

Header Parameters

• Metadata-Context:
  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".
• REST-Framework-Version:
  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.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• paramsValuesJson: string
  A JSON Object represented as a string that provides necessary information to do the variable substitution including the smart text unique identifier, those needed for deriving values for the referenced object and any variable values for the purpose of overriding derived values.

{
    "type":"object",
    "properties":{
        "paramsValuesJson":{
            "type":"string",
            "description":"A JSON Object represented as a string that provides necessary information to do the variable substitution including the smart text unique identifier, those needed for deriving values for the referenced object and any variable values for the purpose of overriding derived values.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  The response is returned as a JSON object represented as a string which contains a collection of variables with their derived values and a collection of prompt variables with their respective display names.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"The response is returned as a JSON object represented as a string which contains a collection of variables with their derived values and a collection of prompt variables with their respective display names."
        }
    },
    "additionalProperties":false
}

Back to Top