Jump to

• Request
• Response

List Variables

get

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

Retrieves a list of variables for a specific project. This method supports various query parameters to filter and customize the response:

• fields: specifies the fields to include in the response (comma-separated)
• qualifiedName: filters variables by qualified name (projectName.variableName)

The following examples demonstrate the supported query patterns:

• Retrieve all variables for a project:

  Retrieves all variables for the project with the given projectId. All default fields for these variables will be included in the response.

  /projects/{projectId}/variables


• Retrieve all variables for a project with specific fields:

  Retrieves all variables for the project with the given projectId, and the response will only include the fields specified in the fields parameter.

  /projects/{projectId}/variables?fields=name,variableId,...


• Retrieve variable for a project by qualified name:

  Retrieves variable for the project with the given projectId that match the specified qualifiedName. All default fields for these schedules will be included in the response.

  /projects/{projectId}/variables?qualifiedName=projectName.variableName


• Retrieve variable for a project by qualified name with specific fields:

  Retrieves variable for the project with the given projectId that match the specified qualifiedName, and the response will only include the fields specified in the fields parameter.

  /projects/{projectId}/variables?qualifiedName=projectName.variableName&fields=name,variableId,...

Request

Path Parameters

• projectId(required): string
  ID of the project for which to retrieve variables

Query Parameters

• fields: string
  comma-separated list of fields to include in the response
• qualifiedName: string
  ??? filters variables by projectName.variableName

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

a response object containing the list of variables

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object DTVariableBaseDTO
  Represents a data transforms variable with only basic information.

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DTVariableBaseDTO"
    }
}

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"
        }
    }
}

401 Response

Unauthorized

404 Response

Not Found

Back to Top