1. REST API for Oracle Data Transforms
  2. Tasks
  3. Variable

Retrieve Variable

get

[host-url]/dt-rest/v2/variables/{variableId}

Retrieves a variable by its ID.

Request

Path Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

a Response object containing the variable details in JSON format.
Body ()
Root Schema : DTVariableDTO
Match All
Represents a data transforms variable.
Show Source
Example:
{
    "name":"String",
    "variableNumber":123,
    "variableId":"String",
    "dateCreated":"2026-07-11T17:31:43.056058Z",
    "dateUpdated":"2026-07-11T17:31:43.056066Z",
    "projectName":"String",
    "projectId":"String",
    "description":"String",
    "qualifiedName":"String",
    "variableType":"SHORT_TEXT",
    "defaultValue":{
    },
    "schema":"String",
    "schemaShort":"String",
    "schemaId":"String",
    "connectionId":"String",
    "connectionName":"String",
    "refreshQuery":"String",
    "valuePersistence":"HISTORIZE"
}
Nested Schema : DTVariableBaseDTO
Type: object
Represents a data transforms variable with only basic information.
Show Source
Nested Schema : DTVariableDTO-allOf[1]
Type: object
Represents a data transforms variable.
Show Source
  • defaultValue
    Complex object: Object
  • Allowed Values: [ "HISTORIZE", "LATEST_VALUE", "NON_PERSISTENT", "NON_TRACKABLE" ]
    Enumerates the possible value persistence strategies for a variable.
    • Historize: The value of the variable will be historized.
    • Latest value: The latest value held by the variable will be stored in the repository.
    • Non persistent: The value of the variable will not be persisted.
    • Non trackable: The value of the variable will not be tracked.
  • Allowed Values: [ "SHORT_TEXT", "LONG_TEXT", "NUMERIC", "DATE" ]
    Enumerates the possible data types for a variable.
    • Short text: The value can be alphanumeric, can contain special characters, and cannot exceed 255 characters.
    • Long text: The value can be alphanumeric, can contain special characters, and cannot exceed 64000 characters.
    • Numeric: The value can be a numeric value and can be preceded by a minus (-) sign. The value cannot exceed 10 digits. Possible value range is -999999999 to 9999999999.
    • Date: The value is a date format.
Nested Schema : defaultValue
Type: object
Complex object: Object
Examples

401 Response

Unauthorized

404 Response

Not Found
Back to Top