List project parameters

Get a paginated list of project parameters with search and sorting capabilities.

GET /api/v2/projects/{projectUuid}/parameters/list

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "data": [
      {
        "source": "config",
        "config": {
          "label": "<string>",
          "options_from_dimension": {
            "dimension": "<string>",
            "model": "<string>"
          },
          "options": [
            "<string>"
          ],
          "allow_custom_values": true,
          "multiple": true,
          "default": "<string>",
          "type": "string",
          "description": "<string>"
        },
        "name": "<string>",
        "modelName": "<string>"
      }
    ],
    "pagination": {
      "page": 123,
      "pageSize": 123,
      "totalResults": 123,
      "totalPageCount": 123
    }
  },
  "status": "ok"
}

Path Parameters

projectUuid · string · required

Query Parameters

search · string

sortBy · enum<string>

Available options: name

sortOrder · enum<string>

Available options: asc, desc

page · number<double>

pageSize · number<double>

Response

200

application/json

Success

results · object · required

Show child attributes

results. data · object[] · required

Show child attributes

results.data. source · enum<string> · required

Available options: config, model

results.data. config · object · required

Show child attributes

results.data.config. label · string · required

results.data.config. options_from_dimension · object

Show child attributes

results.data.config.options_from_dimension. dimension · string · required

results.data.config.options_from_dimension. model · string · required

results.data.config. options

results.data.config. allow_custom_values · boolean

results.data.config. multiple · boolean

results.data.config. default

results.data.config. type · enum<string>

Available options: string, number, date

results.data.config. description · string

results.data. name · string · required

results.data. modelName · string

results. pagination · object

Show child attributes

results.pagination. page · number<double> · required

results.pagination. pageSize · number<double> · required

results.pagination. totalResults · number<double> · required

results.pagination. totalPageCount · number<double> · required

status · enum<string> · required

Available options: ok