Search Variables

put

https://api.cloud.digifi.io/variables/search

The Search Variables API can be used to get information about your variables.

Body Params

Request Body

count

number

1 to 100

Defaults to 20

Number of entities to return. Used for pagination implementation. If no value is provided used default 20. Max 100.

offset

number

≥ 0

Number entities to skip. Useful for pagination implementation. Only works if count param is passed

sortField

string

enum

Field to sort by

Allowed:

sortDirection

string

enum

Direction of sort results. asc or desc

Allowed:

string

Search query to perform

onlyStandard

boolean

Return only standard variables.

onlyCustom

boolean

Return only custom variables.

string

Find variable by ID.

ids

array of strings

Find variables by IDs.

ids

systemName

string

Find variables by system name.

systemNames

array of strings

Find variables by system names.

systemNames

stringFormat

string

enum

deprecated

Filter variables by string format.

Allowed:

numberFormat

string

enum

deprecated

Filter variables by number format

Allowed:

dataType

enum

Filter variables by data type.

excludeDataTypes

array of strings

Exclude variables by data type.

excludeDataTypes

visualDataType

enum

Filter variables by visual data type.

dueCreatedDateFrom

Created date from which to filter variables.

dueCreatedDateTo

Created date to which to filter variables.

dueUpdatedDateFrom

Updated date from which to filter variables.

dueUpdatedDateTo

Updated date to which to filter variables.

teamMembersIds

array of strings

Filter variables updated by team members.

teamMembersIds

includeArchived

boolean

Flag to exclude archived variables.

excludeDependent

boolean

Flag to exclude variables that depend on other variables.

Headers

api-version

string

enum

Defaults to 2024-02-26

Allowed:

Responses

200Success

400Bad Request

401Unauthorized

404Not Found

500Internal Server Error