Folders Array

The folders array defines the organizational structure for the data model objects, allowing objects such as attributes, fact metrics, and other folders to be grouped together for improved management and navigation.

Field	Type	Description	Example
`name`	String	The name of the folder.	`"New Folder"`
`subType`	String	The type of object (often "folder").	`"folder"`
`primaryLocale`	String	The primary locale for the folder strings.	`"en-US"`
`contents`	Array	List of objects or sub-folders contained in the folder. Each item includes objectId, subType, and name.	`[ { name: "Total Dollar Sales" } ]`
`acl`	Object	Access Control List that defines the permissions for the folder. For more information, see Access Control List.	`{ "...": { granted: 255 } }`
`translations`	Object	Localized name for the folder. For more information, see Translations.	`{ name: { translationValues: {...} } }`

Example

See the following folders file example:

Copy

folders:
  - subType: "folder"
    name: "New Folder"
    primaryLocale: "en-US"
    translations:
      name:
        targetName: "Object Name"
        translationValues:
          1033:
            translation: "New Folder"
    acl:
      "294DEDC011D2F1D56000D98E67019608":
        granted: 255
        denied: 0
        inheritable: false
      "37DECDD94EAA4A2AF3C7A6B17080DADF":
        granted: 255
        denied: 0
        inheritable: false
      C82C6B1011D2894CC0009D9F29718E4F:
        granted: 255
        denied: 0
        inheritable: false
    contents:
    - objectId: "D27A8CFBAC194ABB825568F209603CF3"
      subType: "fact_metric"
      name: "Total Dollar Sales"
    - subType: "folder"
      name: "New Folder 2"
      primaryLocale: "en-US"
      translations:
        name:
          targetName: "Object Name"
          translationValues:
            1033:
              translation: "New Folder 2"
      acl:
        "294DEDC011D2F1D56000D98E67019608":
          granted: 255
          denied: 0
          inheritable: false
        "37DECDD94EAA4A2AF3C7A6B17080DADF":
          granted: 255
          denied: 0
          inheritable: false
        C82C6B1011D2894CC0009D9F29718E4F:
          granted: 255
          denied: 0
          inheritable: false
      contents:
      - objectId: "E8A0BE67E3314CCA979953C325969FBD"
        subType: "fact_metric"
        name: "Total Unit Sales"
    - objectId: "417412E2615B4828961EDC2C6CF0BAC1"
      subType: "attribute"
      name: "Call Center"