Jump to

• Request
• Response

View list of Dimensions.

get

/gsadmin/v1/{appName}/dimvals

Displays a list of all dimensions are represented by dimension values for the root of each dimension.

Request

Supported Media Types

• application/json

Path Parameters

• appName(required): string
  Specifies the name of your application. For example, "cloud".

Query Parameters

• locale: string
  locale parameter to overwrite X-CCAsset-Language or application default

Header Parameters

• X-CCAsset-Language: string
  Asset Locale value sent by all cloud requests. example: 'en'

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json

200 Response

A list of Dimensions.

Body ()

Root Schema : DimValList

Type: object

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DimVal"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: DimVal
  Expanded dimval array corresponding to dimvalid or dimvalIds array

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DimVal"
    }
}

Nested Schema : DimVal

Expanded dimval array corresponding to dimvalid or dimvalIds array

Match All

Expanded dimval array corresponding to dimvalid or dimvalIds array

Expanded dimval array corresponding to dimvalid or dimvalIds array

Show Source

• object BaseDimVal
• object DimVal-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/definitions/BaseDimVal"
        },
        {
            "properties":{
                "dimensionName":{
                    "type":"string",
                    "example":"product.category"
                },
                "dimensionId":{
                    "type":"string",
                    "example":"12345"
                }
            }
        }
    ],
    "description":"Expanded dimval array corresponding to dimvalid or dimvalIds array"
}

Nested Schema : BaseDimVal

Type: object

Show Source

• displayName: string
  Example: US Catalog
• dvalID: string
  Example: 235122

{
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string",
            "example":"US Catalog"
        },
        "dvalID":{
            "type":"string",
            "example":"235122"
        }
    }
}

Nested Schema : DimVal-allOf[1]

Type: object

Show Source

• dimensionId: string
  Example: 12345
• dimensionName: string
  Example: product.category

{
    "properties":{
        "dimensionName":{
            "type":"string",
            "example":"product.category"
        },
        "dimensionId":{
            "type":"string",
            "example":"12345"
        }
    }
}

Back to Top