Skip to main content

UpdateHierarchyLabelsDto

siteLabelstring
siteLabelPluralstring
zoneLabelstring
zoneLabelPluralstring
levelLabelstring
levelLabelPluralstring
tunnelLabelstring
tunnelLabelPluralstring
teamLabelstring
teamLabelPluralstring
disabledLevelsstring[]

Possible values: [tunnel, team]

customFieldsobject

Map of hierarchy node type to its custom field definitions.

Example: {"site":[{"key":"permitRef","label":"Permit Reference","type":"text","required":false}]}
customMetrics object
metrics object[]
  • Array [
  • keystring
    labelstring
    nodeTypestring

    Possible values: [site, level, zone, tunnel, team]

    fieldKeystring
    aggregationstring

    Possible values: [count, sum, avg, min, max]

    rolesstring[]
  • ]
  • UpdateHierarchyLabelsDto
    {
    "siteLabel": "string",
    "siteLabelPlural": "string",
    "zoneLabel": "string",
    "zoneLabelPlural": "string",
    "levelLabel": "string",
    "levelLabelPlural": "string",
    "tunnelLabel": "string",
    "tunnelLabelPlural": "string",
    "teamLabel": "string",
    "teamLabelPlural": "string",
    "disabledLevels": [
    "tunnel"
    ],
    "customFields": {
    "site": [
    {
    "key": "permitRef",
    "label": "Permit Reference",
    "type": "text",
    "required": false
    }
    ]
    },
    "customMetrics": {
    "metrics": [
    {
    "key": "string",
    "label": "string",
    "nodeType": "site",
    "fieldKey": "string",
    "aggregation": "count",
    "roles": [
    "string"
    ]
    }
    ]
    }
    }