1Save Properties

Overview

This API saves properties for an entity. As this API performs a bulk operation, you must have privileges to import and export objects to use this API.

Method: POST

Request URL: {kyvos-url}/rest/v2/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

Header Name

Type

Description

Possible Values

Content-Type (Required)

String

Specifies the media type of the request body.

application/x-www-form-urlencoded

sessionid

String

The session ID is the token received from the login API.

Note: Session ID is required for token-based authentication.

–

Request Body

Parameter Name	Type	Description	Possible Values

Parameter Name

Type

Description

Possible Values

json (Required)

Object

JSON object containing the details of the entity and its properties.

Note: An example JSON is provided under the Resources section below.

–

Responses

200 Success

{
  "code": 0,
  "message": "Entity properties added successfully."
}

Status Code	Description

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 json parameter in the request body.

{
    "entities":[
        {
            "entityPropsValues":{
                "property":[
                    {
                        "mode":"MANUAL",
                        "name":"kyvos.query.shuffle.mode",
                        "value":"NEVER"
                    },
                    {
                        "mode":"MANUAL",
                        "name":"kyvos.build.aggregate.storage.optimized",
                        "value":"true"
                    }
                ]
            },
            "subType":"CUBE",
            "id":"17754811627004127079024192058298",
            "type":"ANALYTICAL"
        }
    ]
}

Field	Type	Description	Possible Values	Example
entities	Array	A list of entity objects. Each item represents one entity and its associated advanced property information. Multiple entities can be included in the array.	Array with one or more entity objects	[{"id":"...","type":"SMODEL",...}]
entities[].id	String	The unique identifier of the entity.	Valid entity ID string	17754811627004127079024192058298
entities[].type	String	The primary category of the entity.	RDATASET, SMODEL or ANALYTICAL.	SMODEL
entities[].subType	String	The sub-category of the entity. Provides additional classification for the entity type. Leave empty if not applicable.	REGISTERED, or empty string	““
entities[].entityPropsValues	Object	A wrapper object containing the advanced property definitions for the entity.	Object containing a property array	{"property":[{...}]}
entities[].entityPropsValues.property	Array	A list of advanced property objects associated with the entity. Each object represents one property definition.	Array with one or more property objects	[{"name":"spark.kryoserializer.buffer.max","value":"64m","mode":"MANUAL"}]
entities[].entityPropsValues.property[].name	String	The technical name (key) of the advanced property.	Any valid Kyvos advanced property key	kyvos.process.compute.type
entities[].entityPropsValues.property[].value	String	The value associated with the advanced property. The expected format depends on the specific property.	Any valid value accepted by the property	KYVOS_QE_COMPUTE
entities[].entityPropsValues.property[].mode	String	Indicates how the property value is represented.	MANUAL, DEFAULT	MANUAL
entities[].entityPropsValues.property[].recommendedValue	String	The system-recommended value for the property, when available.	Any string or empty	128m
entities[].entityPropsValues.property[].defaultValue	String	The system default value for the property, when available.	Any string or empty	32m
entities[].entityPropsValues.property[].remarks	String	Optional descriptive text associated with the property.	Any text string or empty	Increased for large dataset builds
entities[].entityPropsValues.property[].inheritedValue	Object	Contains details about a value this property may be inheriting from a parent entity or global configuration.	Object containing value and source fields.	{"value":"32m","source":"Global"}
entities[].entityPropsValues.property[].inheritedValue.value	String	The inherited value associated with the property.	Any string or empty	32m
entities[].entityPropsValues.property[].inheritedValue.source	String	The source from which the property value is inherited.	Any string or empty	Global