1Create Entities

Overview

This API creates entities such as Dataset and Semantic Model based on the payload sent in the request. The response returns details of the created entity.

Method: POST

Request URL: {kyvos-url}/rest/v2/entities

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 media type of 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
datasetListJson (Required)	String	JSON array string containing the list of Datasets to be used for creating the entity. Note: An example JSON is provided under the Resources section below.	–
analysisName	String	Name for the analysis/entity being created.	–
semanticModelViewType	String	View type for the Semantic Model being created.	`SMART_VIEW`
requestSource	String	Source of the request. Used to enclose the dataset metadata.	–

Responses

200 Success

{
    "iroGroups": [
        {
            "REGISTERED": {
                "name": "account",
                "id": "9207145E-4EF2-6B96-9278-54C8CFBBE418",
                "folderName": "Account",
                "folderId": "folder_C550D0FB-75A5-1FE8-13CE-CF8CD3BFD6BB"
            },
            "CUBE": {
                "name": "account",
                "id": "6798F03B-D60D-F06B-E66B-38F8CBD3E33F",
                "folderName": "Account",
                "folderId": "folder_17785045685078127055059198638228",
                "status": ""
            }
        }
    ]
}

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

[
  {
    "connection": "SnowflakeConnection",
    "type": "TABLE",
    "tableDetails": {
      "database": "automationtables",
      "schema": "",
      "table": "account",
      "columnDetails": {
        "DATE_DIM": {
          "DATE_COL": {
            "caption": "DATE_COLupdate",
            "type": "NUMBER",
            "subType": "float",
            "fieldFormat": "0.00"
          }
        }
      }
    }
  }
]

JSON Field Definitions

Field	Type	Description	Possible Values	Example

Field	Type	Description	Possible Values	Example
`connection`	String	Name of the database connection to use for this dataset	Any valid connection name configured in the system	`"SnowflakeConnection"`
`type`	String	Type of the dataset source	`"TABLE"`, `"SQL"`	`"TABLE"`
`tableDetails`	Object	Details of the table when `type` is `"TABLE"`	—	`{ "database": "...", "schema": "...", "table": "...", "columnDetails": {...} }`
`tableDetails.database`	String	Name of the database where the table resides	Any valid database name	`"automationtables"`
`tableDetails.schema`	String	Name of the schema where the table resides	Any valid schema name, or empty string	`""`
`tableDetails.table`	String	Table name	Any valid table name	`"account"`
`tableDetails.columnDetails`	Object	Map of dimension/field names to their column definitions. Keys are dimension names, values are objects mapping column names to column properties	—	`{ "DATE_DIM": { "DATE_COL": {...} } }`
`tableDetails.columnDetails.<dim>.<col>.caption`	String	Display caption for the column	Any string	`"DATE_COLupdate"`
`tableDetails.columnDetails.<dim>.<col>.type`	String	Data type of the column	`"NUMBER"`, `"CHAR"`, `"DATE"`	`"NUMBER"`
`tableDetails.columnDetails.<dim>.<col>.subType`	String	Sub-type of the column data	`"float"`, `"double"`, `"decimal"`, `"long"`, `"char"`, `"date"`.	`"float"`
`tableDetails.columnDetails.<dim>.<col>.fieldFormat`	String	Format pattern for displaying the column values	Any valid format pattern string	`"0.00"`