UHuhh-lt
perspectives

Updates the Cluster's name and description.

Changed on
patch/perspectives/cluster/{cluster_id}/details

Request

  • The document declares no server URL.
  • Auth
    OAuth 2
    Password
    Token URL: /authentication/login

Path parameters

cluster_idinteger required

Request body

namestring nullable

New name of the cluster

descriptionstring nullable

New description of the cluster

Response

Successful Response

idinteger required

ID of the cluster

aspect_idinteger required

ID of the aspect this cluster belongs to

parent_cluster_idinteger nullable required

ID of the parent cluster, if any

is_outlierboolean required

Whether the cluster is an outlier

namestring required

Name of the cluster

descriptionstring required

Description of the cluster

levelinteger required

Hierarchical level of the cluster

xnumber required

X coordinate for visualization

ynumber required

Y coordinate for visualization

top_wordsstring[] nullable required

Top words associated with the cluster

top_word_scoresnumber[] nullable required

Scores of the top words

top_docsinteger[] nullable required

IDs of top documents for the cluster

Changes