1Update Semantic Model Properties
Overview
This API updates one or more properties of a Semantic Model, such as DESCRIPTION, TAGS, and other supported properties.
Method: PUT
Request URL: {kyvos_url}/rest/v2/semantic-models/{name-or-id}/entity-properties
Authorization
API Key: sessionid
This method authenticates requests using a session ID which acts like an API key.
BasicAuth: HTTP Authorization Scheme
This method authenticates requests using a username and password sent in the HTTP Authorization header.
Headers
Header Name | Type | Description | Possible Values |
|---|---|---|---|
Content-Type (Required) | String | Specifies the media type of the request body. |
|
sessionid | String | The session ID received from the Login API. Note: Required for token-based authentication. | – |
Path Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
name-or-id (Required) | String | Name or ID of the Semantic Model whose properties need to be updated. Note: If the Semantic Model name is provided, folderName must also be provided. | – |
Query Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
by | String | Specifies whether the name-or-id parameter should be interpreted as a Semantic Model name or Semantic Model ID. If by=name, provide the Semantic Model name in the name-or-id parameter. If by=id, provide the Semantic Model ID in the name-or-id parameter. The default value is name. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
folderName | String | Name of the folder containing the Semantic Model. If the Semantic Model is present in the root directory, specify [Root]. Note: If folderName is not provided, the Semantic Model will be treated as root-level entity by default. | – |
propertyJson (Required) | String | JSON string containing an array of property names and their corresponding values. Note: An example JSON is provided under the Resources section below. | – |
Responses
200 Success
{
"code": 0,
"message": "Properties of the semantic model updated successfully."
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
412 | Precondition failed. Parameter missing. |
500 | Internal Server Error |
Resources
Below is an example of JSON structure which can be used as a reference for the propertyJson parameter in the request body.
[
{
"name":"DESCRIPTION",
"value":"description"
},
{
"name":"TAGS",
"value":"tag"
},
{
"name":"ENTITY_STATE",
"value":"SUSPEND"
}
]Description for propertyJson parameter
Name: The name of the property to set for the semantic model, such as DESCRIPTION or TAGS or ENTITY_STATE.
Value: The value assigned to the specified property.
For DESCRIPTION, provide a brief summary of the semantic model.
For TAGS, provide one or more tags used to categorize and organize the semantic model.
For ENTITY_STATE, either provide ACTIVE(semantic model is fully online, available, and ready for querying, browsing, and reporting) or SUSPEND(semantic model whose usage has been temporarily halted or deactivated for quering).