Jump to

• Request
• Response

Retrieve Variable

get

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

Retrieves a variable by its ID.

Request

Path Parameters

• variableId(required): string
  the ID of the variable to retrieve.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

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

• object DTVariableBaseDTO
  Represents a data transforms variable with only basic information.
• object DTVariableDTO-allOf[1]
  Represents a data transforms variable.

{
    "allOf":[
        {
            "$ref":"#/components/schemas/DTVariableBaseDTO"
        },
        {
            "type":"object",
            "description":"Represents a data transforms variable.",
            "properties":{
                "qualifiedName":{
                    "type":"string"
                },
                "variableType":{
                    "$ref":"#/components/schemas/DataType"
                },
                "defaultValue":{
                    "type":"object",
                    "description":"Complex object: Object"
                },
                "schema":{
                    "type":"string"
                },
                "schemaShort":{
                    "type":"string"
                },
                "schemaId":{
                    "type":"string"
                },
                "connectionId":{
                    "type":"string"
                },
                "connectionName":{
                    "type":"string"
                },
                "refreshQuery":{
                    "type":"string"
                },
                "valuePersistence":{
                    "$ref":"#/components/schemas/ValuePersistence"
                }
            }
        }
    ]
}

Nested Schema : DTVariableBaseDTO

Type: object

Represents a data transforms variable with only basic information.

Show Source

• dateCreated: string (date-time)
• dateUpdated: string (date-time)
• description: string
• name(required): string
• projectId: string
• projectName: string
• variableId: string
• variableNumber: integer (int64)

{
    "type":"object",
    "description":"Represents a data transforms variable with only basic information.",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string"
        },
        "variableNumber":{
            "type":"integer",
            "format":"int64"
        },
        "variableId":{
            "type":"string"
        },
        "dateCreated":{
            "type":"string",
            "format":"date-time"
        },
        "dateUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "projectName":{
            "type":"string"
        },
        "projectId":{
            "type":"string"
        },
        "description":{
            "type":"string"
        }
    }
}

Nested Schema : DTVariableDTO-allOf[1]

Type: object

Represents a data transforms variable.

Show Source

• connectionId: string
• connectionName: string
• defaultValue: object defaultValue
  Complex object: Object
• qualifiedName: string
• refreshQuery: string
• schema: string
• schemaId: string
• schemaShort: string
• valuePersistence: string
  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.
• variableType: string
  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.

{
    "type":"object",
    "description":"Represents a data transforms variable.",
    "properties":{
        "qualifiedName":{
            "type":"string"
        },
        "variableType":{
            "$ref":"#/components/schemas/DataType"
        },
        "defaultValue":{
            "type":"object",
            "description":"Complex object: Object"
        },
        "schema":{
            "type":"string"
        },
        "schemaShort":{
            "type":"string"
        },
        "schemaId":{
            "type":"string"
        },
        "connectionId":{
            "type":"string"
        },
        "connectionName":{
            "type":"string"
        },
        "refreshQuery":{
            "type":"string"
        },
        "valuePersistence":{
            "$ref":"#/components/schemas/ValuePersistence"
        }
    }
}

Nested Schema : defaultValue

Type: object

Complex object: Object

401 Response

Unauthorized

404 Response

Not Found

Back to Top