Update a hierarchy metadata.

PUT /users/site/hierarchyMetadata/{hierarchyId}

Operation id: SiteService_UpdateHierarchyMetadata

Description

Permission Level: Read-Write

Tags: SiteService

Parameters

Path parameters

Security

• Authorization (apiKey)
  • Bearer token

Responses

200 — A successful response.

Content type: application/json

default — An unexpected error response.

Content type: application/json

Request body

Required: Yes

application/json

Schema

{
  "type": "object",
  "properties": {
    "tenantId": {
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "updateHierarchyMetadataActiveToggle": {
      "type": "object",
      "properties": {
        "active": {
          "type": "boolean"
        }
      }
    },
    "updateLevels": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "levelName": {
            "type": "string"
          },
          "displayName": {
            "type": "string"
          },
          "order": {
            "type": "integer",
            "format": "int32"
          }
        }
      }
    },
    "updateFieldMask": {
      "type": "string"
    }
  }
}

Response models

200 — A successful response.

Content type: application/json

Schema

{
  "type": "object",
  "properties": {
    "hierarchyMetadata": {
      "type": "object",
      "properties": {
        "tenantId": {
          "type": "string",
          "description": "TenantId of the hierarchy."
        },
        "hierarchyId": {
          "type": "string",
          "description": "HierarchyId of the hierarchy."
        },
        "displayName": {
          "type": "string",
          "description": "Display name of the hierarchy."
        },
        "description": {
          "type": "string",
          "description": "Description of the hierarchy."
        },
        "active": {
          "type": "boolean",
          "description": "Active status of hierarchy."
        },
        "levels": {
          "type": "array",
          "description": "Levels of hierarchy.",
          "items": {
            "type": "object",
            "properties": {
              "levelName": {
                "type": "string"
              },
              "displayName": {
                "type": "string"
              },
              "order": {
                "type": "integer",
                "format": "int32"
              },
              "creationTime": {
                "type": "string",
                "format": "date-time"
              },
              "lastUpdated": {
                "type": "string",
                "format": "date-time"
              }
            }
          }
        },
        "creationTime": {
          "type": "string",
          "format": "date-time"
        },
        "lastUpdated": {
          "type": "string",
          "format": "date-time"
        }
      }
    }
  }
}

default — An unexpected error response.

Content type: application/json

Schema

{
  "type": "object",
  "properties": {
    "code": {
      "type": "integer",
      "format": "int32"
    },
    "message": {
      "type": "string"
    },
    "details": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "@type": {
            "type": "string"
          }
        }
      }
    }
  }
}