Kyvos

Download OpenAPI specification:Download

Kyvos Rest API Documentation

Find out more about Kyvosmailto:support@kyvos.io

Login

Kyvos supports two modes of authentication for using REST APIs.

Basic Authentication:
This mode requires passing the user credentials in authorization header with each REST API call, without the need of this Login API.

Token-based Authentication:
This authentication mode allows you to exchange a token from Kyvos against a valid user credentials using this login API. API returns a session ID as token, which will be used to access other REST APIs by passing in session ID in request header.

API Description:
This API authenticate a user using user credentials. On successful authentication, this REST call returns a session id that can be further used to request any other REST call.

This API also supports HTTP header-based authentication (when Kyvos is configured in external authentication mode type HOST APP). Kyvos will get the user detail from the HTTP Request as per the configuration done for the HOST APP type authentication and will provide a token (sessionid) as per user details. User credentials are not required in this case. For more details refer SSO with HOST APP section in user manual.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: application/x-www-form-urlencoded

Request Body schema: application/x-www-form-urlencoded

username required	string The name of the user to be authenticated
password required	string The password of the user to be authenticated
tokenTimeOut	string Default: 30 Number of minutes of inactivity after which the login session will expires. After this, login request needs to be resent for any further request. Default Value: 30 minutes
mode	string This is an optional parameter used for password-less authentication when Kyvos is configured to be used in embedded mode. another parameter "token" is required while doing password-less authentication. Kyvos will verify the username and token by making a reverse REST call to an URL provided with Kyvos integration configuration.
token	string A unique string (GUID) provided to Kyvos instead of a password for password-less authentication.
customData	string This is an optional string parameter to support password-less SSO (when kyvos embedding is enabled). For password-less SSO, if you need additional information (other than token and username) to verify the login attempt, the you can use the customData to send that information to Kyvos. Kyvos will send it back to the host application by making a reverse REST API call to userAuthenticationVerificationUrl provided in the integration configuration (integration.config.json). You can also use dynamic parameters in userAuthenticationVerificationUrl. These parameters will be replaced by the value of top-level keys provided in customData. Example: customData : {“APP_NAME”: “integration”} userAuthenticationVerificationUrl : “http://localhost:8081/kyvos/<%APP_NAME%>/verifyLogin” Hence, the URL will become: “http://localhost:8081/kyvos/integration/verifyLogin” Note: customData should be a valid JSON String.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"SUCCESS": "B830FA41-FECB-F45F-F218-8A4D686F104C"
}
}

Logout

This API is needed to logout from the session created for REST API access. This API is applicable only if logout is done via sessionid token.

Note: API Key and Basic Authentication does not support logout API. Session created for API Key and Basic Authentication should be reset from Authorize panel only.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Example: application/json Supported response types are JSON or XML. Possible values : application/xml or application/json
sessionid required	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Logged out successfully",
"CODE": 0
}

Users

Get Users

This API is used to get a User listing.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"USERS": {"USER": [{"id": 52270519,
"GROUPIDS": "",
"NAME": "RestAPITestUser 1"
},
{"id": "16456137127926127058067178390143",
"GROUPIDS": "",
"NAME": "RestAPITestUser 2"
}
]
}
}
}

Create User

This API is used to create a user.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

userXML

required

object

XML of UserInfo Object. This XML can be generated with the help of com.kyvos.client.common.UserInfo class.

For e.g.

          <USER ID="16618976024730127050029192698796" GROUPIDS="" ROLES="2" USER_AUTH_TYPE="NATIVE">
              <NAME>
              <PASSWORD>
              <EMAIL>
              <DESCRIPTION>
              <USER_CUSTOM_ATTRIBUTES>
          </USER>

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully added user: RestAPIUserdd",
"CODE": 0
}

Get User

This API is used to get a user.

Authorizations:

sessionIdbasicAuth

path Parameters

username

required

string

Name of User

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"USER": {"IS_PASSWORD_ENCRYPTED": true,
"USER_STATUS": 0,
"USER_CUSTOM_ATTRIBUTES": "[]",
"USER_AUTH_TYPE": "NATIVE",
"EMAIL": "",
"GROUPIDS": "",
"NAME": "Admin",
"PASSWORD": "",
"ROLES": 0,
"DESCRIPTION": "Admin User",
"PREFERENCES": "{\"preferences\":{\"navigation\":\"temporary\",\"sortEntityListBy\":\"\",\"scaleInterface\":true,\"landingPage\":{\"workbookName\":\"\",\"itemType\":\"\",\"usecase\":\"\",\"workBookId\":\"\",\"name\":\"\",\"id\":\"\",\"folderName\":\"\",\"type\":\"\",\"catObj\":\"\"},\"theme\":\"softGray\",\"workbookTabPosition\":\"bottom\",\"languageKey\":\"en_US\"},\"homePageConfig\":{\"widgets\":[{\"visible\":true,\"sortOrder\":\"DESC\",\"viewType\":\"LIST\",\"sortBy\":\"ENTITY_NAME\",\"id\":\"home_wgt_recent\"},{\"visible\":true,\"visitedStepsId\":[],\"id\":\"home_wgt_documentation\"}]}}",
"PAT_EXIST": false,
"ID": "Admin",
"USER_CREATION_MODE": 1
}
}
}

Update User

This API is used to update an existing user.

Authorizations:

sessionIdbasicAuth

path Parameters

username

required

string

Name of User

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

userXML

required

object

XML of UserInfo Object. This XML can be generated with the help of com.kyvos.client.common.UserInfo class.

For e.g.

          <USER ID="16618976024730127050029192698796" GROUPIDS="" ROLES="2" USER_AUTH_TYPE="NATIVE">
              <NAME>
              <PASSWORD>
              <EMAIL>
              <DESCRIPTION>
              <USER_CUSTOM_ATTRIBUTES>
          </USER>

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully updated user: RestApiTest",
"CODE": 0
}

Delete User

This API is used to delete an existing user.

Authorizations:

sessionIdbasicAuth

path Parameters

username

required

string

Name of User

header Parameters

Accept required	string Example: application/JSON Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully deleted user: RestAPIUser",
"CODE": 0
}

Update User Role

This API is used to assign the role of a user.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

userName	string User name of target user whose role is to be updated.
role	string Values of the new role which is to be assigned to user.

Responses

Response samples

200

Content type

applicationapplication/json

{"MESSAGE": "Successfully updated user: RestApiTest",
"CODE": 0
}

Update User Preferences

This API is used to set the User Preferences.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

userName required	string Username to update the user preferences.
required	object (preferences) JSON string of the user preferences.
groupName required	string Group name to update all users preferences belonging to that group.
updateType	string Default value is COMPLETE. It is applicable only in case of update user preferences by group name.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully updated user preferences: RestAPIUser",
"CODE": 0
}

Groups

Get Groups

This API is used to get the list of groups.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"GROUPS": {"GROUP": [{"id": 226622736,
"NAME": "Adadmin"
},
{"id": 41113804,
"NAME": "ADSyncAdmins"
}
]
}
}
}

Create Group

This API is used to create a new Group.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

groupXML

required

object

XML representation of the Group Object.Please refer inline example as a sample. This XML can also be generated using one of the utlity class in kyvosclient.jar (com.kyvos.client.common.UserGroup class).

For e.g.

  <GROUP GROUP_TYPE="Native or LDAP" ID="unique id"
  USERIDS="commo separated list of user Ids of users of this group">

      <NAME>

          <![CDATA[groupName]]>

      </NAME>

      <USER_NAMES></USER_NAMES>

      <DESCRIPTION>

          <![CDATA[description]]>

      </DESCRIPTION>

  </GROUP>

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully added group: RestApiTest",
"CODE": 0
}

Get Group

This API is used to get a Group by its name.

Authorizations:

sessionIdbasicAuth

path Parameters

groupName

required

string

Name of the Group

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"GROUP": {"GROUP_TYPE": "LDAP",
"ROLES": "",
"DESCRIPTION": "",
"ID": 226622736,
"USERIDS": 226623262,
"USER_NAMES": "RestApiTest",
"NAME": "Adadmin"
}
}

Update Group

This API is used to update an existing Group.

Authorizations:

sessionIdbasicAuth

path Parameters

groupName

required

string

Name of the Group

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

groupXML

required

object

XML representation of the Group Object.Please refer inline example as a sample. This XML can also be generated using one of the utlity class in kyvosclient.jar (com.kyvos.client.common.UserGroup class).

For e.g.

  <GROUP GROUP_TYPE="Native or LDAP" ID="unique id"
  USERIDS="commo separated list of user Ids of users of this group">

      <NAME>

          <![CDATA[groupName]]>

      </NAME>

      <USER_NAMES></USER_NAMES>

      <DESCRIPTION>

          <![CDATA[description]]>

      </DESCRIPTION>

  </GROUP>

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Group updated successfully.",
"CODE": 0
}

Delete Group

This API is used to delete an existing Group.

Authorizations:

sessionIdbasicAuth

path Parameters

groupName

required

string

Name of the Group

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully deleted group",
"CODE": 0
}

Update Role for Group

This API is to assign role or update role of the group.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

groupName	string Group name of target group whose role is to be updated
role	string Name of the role which is to be assigned to group.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Group role updated successfully.",
"CODE": 0
}

Roles

Get Roles

This API is used to get role listing.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"ROLES": {"ROLE": [{"id": 0,
"NAME": "Administrator"
},
{"id": "16248578220306127097078198985166",
"NAME": "All_Privileges"
}
]
}
}
}

Create Role

This API is used to create a new role.
Note: User Role can be created by providing either roleName and privileges or only roleXML

Authorizations:

sessionIdbasicAuth

query Parameters

roleName

required

string

Name of the role

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

privileges

required

object

Privileges JSON

For e.g.

    {
      "setup": {
        "view": false,
        "connections": {
          "view": true,
          "crud": true,
          "share": true
        },
        "importCab": true,
        "exportCab": true,
        "exportCubeMetadata": false,
        "userMgmt": {
          "view": true,
          "crud": false
        },
        "licenseMgmt": {
          "view": false,
          "crud": false
        },
        "clusterScaling": {
          "view": false,
          "crud": false,
          "viewSystemUsage": false
        },
        "resourceAllocation": {
          "view": false,
          "crud": false
        }
      },
      "monitor": {
        "view": false,
        "viewOverview": false,
        "viewJobs": {
          "view": false,
          "showJobs": 0,
          "cancelJobs": false
        },
        "viewUsers": false,
        "viewKyvosEngines": false,
        "viewAuditLogs": false
      },
      "files": {
        "view": true,
        "crud": true,
        "addJob": 1,
        "addFolder": true,
        "use": true,
        "share": true
      },
      "datasets": {
        "view": true,
        "crud": true,
        "addFolder": true,
        "addJob": 1,
        "use": true,
        "share": true
      },
      "relationships": {
        "view": true,
        "crud": true,
        "addFolder": true,
        "use": true,
        "share": true
      },
      "cubes": {
        "view": true,
        "crud": true,
        "addFolder": true,
        "use": true,
        "addJob": 1,
        "setupDataSecurity": true,
        "setupCacheRules": false,
        "share": true,
        "drillThrough": false,
        "exportCubeMetadata": false,
        "advancedSystemProperties": false
      },
      "workbooks": {
        "view": true,
        "crud": true,
        "addFolder": true,
        "export": true,
        "share": true
      },
      "notification": {
        "cubeBuildFailure": true,
        "cubeBuildSuccess": true,
        "cubeBuildStart": true,
        "datasetBuildStart": true,
        "datasetBuildFailure": true,
        "datasetBuildSuccess": true,
        "notificationAdmin": false,
        "systemEvents": false,
        "entityModified": true
      },
      "thirdPartyBITools": {
        "sqlUserImpersonation": false
      }
    }

roleXML

object

XML of a User Role Object. This xml can be generated with the help of com.kyvos.commons.entity.UserRole

For e.g.

    <ROLE ID="ECFFB604-740E-DA96-8AA4-5F1DE1ACFF2C" CREATION_TIME="1664135578167" USER_COUNT="0" GROUP_COUNT="0">

        <NAME>

            <![CDATA[role_100]]>

        </NAME>

        <DESC>

            <![CDATA[null]]>

        </DESC>

        <PRIVILEGES>

            <![CDATA[{

                            "setup": {

                              "view": false,

                              "connections": {

                                "view": true,

                                "crud": true,

                                "share": true

                              },

                              "importCab": true,

                              "exportCab": true,

                              "exportCubeMetadata": false,

                              "userMgmt": {

                                "view": true,

                                "crud": false

                              },

                              "licenseMgmt": {

                                "view": false,

                                "crud": false

                              },

                              "clusterScaling": {

                                "view": false,

                                "crud": false,

                                "viewSystemUsage": false

                              },

                              "resourceAllocation": {

                                "view": false,

                                "crud": false

                              }

                            },

                            "monitor": {

                              "view": false,

                              "viewOverview": false,

                              "viewJobs": {

                                "view": false,

                                "showJobs": 0,

                                "cancelJobs": false

                              },

                              "viewUsers": false,

                              "viewKyvosEngines": false,

                              "viewAuditLogs": false

                            },

                            "files": {

                              "view": true,

                              "crud": true,

                              "addJob": 1,

                              "addFolder": true,

                              "use": true,

                              "share": true

                            },

                            "datasets": {

                              "view": true,

                              "crud": true,

                              "addFolder": true,

                              "addJob": 1,

                              "use": true,

                              "share": true

                            },

                            "relationships": {

                              "view": true,

                              "crud": true,

                              "addFolder": true,

                              "use": true,

                              "share": true

                            },

                            "cubes": {

                              "view": true,

                              "crud": true,

                              "addFolder": true,

                              "use": true,

                              "addJob": 1,

                              "setupDataSecurity": true,

                              "setupCacheRules": false,

                              "share": true,

                              "drillThrough": false,

                              "exportCubeMetadata": false,

                              "advancedSystemProperties": false

                            },

                            "workbooks": {

                              "view": true,

                              "crud": true,

                              "addFolder": true,

                              "export": true,

                              "share": true

                            },

                            "notification": {

                              "cubeBuildFailure": true,

                              "cubeBuildSuccess": true,

                              "cubeBuildStart": true,

                              "datasetBuildStart": true,

                              "datasetBuildFailure": true,

                              "datasetBuildSuccess": true,

                              "notificationAdmin": false,

                              "systemEvents": false,

                              "entityModified": true

                            },

                            "thirdPartyBITools": {

                              "sqlUserImpersonation": false

                            }

                          }]]>

        </PRIVILEGES>

    </ROLE>

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully added role: RestApiTest",
"CODE": 0
}

Get Role

This API is used to get role name.

Authorizations:

sessionIdbasicAuth

path Parameters

roleName

required

string

Name of Role

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"ROLE": {"CREATION_TIME": 1656676341637,
"GROUP_COUNT": 1,
"ID": 1,
"DESC": "null",
"USER_COUNT": 15,
"NAME": "Designer",
"PRIVILEGES": "{\"setup\":{\"view\":false,\"connections\":{\"view\":true,\"crud\":true,\"share\":true},\"importCab\":true,\"exportCab\":true,\"exportCubeMetadata\":false,\"userMgmt\":{\"view\":true,\"crud\":false},\"licenseMgmt\":{\"view\":false,\"crud\":false},\"clusterScaling\":{\"view\":false,\"crud\":false,\"viewSystemUsage\":false},\"resourceAllocation\":{\"view\":false,\"crud\":false}},\"monitor\":{\"view\":false,\"viewOverview\":false,\"viewJobs\":{\"view\":false,\"showJobs\":0,\"cancelJobs\":false},\"viewUsers\":false,\"viewKyvosEngines\":false,\"viewAuditLogs\":false},\"files\":{\"view\":true,\"crud\":true,\"addJob\":1,\"addFolder\":true,\"use\":true,\"share\":true},\"datasets\":{\"view\":true,\"crud\":true,\"addFolder\":true,\"addJob\":1,\"use\":true,\"share\":true},\"relationships\":{\"view\":true,\"crud\":true,\"addFolder\":true,\"use\":true,\"share\":true},\"cubes\":{\"view\":true,\"crud\":true,\"addFolder\":true,\"use\":true,\"addJob\":1,\"setupDataSecurity\":true,\"setupCacheRules\":false,\"share\":true,\"drillThrough\":false,\"exportCubeMetadata\":false,\"advancedSystemProperties\":false},\"workbooks\":{\"view\":true,\"crud\":true,\"addFolder\":true,\"export\":true,\"share\":true},\"notification\":{\"cubeBuildFailure\":true,\"cubeBuildSuccess\":true,\"cubeBuildStart\":true,\"datasetBuildStart\":true,\"datasetBuildFailure\":true,\"datasetBuildSuccess\":true,\"notificationAdmin\":false,\"systemEvents\":false,\"entityModified\":true},\"thirdPartyBITools\":{\"sqlUserImpersonation\":false}}"
}
}
}

Update Role

This API is used to update an existing role.
Note: User Role can be updated by providing either privileges or roleXML.

Authorizations:

sessionIdbasicAuth

path Parameters

roleName

required

string

Name of the role

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

privileges

object

Privileges JSON

For e.g.

    {
      "setup": {
        "view": false,
        "connections": {
          "view": true,
          "crud": true,
          "share": true
        },
        "importCab": true,
        "exportCab": true,
        "exportCubeMetadata": false,
        "userMgmt": {
          "view": true,
          "crud": false
        },
        "licenseMgmt": {
          "view": false,
          "crud": false
        },
        "clusterScaling": {
          "view": false,
          "crud": false,
          "viewSystemUsage": false
        },
        "resourceAllocation": {
          "view": false,
          "crud": false
        }
      },
      "monitor": {
        "view": false,
        "viewOverview": false,
        "viewJobs": {
          "view": false,
          "showJobs": 0,
          "cancelJobs": false
        },
        "viewUsers": false,
        "viewKyvosEngines": false,
        "viewAuditLogs": false
      },
      "files": {
        "view": true,
        "crud": true,
        "addJob": 1,
        "addFolder": true,
        "use": true,
        "share": true
      },
      "datasets": {
        "view": true,
        "crud": true,
        "addFolder": true,
        "addJob": 1,
        "use": true,
        "share": true
      },
      "relationships": {
        "view": true,
        "crud": true,
        "addFolder": true,
        "use": true,
        "share": true
      },
      "cubes": {
        "view": true,
        "crud": true,
        "addFolder": true,
        "use": true,
        "addJob": 1,
        "setupDataSecurity": true,
        "setupCacheRules": false,
        "share": true,
        "drillThrough": false,
        "exportCubeMetadata": false,
        "advancedSystemProperties": false
      },
      "workbooks": {
        "view": true,
        "crud": true,
        "addFolder": true,
        "export": true,
        "share": true
      },
      "notification": {
        "cubeBuildFailure": true,
        "cubeBuildSuccess": true,
        "cubeBuildStart": true,
        "datasetBuildStart": true,
        "datasetBuildFailure": true,
        "datasetBuildSuccess": true,
        "notificationAdmin": false,
        "systemEvents": false,
        "entityModified": true
      },
      "thirdPartyBITools": {
        "sqlUserImpersonation": false
      }
    }

roleXML

object

XML of a User Role Object. This xml can be generated with the help of com.kyvos.commons.entity.UserRole

For e.g.

    <ROLE ID="ECFFB604-740E-DA96-8AA4-5F1DE1ACFF2C" CREATION_TIME="1664135578167" USER_COUNT="0" GROUP_COUNT="0">

        <NAME>

            <![CDATA[role_100]]>

        </NAME>

        <DESC>

            <![CDATA[null]]>

        </DESC>

        <PRIVILEGES>

            <![CDATA[{

                            "setup": {

                              "view": false,

                              "connections": {

                                "view": true,

                                "crud": true,

                                "share": true

                              },

                              "importCab": true,

                              "exportCab": true,

                              "exportCubeMetadata": false,

                              "userMgmt": {

                                "view": true,

                                "crud": false

                              },

                              "licenseMgmt": {

                                "view": false,

                                "crud": false

                              },

                              "clusterScaling": {

                                "view": false,

                                "crud": false,

                                "viewSystemUsage": false

                              },

                              "resourceAllocation": {

                                "view": false,

                                "crud": false

                              }

                            },

                            "monitor": {

                              "view": false,

                              "viewOverview": false,

                              "viewJobs": {

                                "view": false,

                                "showJobs": 0,

                                "cancelJobs": false

                              },

                              "viewUsers": false,

                              "viewKyvosEngines": false,

                              "viewAuditLogs": false

                            },

                            "files": {

                              "view": true,

                              "crud": true,

                              "addJob": 1,

                              "addFolder": true,

                              "use": true,

                              "share": true

                            },

                            "datasets": {

                              "view": true,

                              "crud": true,

                              "addFolder": true,

                              "addJob": 1,

                              "use": true,

                              "share": true

                            },

                            "relationships": {

                              "view": true,

                              "crud": true,

                              "addFolder": true,

                              "use": true,

                              "share": true

                            },

                            "cubes": {

                              "view": true,

                              "crud": true,

                              "addFolder": true,

                              "use": true,

                              "addJob": 1,

                              "setupDataSecurity": true,

                              "setupCacheRules": false,

                              "share": true,

                              "drillThrough": false,

                              "exportCubeMetadata": false,

                              "advancedSystemProperties": false

                            },

                            "workbooks": {

                              "view": true,

                              "crud": true,

                              "addFolder": true,

                              "export": true,

                              "share": true

                            },

                            "notification": {

                              "cubeBuildFailure": true,

                              "cubeBuildSuccess": true,

                              "cubeBuildStart": true,

                              "datasetBuildStart": true,

                              "datasetBuildFailure": true,

                              "datasetBuildSuccess": true,

                              "notificationAdmin": false,

                              "systemEvents": false,

                              "entityModified": true

                            },

                            "thirdPartyBITools": {

                              "sqlUserImpersonation": false

                            }

                          }]]>

        </PRIVILEGES>

    </ROLE>

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"MESSAGE": "Successfully updated role: RestApiTest",
"CODE": 0
}
}

Delete Role

This API is used to delete an existing Role.

Authorizations:

sessionIdbasicAuth

path Parameters

roleName

required

string

Name of the role

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"MESSAGE": "Successfully deleted role: RestApiTest",
"CODE": 0
}
}

Activity Monitor

Get Health Overview

This API is used to get an overview of activities running on the BI server.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"OVERVIEW": {"QUERY_ENGINES": {"ACTIVE": 6
},
"QUEUES": {"QUEUE": [{"SIZE": 25,
"USED": 0,
"TYPE": "query"
},
{"SIZE": 100,
"USED": 0,
"TYPE": "cubeBuild"
},
{"SIZE": 100,
"USED": 0,
"TYPE": "datasetBuild"
}
]
},
"THREADS": {"THREAD": [{"SIZE": 10,
"USED": 0,
"TYPE": "query"
},
{"SIZE": 5,
"USED": 0,
"TYPE": "cubeBuild"
},
{"SIZE": 5,
"USED": 0,
"TYPE": "datasetBuild"
}
]
},
"QUERY_REQUESTS": {"AVG_COUNT": 0,
"AVG_FREQUENCY": 10,
"AVG_TIME": 0,
"AVG_FREQUENCY_UNIT": "MINUTE"
},
"USERS": {"SIGNED_IN": 1
},
"OLAP_ENGINES": {"ACTIVE": 2
}
}
}

Get Scheduled Jobs

This API is used to get information about scheduled jobs on the BI server.

Authorizations:

sessionIdbasicAuth

query Parameters

numberOfDays	string Number of days filter to get scheduled jobs.
maxRows	string Number of records to be fetched.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"JOBS": {"JOB": [{"BUILD_FREQUENCY": "Daily ",
"LOCATION": "50 GB Default",
"ENTITY_ID": "16340410015376127093028114591452",
"SCHEDULED_TIME": "08/28/2022 18:40:00",
"ACTION": "Incremental Cube Build",
"SCHEDULED_TIMESTAMP": 1661692200000,
"USER": "vishal.mittal",
"ENTITY_TYPE": "ANALYTICAL",
"ENTITY_SUB_TYPE": "CUBE",
"ENTITY_NAME": "Product-Sales_Detail_50GB"
},
{"BUILD_FREQUENCY": "Daily ",
"LOCATION": "50 GB Default",
"ENTITY_ID": "16340410015376127093028114591452",
"SCHEDULED_TIME": "08/29/2022 18:40:00",
"ACTION": "Incremental Cube Build",
"SCHEDULED_TIMESTAMP": 1661778600000,
"USER": "vishal.mittal",
"ENTITY_TYPE": "ANALYTICAL",
"ENTITY_SUB_TYPE": "CUBE",
"ENTITY_NAME": "Product-Sales_Detail_50GB"
},
{"BUILD_FREQUENCY": "Daily ",
"LOCATION": "50 GB Default",
"ENTITY_ID": "16340410015376127093028114591452",
"SCHEDULED_TIME": "08/30/2022 18:40:00",
"ACTION": "Incremental Cube Build",
"SCHEDULED_TIMESTAMP": 1661865000000,
"USER": "vishal.mittal",
"ENTITY_TYPE": "ANALYTICAL",
"ENTITY_SUB_TYPE": "CUBE",
"ENTITY_NAME": "Product-Sales_Detail_50GB"
},
{"BUILD_FREQUENCY": "Daily ",
"LOCATION": "50 GB Default",
"ENTITY_ID": "16340410015376127093028114591452",
"SCHEDULED_TIME": "08/31/2022 18:40:00",
"ACTION": "Incremental Cube Build",
"SCHEDULED_TIMESTAMP": 1661951400000,
"USER": "vishal.mittal",
"ENTITY_TYPE": "ANALYTICAL",
"ENTITY_SUB_TYPE": "CUBE",
"ENTITY_NAME": "Product-Sales_Detail_50GB"
},
{"BUILD_FREQUENCY": "Daily ",
"LOCATION": "50 GB Default",
"ENTITY_ID": "16340410015376127093028114591452",
"SCHEDULED_TIME": "09/01/2022 18:40:00",
"ACTION": "Incremental Cube Build",
"SCHEDULED_TIMESTAMP": 1662037800000,
"USER": "vishal.mittal",
"ENTITY_TYPE": "ANALYTICAL",
"ENTITY_SUB_TYPE": "CUBE",
"ENTITY_NAME": "Product-Sales_Detail_50GB"
},
{"BUILD_FREQUENCY": "Daily ",
"LOCATION": "50 GB Default",
"ENTITY_ID": "16340410015376127093028114591452",
"SCHEDULED_TIME": "09/02/2022 18:40:00",
"ACTION": "Incremental Cube Build",
"SCHEDULED_TIMESTAMP": 1662124200000,
"USER": "vishal.mittal",
"ENTITY_TYPE": "ANALYTICAL",
"ENTITY_SUB_TYPE": "CUBE",
"ENTITY_NAME": "Product-Sales_Detail_50GB"
},
{"BUILD_FREQUENCY": "Daily ",
"LOCATION": "50 GB Default",
"ENTITY_ID": "16340410015376127093028114591452",
"SCHEDULED_TIME": "09/03/2022 18:40:00",
"ACTION": "Incremental Cube Build",
"SCHEDULED_TIMESTAMP": 1662210600000,
"USER": "vishal.mittal",
"ENTITY_TYPE": "ANALYTICAL",
"ENTITY_SUB_TYPE": "CUBE",
"ENTITY_NAME": "Product-Sales_Detail_50GB"
},
{"BUILD_FREQUENCY": "Daily ",
"LOCATION": "50 GB Default",
"ENTITY_ID": "16340410015376127093028114591452",
"SCHEDULED_TIME": "09/04/2022 18:40:00",
"ACTION": "Incremental Cube Build",
"SCHEDULED_TIMESTAMP": 1662297000000,
"USER": "vishal.mittal",
"ENTITY_TYPE": "ANALYTICAL",
"ENTITY_SUB_TYPE": "CUBE",
"ENTITY_NAME": "Product-Sales_Detail_50GB"
}
]
}
}

Get Running Jobs

This API is used to get information about currently running jobs on the BI server.

Authorizations:

sessionIdbasicAuth

query Parameters

maxRows

string

Number of records to be fetched.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"JOBS": {"JOB": {"LOCATION": "50 GB Default",
"ENTITY_ID": "16340410015376127093028114591452",
"EXEC_TIME": "08/28/2022 12:27:08",
"INSTANCE_NAME_DISPLAY_VALUE": "intelli-i0051.kyvostest.com (BI Server)",
"REQUEST_ID": "840C10B0-DC58-6C95-5C63-C02CC9FD4AC8",
"INSTANCE_NAME_ACTUAL_VALUE": "intelli-i0051.kyvostest.com:45450",
"USER": "RestAPIUser 1",
"ENTITY_TYPE": "ANALYTICAL",
"ACTION": "Test Cube Build",
"EXEC_TIMESTAMP": 1661669828073,
"ELAPSED_TIME": "00:00:25",
"ENTITY_SUB_TYPE": "CUBE",
"ENTITY_NAME": "Product-Sales_Detail_50GB"
}
}
}

Get Completed Jobs

This API is used to get information about completed jobs on the BI server.

Authorizations:

sessionIdbasicAuth

query Parameters

numberOfDays	string Number of days filter to get completed jobs.
maxRows	string Number of records to be fetched.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"JOBS": {"JOB": {"LOCATION": "50 GB Default",
"ENTITY_ID": "16340410015376127093028114591452",
"EXEC_TIME": "08/28/2022 12:27:08",
"INSTANCE_NAME_DISPLAY_VALUE": "intelli-i0051.kyvostest.com (BI Server)",
"REQUEST_ID": "840C10B0-DC58-6C95-5C63-C02CC9FD4AC8",
"INSTANCE_NAME_ACTUAL_VALUE": "intelli-i0051.kyvostest.com:45450",
"USER": "RestAPIUser 1",
"ENTITY_TYPE": "ANALYTICAL",
"ACTION": "Test Cube Build",
"EXEC_TIMESTAMP": 1661669828073,
"ELAPSED_TIME": "00:00:25",
"ENTITY_SUB_TYPE": "CUBE",
"ENTITY_NAME": "Product-Sales_Detail_50GB"
}
}
}

Audit Logs

This API is used to get audit logs details.

Authorizations:

sessionIdbasicAuth

query Parameters

toDate	string Date till which you want audit logs to be fetched. toDate parameter will be ignored if fromDate parameter is not passed. Date format should be "MM/dd/yyyy"
fromDate	string Date from which you want audit logs to be fetched. toDate parameter will be considered with current system date if fromDate parameter is passed and toDate is not passed. Date format should be "MM/dd/yyyy"
maxRows	string Number of records to be fetched.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Request Body schema: application/x-www-form-urlencoded

filterJSON

object

Filter details string formatted JSON.
Example:

  [
    {
        "fieldName":"DATE_TIME_RANGE",
        "operation":"EQUAL_TO",
        "dataType":"DATE",
        "firstValue":"MM/dd/yyyy"
     },
   {
        "fieldName":"USER_ID",
        "operation":"INLIST",
        "dataType":"CHAR",
        "firstValue":"'301198281'"
     },
   {
        "fieldName":"ACTION",
        "operation":"INLIST",
        "dataType":"NUMBER",
        "firstValue":"Full Data Process Complete"
     },
   {
        "fieldName":"SOURCE_TYPE",
        "operation":"INLIST",
        "dataType":"NUMBER",
        "firstValue":"Semantic Model"
     },
   {
        "fieldName":"SOURCE_NAME",
        "operation":"CONTAINSIGNORECASE",
        "dataType":"CHAR",
        "firstValue":"SModelName"
     },
   {
        "fieldName":"STATUS",
        "operation":"INLIST",
        "dataType":"NUMBER",
        "firstValue":"Success"
     },
   {
        "fieldName":"INSTANCE_NAME",
        "operation":"CONTAINSIGNORECASE",
        "dataType":"CHAR",
        "firstValue":"intelli"
     },
   {
        "fieldName":"ELAPSED_TIME",
        "operation":"GREATER_THAN",
        "dataType":"NUMBER",
        "firstValue":"100000"
     }
]

Responses

Response samples

200

Content type

application/xml

<AUDIT_LOGS>
  <AUDIT_LOG LOCATION="(Not available)" STATUS="Success" END_TIME="09/28/2023 16:43:57" ACTION="Sign-in" SOURCE_TYPE="User" SOURCE="-" USER="UserName" AUDIT_ID="1695899637" >
  </AUDIT_LOG>
</AUDIT_LOGS>

Get Active Users

This API is used to get information about active users.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"ACTIVE_USERS": {"USER": {"ROLE": "Administrator",
"SIGNED_IN_TIME": "08/28/2022 12:44:34",
"SIGNED_IN_TIMESTAMP": 1661670874197,
"EMAIL": "",
"NAME": "RestAPITest"
}
}
}

Get Audit Logging Status

This API is used to get audit log status.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"AUDIT_LOGGING_ENABLED": true
}
}

Get BI Servers

This API is used to get BI Servers list.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"OLAP_ENGINES": {"OLAP_ENGINE": [{"LOCATION": "intelli-i0051.kyvostest.com",
"ROLE": "Coordination Master",
"INSTANCE_NAME": "BI Server",
"MEMORY_USAGE": "1.32 GB 04.15%",
"PORTS": "45450, 6803"
},
{"LOCATION": "intelli-i0051.kyvostest.com",
"ROLE": "-",
"INSTANCE_NAME": "BI Server-instance2",
"MEMORY_USAGE": "1.77 GB 05.59%",
"PORTS": "45452, 6804"
}
]
}
}

Get Query Engine

This API is used to get Query Engine List.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"QUERY_ENGINES": {"QUERY_ENGINE": [{"LOCATION": "intelli-i0055.kyvostest.com",
"INSTANCE_NAME": "queryengine",
"MEMORY_USAGE": "305.40 MB 02.17%",
"PORTS": "45440, 6903"
},
{"LOCATION": "intelli-i0054.kyvostest.com",
"INSTANCE_NAME": "queryengine",
"MEMORY_USAGE": "2.65 GB 19.27%",
"PORTS": "45440, 6903"
}
]
}
}

Connections

Get Connections

This API is used to get Connection listing.

Authorizations:

sessionIdbasicAuth

query Parameters

connectionType

string

Default: "ALL"

Enum: "ALL" "BUILD"

This is to fetch the connections of a particular type. If not provided, all types of connections will be returned.

ALL: Get list of all the connections.

BUILD: Get list of build connections.

header Parameters

sessionid

string

The session Id is the token received from the login API.
Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"CONNECTIONS": {"CONNECTION": [{"ACCESSRIGHTS": 1,
"configuration": {"property": [{"encrypted": false,
"name": "kyvos.build.spark.read.method",
"value": "JDBC"
},
{"encrypted": false,
"name": "kyvos.connection.isEncryptedConnection",
"value": true
},
{"encrypted": false,
"name": "kyvos.connection.isRead",
"value": true
},
{"encrypted": false,
"name": "kyvos.connection.provider",
"value": "AZURESQLDB"
},
{"encrypted": false,
"name": "kyvos.connection.driver",
"value": "com.microsoft.sqlserver.jdbc.SQLServerDriver"
},
{"encrypted": false,
"name": "kyvos.connection.name",
"value": "UntitledConnection5@@"
},
{"encrypted": false,
"name": "kyvos.connection.lastUpdateTimestamp",
"value": 1647928099402
}
]
},
"NAME": "UntitledConnection5@@"
},
{"ACCESSRIGHTS": 1,
"configuration": {"property": [{"encrypted": false,
"name": "kyvos.connection.role",
"value": "si"
},
{"encrypted": false,
"name": "kyvos.connection.server",
"value": "alpha"
},
{"encrypted": false,
"name": "kyvos.connection.isEncryptedConnection",
"value": true
},
{"encrypted": false,
"name": "kyvos.connection.provider",
"value": "SNOWFLAKE"
},
{"encrypted": false,
"name": "kyvos.connection.url",
"value": "http://"
},
{"encrypted": false,
"name": "kyvos.connection.lastUpdateTimestamp",
"value": 1645509810082
},
{"encrypted": false,
"name": "kyvos.connection.userImpersonation",
"value": false
},
{"encrypted": false,
"name": "kyvos.connection.warehouse",
"value": "gamma"
},
{"encrypted": false,
"name": "kyvos.connection.user",
"value": "alpha"
},
{"encrypted": false,
"name": "kyvos.connection.isRead",
"value": true
},
{"encrypted": true,
"name": "kyvos.connection.password",
"value": "h5iKPI84yJE7GZ8QyUxJaumPwWqUZYNu0Hf9nzpfVadRDu6J/MwchtHmPKPuQR2kBw=="
},
{"encrypted": false,
"name": "kyvos.connection.database",
"value": "delta"
},
{"encrypted": false,
"name": "kyvos.connection.account",
"value": "beta"
},
{"encrypted": false,
"name": "kyvos.connection.defaultsqlengine",
"value": false
},
{"encrypted": false,
"name": "kyvos.connection.name",
"value": "snowflake1"
},
{"encrypted": false,
"name": "kyvos.connection.authenticationtype",
"value": "SNOWFLAKE"
}
]
},
"NAME": "snowflake1"
}
]
}
}
}

Create Connection

This API is used to create a connectoin.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

connectionXML

required

object

XML of Connection Object.

For e.g.

 <CONNECTION NAME="UntitledConnection" ACCESSRIGHTS="1"

                        >

      <configuration>

          <property>

              <name>kyvos.build.spark.read.method</name>

              <value>JDBC</value>

              <encrypted>false</encrypted>

          </property>

          <property>

              <name>kyvos.connection.user</name>

              <value>username</value>

              <encrypted>false</encrypted>

          </property>

          <property>

              <name>kyvos.connection.version</name>

              <value></value>

              <encrypted>false</encrypted>

          </property>

          <property>

              <name>kyvos.connection.isEncryptedConnection</name>

              <value>true</value>

              <encrypted>false</encrypted>

          </property>

          <property>

              <name>kyvos.connection.isRead</name>

              <value>true</value>

              <encrypted>false</encrypted>

          </property>

          <property>

              <name>kyvos.connection.provider</name>

              <value>AZURESQLDB</value>

              <encrypted>false</encrypted>

          </property>

          <property>

              <name>kyvos.connection.password</name>

              <value>KahvrDwaJ/zeiVRYOCaRVqAk5lKfo/TeiAtfY6ipsLj1j9eg6XryaGnj1eyBTonHezwe</value>

              <encrypted>true</encrypted>

          </property>

          <property>

              <name>kyvos.connection.driver</name>

              <value>com.microsoft.sqlserver.jdbc.SQLServerDriver</value>

              <encrypted>false</encrypted>

          </property>

          <property>

              <name>kyvos.connection.url</name>

              <value>ssdfsdfdsf</value>

              <encrypted>false</encrypted>

          </property>

          <property>

              <name>kyvos.connection.name</name>

              <value>UntitledConnection</value>

              <encrypted>false</encrypted>

          </property>

          <property>

              <name>kyvos.connection.lastUpdateTimestamp</name>

              <value>1659436758482</value>

              <encrypted>false</encrypted>

          </property>

      </configuration>

  </CONNECTION>

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Connection added successfully.",
"CODE": 0
}

Update Connection

This API is used to update an existing connection.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

connectionXML

required

object

XML of Connection Object.

For e.g.

 <CONNECTION NAME="UntitledConnection" ACCESSRIGHTS="1"

                        >

      <configuration>

          <property>

              <name>kyvos.build.spark.read.method</name>

              <value>JDBC</value>

              <encrypted>false</encrypted>

          </property>

          <property>

              <name>kyvos.connection.user</name>

              <value>username</value>

              <encrypted>false</encrypted>

          </property>

          <property>

              <name>kyvos.connection.version</name>

              <value></value>

              <encrypted>false</encrypted>

          </property>

          <property>

              <name>kyvos.connection.isEncryptedConnection</name>

              <value>true</value>

              <encrypted>false</encrypted>

          </property>

          <property>

              <name>kyvos.connection.isRead</name>

              <value>true</value>

              <encrypted>false</encrypted>

          </property>

          <property>

              <name>kyvos.connection.provider</name>

              <value>AZURESQLDB</value>

              <encrypted>false</encrypted>

          </property>

          <property>

              <name>kyvos.connection.password</name>

              <value>KahvrDwaJ/zeiVRYOCaRVqAk5lKfo/TeiAtfY6ipsLj1j9eg6XryaGnj1eyBTonHezwe</value>

              <encrypted>true</encrypted>

          </property>

          <property>

              <name>kyvos.connection.driver</name>

              <value>com.microsoft.sqlserver.jdbc.SQLServerDriver</value>

              <encrypted>false</encrypted>

          </property>

          <property>

              <name>kyvos.connection.url</name>

              <value>ssdfsdfdsf</value>

              <encrypted>false</encrypted>

          </property>

          <property>

              <name>kyvos.connection.name</name>

              <value>UntitledConnection</value>

              <encrypted>false</encrypted>

          </property>

          <property>

              <name>kyvos.connection.lastUpdateTimestamp</name>

              <value>1659436758482</value>

              <encrypted>false</encrypted>

          </property>

      </configuration>

  </CONNECTION>

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Connection updated successfully.",
"CODE": 0
}

Get Connection

This API is used to get a connection.

Authorizations:

sessionIdbasicAuth

path Parameters

connectionName

required

string

Example: Connection Name

Name of Connection

header Parameters

sessionid

string

Example:

The session Id is the token received from the login API.
Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"CONNECTION": {"ACCESSRIGHTS": 1,
"configuration": {"property": [{"encrypted": false,
"name": "kyvos.connection.role",
"value": "si"
},
{"encrypted": false,
"name": "kyvos.connection.server",
"value": "alpha"
},
{"encrypted": false,
"name": "kyvos.connection.isEncryptedConnection",
"value": true
},
{"encrypted": false,
"name": "kyvos.connection.provider",
"value": "SNOWFLAKE"
},
{"encrypted": false,
"name": "kyvos.connection.url",
"value": "http://"
},
{"encrypted": false,
"name": "kyvos.connection.lastUpdateTimestamp",
"value": 1645509810082
},
{"encrypted": false,
"name": "kyvos.connection.userImpersonation",
"value": false
},
{"encrypted": false,
"name": "kyvos.connection.warehouse",
"value": "gamma"
},
{"encrypted": false,
"name": "kyvos.connection.user",
"value": "alpha"
},
{"encrypted": false,
"name": "kyvos.connection.isRead",
"value": true
},
{"encrypted": true,
"name": "kyvos.connection.password",
"value": "h5iKPI84yJE7GZ8QyUxJaumPwWqUZYNu0Hf9nzpfVadRDu6J/MwchtHmPKPuQR2kBw=="
},
{"encrypted": false,
"name": "kyvos.connection.database",
"value": "delta"
},
{"encrypted": false,
"name": "kyvos.connection.account",
"value": "beta"
},
{"encrypted": false,
"name": "kyvos.connection.defaultsqlengine",
"value": false
},
{"encrypted": false,
"name": "kyvos.connection.name",
"value": "snowflake1"
},
{"encrypted": false,
"name": "kyvos.connection.authenticationtype",
"value": "SNOWFLAKE"
}
]
},
"NAME": "snowflake1"
}
}
}

Delete Connection

This API is used to delete a connection.

Authorizations:

sessionIdbasicAuth

path Parameters

connectionName

required

string

Example: Connection Name

Name of Connection

header Parameters

sessionid

string

Example:

The session Id is the token received from the login API.
Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Connection deleted successfully.",
"Code": 0
}

Get Connection Advanced Properties

This API is used to get all the advanced properties applicable to a connection.

Authorizations:

sessionIdbasicAuth

query Parameters

connectionName

required

string

Example: connectionName=Connection Name

Name of Connection

header Parameters

sessionid

string

The session Id is the token received from the login API.
Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"advanceProperties": [ ]
}
}

Datasets

Datasets were previously referred to as registered files.

Get Datasets

This API is used to fetch the list of folders or the list of datasets.

Authorizations:

sessionIdbasicAuth

query Parameters

show	string Enum: "all" "folders" "list" Example: show=all This parameter is used to control the objects returned in the response. The response can have a list of only folders, a list of only entities, or both, based on other filters applied. The default value is 'all' all: Response list contains a combined list of folders and entities. list: Response list shows only the entity list. folders: Response list shows only the folders list.
OWNER	string This parameter filters entities by owner (the user who created that entity) name.
TAGS	string This parameter filters the entities by tags. This filter will only work if the entity has a single tag.
SEARCH_TEXT	string This parameter filters the entities by their names. All entities whose name contains the searched text are included in the result, irrespective of the case format.
MODIFIED_AFTER	string This parameter filters the entities by their last modified timestamp. All the entities modified after the provided timestamp are included in the result.
MODIFIED_BEFORE	string This parameter filters the entities by their last modified timestamp. All the entities modified before the provided timestamp are included in the result.
COUNT	number This parameter sets the number of the records displayed in the response. It is applicable only for show=list or show=folders but not with show=all.
LAST_ENTITY_NAME	string When this parameter is used, the response shows only the entities occurring after the entity name specified in this parameter. The list ignores all the entities before that.
LAST_ENTITY_ID	string When this parameter is used, the response shows only the entities occurring after the entity ID specified in this parameter. The list ignores all the entities before that.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"REGISTERED_FILES": {"REGISTERED_FILE": [{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594134652,
"LAST_MODIFIED": "11/16/2022 15:52:14",
"id": "15330142847572127083069172553064",
"NAME": "Action"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594134837,
"LAST_MODIFIED": "11/16/2022 15:52:14",
"id": "15330144283295127073098167664670",
"NAME": "ActionSource"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594135042,
"LAST_MODIFIED": "11/16/2022 15:52:15",
"id": "15330140041630127043070144312748",
"NAME": "History_audit_log"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594135175,
"LAST_MODIFIED": "11/16/2022 15:52:15",
"id": "15337218288972127087010144746596",
"NAME": "Querying file"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594135292,
"LAST_MODIFIED": "11/16/2022 15:52:15",
"id": "15330152151294127095012168885668",
"NAME": "SourceType"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594135400,
"LAST_MODIFIED": "11/16/2022 15:52:15",
"id": "15330152764897127073059118152259",
"NAME": "Status"
}
]
}
}
}

Create Dataset

This API is used to create a new Dataset Object.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

datasetXML

required

object

XML of a Dataset Object. This xml can be generated with the help of com.kyvos.client.reportobjects.wrappers.RegisteredFile class.
For e.g.

 <IRO ID="16612546785471127089091117761211" NAME="Untitled File 1" TYPE="QUERY" SUBTYPE="REGISTERED" FOLDER_ID="folder_16282337673341127087061149752657" ISPUBLIC="true" FOLDER_NAME="1JPMC_DRR">
      <COMMON>
        <DESC>
          <![CDATA[]]>
        </DESC>
      </COMMON>
      <SPECIFIC>
        <FILTERS>
          <FILTER NAME="COPY_ACCESS_RIGHTS" OPERATOR="=">
            <VALUE>
              <![CDATA[1]]>
            </VALUE>
          </FILTER>
          <FILTER NAME="SRC_ENTITY_ID" OPERATOR="=">
            <VALUE>
              <![CDATA[]]>
            </VALUE>
          </FILTER>
        </FILTERS>
        <QO CACHED="true" CONN_NAME="DefaultHadoopCluster01" ROLE="DIMENSION" CONN_TYPE="HADOOP_CLUSTER">
          <TRANSFORMATION>
            <LAYOUT HSCROLLVALUE="0" VSCROLLVALUE="0" STEPS_PANEL_WIDTH="" TRANSFORMATION_PANEL_HEIGHT="" SELECTED_STEP_ID=""/>
            <STEPS>
              <STEP ID="16612546785471127089091117761273" NAME="Fetch" TYPE="FETCH" LEFT="0" TOP="0">
                <INPUT_STEPS>
                <OUTPUT_STEPS>
                <STEP_INFO>
                  <FETCH_INFO>
                    <FETCH CONN_NAME="DefaultHadoopCluster01" CONN_TYPE="PARENT" LOOKUP_ENABLED="false" IS_SORTED="false" SOURCE="SEQ" INPUT_TYPE="">
                      <SPARK_JDBC_DATA_PARTITION_COLUMN>
                        <COLUMN_NAME>
                          <![CDATA[]]>
                        </COLUMN_NAME>
                        <TABLE_NAME>
                          <![CDATA[]]>
                        </TABLE_NAME>
                        <METADATA_MODE>
                          <![CDATA[DEFAULT]]>
                        </METADATA_MODE>
                        <NUMBER_OF_PARTITIONS>
                          <![CDATA[]]>
                        </NUMBER_OF_PARTITIONS>
                        <MIN_VALUE>
                          <![CDATA[]]>
                        </MIN_VALUE>
                        <MAX_VALUE>
                          <![CDATA[]]>
                        </MAX_VALUE>
                        <NUMBER_OF_RECORDS>
                          <![CDATA[]]>
                        </NUMBER_OF_RECORDS>
                      </SPARK_JDBC_DATA_PARTITION_COLUMN>
                      <SEQSOURCE>
                        <PATH>
                          <![CDATA[ranger/audit/hdfs/hdfs/20210716/hdfs_ranger_audit_intelli-i0051.kyvostest.com.log]]>
                        </PATH>
                        <FILE_TYPE>
                          <![CDATA[SEQ]]>
                        </FILE_TYPE>
                        <ENTITY_TYPE>
                          <![CDATA[FILE]]>
                        </ENTITY_TYPE>
                        <RECORD_SEPARATOR>
                          <![CDATA[]]>
                        </RECORD_SEPARATOR>
                        <SEPARATOR>
                          <![CDATA[SOH]]>
                        </SEPARATOR>
                        <ENCLOSURE>
                          <![CDATA["]]>
                        </ENCLOSURE>
                        <ESCAPECHAR>
                          <![CDATA[]]>
                        </ESCAPECHAR>
                        <HEADER>
                          <![CDATA[false]]>
                        </HEADER>
                        <IGNORE_EMPTY_ROWS>
                          <![CDATA[true]]>
                        </IGNORE_EMPTY_ROWS>
                        <ENCODING>
                          <![CDATA[ASCII]]>
                        </ENCODING>
                        <COMPRESSION>
                          <![CDATA[NONE]]>
                        </COMPRESSION>
                        <REQUEST_METHOD>
                          <![CDATA[GET]]>
                        </REQUEST_METHOD>
                        <KEY_AS_COLUMN>
                          <![CDATA[true]]>
                        </KEY_AS_COLUMN>
                        <NAME_AS_COLUMN>
                          <![CDATA[false]]>
                        </NAME_AS_COLUMN>
                        <SKIP_LINES TOP = "0" BOTTOM = "0" />
                        <DATE_FORMAT>
                          <![CDATA[null]]>
                        </DATE_FORMAT>
                      </SEQSOURCE>
                    </FETCH>
                    <COLUMNS></COLUMNS>
                  </FETCH_INFO>
                </STEP_INFO>
              </STEP>
            </STEPS>
          </TRANSFORMATION>
        </QO>
      </SPECIFIC>
    </IRO>

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully added dataset: Untitled File 1",
"CODE": 0
}

Get Datasets From Folder

This API is needed to get a dataset listing from a specific folder.

Authorizations:

sessionIdbasicAuth

path Parameters

folderNameOrId

required

string

Name or Id of a folder from which you want to get list of datasets. Firstly, parameter folderNameOrId will be treated as Id. In case no dataset is found with that Id, then it will search for a dataset by taking folderNameOrId as Name

query Parameters

OWNER	string This parameter filters entities by owner (the user who created that entity) name.
TAGS	string This parameter filters the entities by tags.
SEARCH_TEXT	string This parameter filters the entities by their names. All entities whose name contains the searched text are included in the result, irrespective of the case format.
MODIFIED_AFTER	string This parameter filters the entities by their last modified timestamp. All the entities modified after the provided timestamp are included in the result.
MODIFIED_BEFORE	string This parameter filters the entities by their last modified timestamp. All the entities modified before the provided timestamp are included in the result.
COUNT	number This parameter sets the number of the records displayed in the response.
LAST_ENTITY_NAME	string When this parameter is used, the response shows only the entities occurring after the entity name specified in this parameter. The list ignores all the entities before that.
LAST_ENTITY_ID	string When this parameter is used, the response shows only the entities occurring after the entity ID specified in this parameter. The list ignores all the entities before that.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"REGISTERED_FILES": {"REGISTERED_FILE": [{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594134652,
"LAST_MODIFIED": "11/16/2022 15:52:14",
"id": "15330142847572127083069172553064",
"NAME": "Action"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594134837,
"LAST_MODIFIED": "11/16/2022 15:52:14",
"id": "15330144283295127073098167664670",
"NAME": "ActionSource"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594135042,
"LAST_MODIFIED": "11/16/2022 15:52:15",
"id": "15330140041630127043070144312748",
"NAME": "History_audit_log"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594135175,
"LAST_MODIFIED": "11/16/2022 15:52:15",
"id": "15337218288972127087010144746596",
"NAME": "Querying file"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594135292,
"LAST_MODIFIED": "11/16/2022 15:52:15",
"id": "15330152151294127095012168885668",
"NAME": "SourceType"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594135400,
"LAST_MODIFIED": "11/16/2022 15:52:15",
"id": "15330152764897127073059118152259",
"NAME": "Status"
}
]
}
}
}

Get Dataset

This API is used to get a Dataset Object.

Authorizations:

sessionIdbasicAuth

path Parameters

nameOrId

required

string

Name or Id of the dataset. Firstly, parameter nameOrId will be treated as Id. In case no dataset is found with that Id, then it will search for the dataset by taking nameOrId as Name. In case of nameOrId as Name, folderNameOrId is used

query Parameters

folderNameOrId

string

Name or Id of a folder from which you want to get dataset. First, parameter folderNameOrId will be treated as Id. In case no folder is found with that Id, then it will search for a folder by taking folderNameOrId as Name.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"IRO": {"SUBTYPE": "REGISTERED",
"CATEGORY_ID": "folder_16282337673341127087061149752657",
"ACCESSRIGHTS": 1,
"FOLDER_ID": "folder_16282337673341127087061149752657",
"NAME": "Bu_D1",
"FOLDER_NAME": "1JPMC_DRR",
"OWNERAPPID": "15825358151067127060075128810359",
"SPECIFIC": {"QO": {"ROLE": "DIMENSION",
"TRANSFORMATION": {"LAYOUT": {"VSCROLLVALUE": 0,
"STEPS_PANEL_WIDTH": "",
"HSCROLLVALUE": 0,
"SELECTED_STEP_ID": "",
"TRANSFORMATION_PANEL_HEIGHT": ""
},
"STEPS": {"STEP": {"STEP_INFO": {"FETCH_INFO": {"FETCH": {"SOURCE_SUB_TYPE": "",
"CONN_TYPE": "PARENT",
"LOOKUP_ENABLED": false,
"IS_SORTED": false,
"INCREMENTAL_IDENTIFIER": {"COLUMN_NAME": ""
},
"SOURCE": "HCATALOG",
"CONN_NAME": "",
"INPUT_TYPE": "SQL",
"SPARK_JDBC_DATA_PARTITION_COLUMN": {"TABLE_NAME": "",
"NUMBER_OF_PARTITIONS": "",
"NUMBER_OF_RECORDS": "",
"COLUMN_NAME": "",
"METADATA_MODE": "DEFAULT",
"MAX_VALUE": "",
"MIN_VALUE": ""
},
"SQL_SOURCE": {"SQL": "SELECT\nD.BU_entityI,\nD.BUSINESS_UNIT_ID,\nD.NM_LONG,\nD.BU_DISPLAYNAME,\nCASE WHEN D.BU_entityID = D.PARENTID THEN D.HIERARCHY_ID ELSE D.PARENTID END AS PARENTID,\nD.HIERARCHY_ID,\nD.HIERARCHY_NM\nFROM jpmcbu.bu_pch D\nWHERE D.HIERARCHY_ID in ('5','13','16')\n\nUNION\n\nSELECT\nA.HIERARCHY_ID AS BU_entityID,\n\"\" AS BUSINESS_UNIT_ID,\nA.HIERARCHY_NM AS NM_LONG,\nA.HIERARCHY_NM AS BU_DISPLAYNAME,\nA.HIERARCHY_ID AS PARENTID,\nA.HIERARCHY_ID,\nA.HIERARCHY_NM\n\nFROM (\nSELECT DISTINCT D.HIERARCHY_ID,D.HIERARCHY_NM\nFROM jpmcbu.bu_pch D\nWHERE D.HIERARCHY_ID in ('5','13','16')\n) A"
}
},
"COLUMNS": {"COLUMN": [{"UPDATED_NAME": "BU_entityID",
"DATABASE_TIMEZONE": "",
"PIGDATATYPE": 1,
"HIDDEN": false,
"FIELDDATAFORMATTYPE": "1",
"PRECISION": "",
"NAME": "BU_entityID",
"ROLE": "",
"FIELDFORMAT": {"USEDEFAULT": "",
"content": 0
},
"DATATYPENAME": "CHAR",
"LOCALE": "",
"ORIGINAL_NAME": "BU_entityID",
"FULLY_QUALIFIED_NAME": "",
"ORIGINAL_QUALIFIED_NAME": "",
"SORT_ORDER": "",
"DATASUBTYPENAME": "",
"SCALE": "",
"ORIGINAL_DATATYPENAME": 12,
"SORT_TYPE": ""
},
{"UPDATED_NAME": "BUSINESS_UNIT_ID",
"DATABASE_TIMEZONE": "",
"PIGDATATYPE": 1,
"HIDDEN": false,
"FIELDDATAFORMATTYPE": "1",
"PRECISION": "",
"NAME": "BUSINESS_UNIT_ID",
"ROLE": "",
"FIELDFORMAT": {"USEDEFAULT": "",
"content": 0
},
"DATATYPENAME": "CHAR",
"LOCALE": "",
"ORIGINAL_NAME": "BUSINESS_UNIT_ID",
"FULLY_QUALIFIED_NAME": "",
"ORIGINAL_QUALIFIED_NAME": "",
"SORT_ORDER": "",
"DATASUBTYPENAME": "",
"SCALE": "",
"ORIGINAL_DATATYPENAME": 12,
"SORT_TYPE": ""
},
{"UPDATED_NAME": "NM_LONG",
"DATABASE_TIMEZONE": "",
"PIGDATATYPE": 1,
"HIDDEN": false,
"FIELDDATAFORMATTYPE": "1",
"PRECISION": "",
"NAME": "NM_LONG",
"ROLE": "",
"FIELDFORMAT": {"USEDEFAULT": "",
"content": 0
},
"DATATYPENAME": "CHAR",
"LOCALE": "",
"ORIGINAL_NAME": "NM_LONG",
"FULLY_QUALIFIED_NAME": "",
"ORIGINAL_QUALIFIED_NAME": "",
"SORT_ORDER": "",
"DATASUBTYPENAME": "",
"SCALE": "",
"ORIGINAL_DATATYPENAME": 12,
"SORT_TYPE": ""
},
{"UPDATED_NAME": "BU_DISPLAYNAME",
"DATABASE_TIMEZONE": "",
"PIGDATATYPE": 1,
"HIDDEN": false,
"FIELDDATAFORMATTYPE": "1",
"PRECISION": "",
"NAME": "BU_DISPLAYNAME",
"ROLE": "",
"FIELDFORMAT": {"USEDEFAULT": "",
"content": 0
},
"DATATYPENAME": "CHAR",
"LOCALE": "",
"ORIGINAL_NAME": "BU_DISPLAYNAME",
"FULLY_QUALIFIED_NAME": "",
"ORIGINAL_QUALIFIED_NAME": "",
"SORT_ORDER": "",
"DATASUBTYPENAME": "",
"SCALE": "",
"ORIGINAL_DATATYPENAME": 12,
"SORT_TYPE": ""
},
{"UPDATED_NAME": "PARENTID",
"DATABASE_TIMEZONE": "",
"PIGDATATYPE": 1,
"HIDDEN": false,
"FIELDDATAFORMATTYPE": "1",
"PRECISION": "",
"NAME": "PARENTID",
"ROLE": "",
"FIELDFORMAT": {"USEDEFAULT": "",
"content": 0
},
"DATATYPENAME": "CHAR",
"LOCALE": "",
"ORIGINAL_NAME": "PARENTID",
"FULLY_QUALIFIED_NAME": "",
"ORIGINAL_QUALIFIED_NAME": "",
"SORT_ORDER": "",
"DATASUBTYPENAME": "",
"SCALE": "",
"ORIGINAL_DATATYPENAME": 12,
"SORT_TYPE": ""
},
{"UPDATED_NAME": "HIERARCHY_ID",
"DATABASE_TIMEZONE": "",
"PIGDATATYPE": -5,
"HIDDEN": false,
"FIELDDATAFORMATTYPE": "2",
"PRECISION": "",
"NAME": "HIERARCHY_ID",
"ROLE": "",
"FIELDFORMAT": {"USEDEFAULT": "",
"content": 0
},
"DATATYPENAME": "NUMBER",
"LOCALE": "",
"ORIGINAL_NAME": "HIERARCHY_ID",
"FULLY_QUALIFIED_NAME": "",
"ORIGINAL_QUALIFIED_NAME": "",
"SORT_ORDER": "",
"DATASUBTYPENAME": "long",
"SCALE": "",
"ORIGINAL_DATATYPENAME": 12,
"SORT_TYPE": ""
},
{"UPDATED_NAME": "HIERARCHY_NM",
"DATABASE_TIMEZONE": "",
"PIGDATATYPE": 1,
"HIDDEN": false,
"FIELDDATAFORMATTYPE": "1",
"PRECISION": "",
"NAME": "HIERARCHY_NM",
"ROLE": "",
"FIELDFORMAT": {"USEDEFAULT": "",
"content": 0
},
"DATATYPENAME": "CHAR",
"LOCALE": "",
"ORIGINAL_NAME": "HIERARCHY_NM",
"FULLY_QUALIFIED_NAME": "",
"ORIGINAL_QUALIFIED_NAME": "",
"SORT_ORDER": "",
"DATASUBTYPENAME": "",
"SCALE": "",
"ORIGINAL_DATATYPENAME": 12,
"SORT_TYPE": ""
}
]
}
}
},
"LEFT": 0,
"TOP": 0,
"OUTPUT_STEPS": "",
"ID": "16315295695318981713",
"INPUT_STEPS": "",
"TYPE": "FETCH",
"NAME": "Fetch"
}
}
},
"CONN_TYPE": "DEFAULT",
"CACHED": true,
"CONN_NAME": "DefaultHadoopCluster01"
}
},
"REPOSITDATE": "06/08/2022 12:27:29",
"ISPUBLIC": true,
"COMMON": {"DESC": ""
},
"LINKED_ENTITY_ID": "",
"ID": "16315295692604127043024119188204",
"OWNERAPPNAME": "-",
"TYPE": "QUERY"
}
}

Update Dataset

This API is used to update an existing Dataset.

Authorizations:

sessionIdbasicAuth

path Parameters

nameOrId

required

string

Name or Id of the dataset. Firstly, parameter nameOrId will be treated as Id. In case no dataset is found with that Id, then it will search for datset by taking nameOrId as Name. In case of nameOrId as Name, folderNameOrId is used

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

datasetXML

required

string

XML of a dataset object. This xml can be generated with the help of com.kyvos.client.reportobjects.wrappers.RegisteredFile class.
For e.g.

 <IRO ID="16612546785471127089091117761211" NAME="Untitled File 1" TYPE="QUERY" SUBTYPE="REGISTERED" FOLDER_ID="folder_16282337673341127087061149752657" ISPUBLIC="true" FOLDER_NAME="1JPMC_DRR">
      <COMMON>
        <DESC>
          <![CDATA[]]>
        </DESC>
      </COMMON>
      <SPECIFIC>
        <FILTERS>
          <FILTER NAME="COPY_ACCESS_RIGHTS" OPERATOR="=">
            <VALUE>
              <![CDATA[1]]>
            </VALUE>
          </FILTER>
          <FILTER NAME="SRC_ENTITY_ID" OPERATOR="=">
            <VALUE>
              <![CDATA[]]>
            </VALUE>
          </FILTER>
        </FILTERS>
        <QO CACHED="true" CONN_NAME="DefaultHadoopCluster01" ROLE="DIMENSION" CONN_TYPE="HADOOP_CLUSTER">
          <TRANSFORMATION>
            <LAYOUT HSCROLLVALUE="0" VSCROLLVALUE="0" STEPS_PANEL_WIDTH="" TRANSFORMATION_PANEL_HEIGHT="" SELECTED_STEP_ID=""/>
            <STEPS>
              <STEP ID="16612546785471127089091117761273" NAME="Fetch" TYPE="FETCH" LEFT="0" TOP="0">
                <INPUT_STEPS>
                <OUTPUT_STEPS>
                <STEP_INFO>
                  <FETCH_INFO>
                    <FETCH CONN_NAME="DefaultHadoopCluster01" CONN_TYPE="PARENT" LOOKUP_ENABLED="false" IS_SORTED="false" SOURCE="SEQ" INPUT_TYPE="">
                      <SPARK_JDBC_DATA_PARTITION_COLUMN>
                        <COLUMN_NAME>
                          <![CDATA[]]>
                        </COLUMN_NAME>
                        <TABLE_NAME>
                          <![CDATA[]]>
                        </TABLE_NAME>
                        <METADATA_MODE>
                          <![CDATA[DEFAULT]]>
                        </METADATA_MODE>
                        <NUMBER_OF_PARTITIONS>
                          <![CDATA[]]>
                        </NUMBER_OF_PARTITIONS>
                        <MIN_VALUE>
                          <![CDATA[]]>
                        </MIN_VALUE>
                        <MAX_VALUE>
                          <![CDATA[]]>
                        </MAX_VALUE>
                        <NUMBER_OF_RECORDS>
                          <![CDATA[]]>
                        </NUMBER_OF_RECORDS>
                      </SPARK_JDBC_DATA_PARTITION_COLUMN>
                      <SEQSOURCE>
                        <PATH>
                          <![CDATA[ranger/audit/hdfs/hdfs/20210716/hdfs_ranger_audit_intelli-i0051.kyvostest.com.log]]>
                        </PATH>
                        <FILE_TYPE>
                          <![CDATA[SEQ]]>
                        </FILE_TYPE>
                        <ENTITY_TYPE>
                          <![CDATA[FILE]]>
                        </ENTITY_TYPE>
                        <RECORD_SEPARATOR>
                          <![CDATA[]]>
                        </RECORD_SEPARATOR>
                        <SEPARATOR>
                          <![CDATA[SOH]]>
                        </SEPARATOR>
                        <ENCLOSURE>
                          <![CDATA["]]>
                        </ENCLOSURE>
                        <ESCAPECHAR>
                          <![CDATA[]]>
                        </ESCAPECHAR>
                        <HEADER>
                          <![CDATA[false]]>
                        </HEADER>
                        <IGNORE_EMPTY_ROWS>
                          <![CDATA[true]]>
                        </IGNORE_EMPTY_ROWS>
                        <ENCODING>
                          <![CDATA[ASCII]]>
                        </ENCODING>
                        <COMPRESSION>
                          <![CDATA[NONE]]>
                        </COMPRESSION>
                        <REQUEST_METHOD>
                          <![CDATA[GET]]>
                        </REQUEST_METHOD>
                        <KEY_AS_COLUMN>
                          <![CDATA[true]]>
                        </KEY_AS_COLUMN>
                        <NAME_AS_COLUMN>
                          <![CDATA[false]]>
                        </NAME_AS_COLUMN>
                        <SKIP_LINES TOP = "0" BOTTOM = "0" />
                        <DATE_FORMAT>
                          <![CDATA[null]]>
                        </DATE_FORMAT>
                      </SEQSOURCE>
                    </FETCH>
                    <COLUMNS></COLUMNS>
                  </FETCH_INFO>
                </STEP_INFO>
              </STEP>
            </STEPS>
          </TRANSFORMATION>
        </QO>
      </SPECIFIC>
    </IRO>

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully updated dataset: Untitled File 1",
"CODE": 0
}

Delete Dataset

This API is used to delete an existing Dataset.

Authorizations:

sessionIdbasicAuth

path Parameters

nameOrId

required

string

Name or Id of Dataset Object. The response will contain dataset’s XML. Firstly, parameter nameOrId will be treated as Id. In case no dataset is found with that Id, then it will search for a dataset by taking nameOrId as Name. In case of nameOrId as Name, folderNameOrId is used

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.
folderName	string Name of a folder from which you want to get the dataset.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully deleted dataset: RestApiTest",
"CODE": 0
}

Create Fetch Step

This API is used to create a Fetch step for Dataset.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

Note: Use either csvResultsetXML or datasetXML. If both are provided, datasetXML will be used as csvResultsetXML is deprecated and not required.

csvResultsetXML

string

Deprecated

XML of a FetchStep Object. This XML can be generated with the help of com.kyvos.commons.entity.reportobjects.datasource.CSVSource class.

datasetXML

string

XML of a Dataset Object. This xml can be generated with the help of com.kyvos.client.reportobjects.wrappers.RegisteredFile class.
For e.g.

 <IRO ID="16612546785471127089091117761211" NAME="Untitled File 1" TYPE="QUERY" SUBTYPE="REGISTERED" FOLDER_ID="folder_16282337673341127087061149752657" ISPUBLIC="true" FOLDER_NAME="1JPMC_DRR">
      <COMMON>
        <DESC>
          <![CDATA[]]>
        </DESC>
      </COMMON>
      <SPECIFIC>
        <FILTERS>
          <FILTER NAME="COPY_ACCESS_RIGHTS" OPERATOR="=">
            <VALUE>
              <![CDATA[1]]>
            </VALUE>
          </FILTER>
          <FILTER NAME="SRC_ENTITY_ID" OPERATOR="=">
            <VALUE>
              <![CDATA[]]>
            </VALUE>
          </FILTER>
        </FILTERS>
        <QO CACHED="true" CONN_NAME="DefaultHadoopCluster01" ROLE="DIMENSION" CONN_TYPE="HADOOP_CLUSTER">
          <TRANSFORMATION>
            <LAYOUT HSCROLLVALUE="0" VSCROLLVALUE="0" STEPS_PANEL_WIDTH="" TRANSFORMATION_PANEL_HEIGHT="" SELECTED_STEP_ID=""/>
            <STEPS>
              <STEP ID="16612546785471127089091117761273" NAME="Fetch" TYPE="FETCH" LEFT="0" TOP="0">
                <INPUT_STEPS>
                <OUTPUT_STEPS>
                <STEP_INFO>
                  <FETCH_INFO>
                    <FETCH CONN_NAME="DefaultHadoopCluster01" CONN_TYPE="PARENT" LOOKUP_ENABLED="false" IS_SORTED="false" SOURCE="SEQ" INPUT_TYPE="">
                      <SPARK_JDBC_DATA_PARTITION_COLUMN>
                        <COLUMN_NAME>
                          <![CDATA[]]>
                        </COLUMN_NAME>
                        <TABLE_NAME>
                          <![CDATA[]]>
                        </TABLE_NAME>
                        <METADATA_MODE>
                          <![CDATA[DEFAULT]]>
                        </METADATA_MODE>
                        <NUMBER_OF_PARTITIONS>
                          <![CDATA[]]>
                        </NUMBER_OF_PARTITIONS>
                        <MIN_VALUE>
                          <![CDATA[]]>
                        </MIN_VALUE>
                        <MAX_VALUE>
                          <![CDATA[]]>
                        </MAX_VALUE>
                        <NUMBER_OF_RECORDS>
                          <![CDATA[]]>
                        </NUMBER_OF_RECORDS>
                      </SPARK_JDBC_DATA_PARTITION_COLUMN>
                      <SEQSOURCE>
                        <PATH>
                          <![CDATA[ranger/audit/hdfs/hdfs/20210716/hdfs_ranger_audit_intelli-i0051.kyvostest.com.log]]>
                        </PATH>
                        <FILE_TYPE>
                          <![CDATA[SEQ]]>
                        </FILE_TYPE>
                        <ENTITY_TYPE>
                          <![CDATA[FILE]]>
                        </ENTITY_TYPE>
                        <RECORD_SEPARATOR>
                          <![CDATA[]]>
                        </RECORD_SEPARATOR>
                        <SEPARATOR>
                          <![CDATA[SOH]]>
                        </SEPARATOR>
                        <ENCLOSURE>
                          <![CDATA["]]>
                        </ENCLOSURE>
                        <ESCAPECHAR>
                          <![CDATA[]]>
                        </ESCAPECHAR>
                        <HEADER>
                          <![CDATA[false]]>
                        </HEADER>
                        <IGNORE_EMPTY_ROWS>
                          <![CDATA[true]]>
                        </IGNORE_EMPTY_ROWS>
                        <ENCODING>
                          <![CDATA[ASCII]]>
                        </ENCODING>
                        <COMPRESSION>
                          <![CDATA[NONE]]>
                        </COMPRESSION>
                        <REQUEST_METHOD>
                          <![CDATA[GET]]>
                        </REQUEST_METHOD>
                        <KEY_AS_COLUMN>
                          <![CDATA[true]]>
                        </KEY_AS_COLUMN>
                        <NAME_AS_COLUMN>
                          <![CDATA[false]]>
                        </NAME_AS_COLUMN>
                        <SKIP_LINES TOP = "0" BOTTOM = "0" />
                        <DATE_FORMAT>
                          <![CDATA[null]]>
                        </DATE_FORMAT>
                      </SEQSOURCE>
                    </FETCH>
                    <COLUMNS></COLUMNS>
                  </FETCH_INFO>
                </STEP_INFO>
              </STEP>
            </STEPS>
          </TRANSFORMATION>
        </QO>
      </SPECIFIC>
    </IRO>

Responses

Response samples

200

Content type

application/json

{"FETCH_INFO": {"FETCH": {"SOURCE_SUB_TYPE": "",
"CONN_TYPE": "PARENT",
"LOOKUP_ENABLED": false,
"IS_SORTED": false,
"SOURCE": "",
"CONN_NAME": "",
"SPARK_JDBC_DATA_PARTITION_COLUMN": {"TABLE_NAME": "",
"NUMBER_OF_PARTITIONS": "",
"NUMBER_OF_RECORDS": "",
"COLUMN_NAME": "",
"METADATA_MODE": "DEFAULT",
"MAX_VALUE": "",
"MIN_VALUE": ""
}
},
"COLUMNS": ""
}
}

Save Dataset

This API is used to add/update dataset entity with given entity XML. As this API performs bulk operation, you must have privileges to import and export objects to use this API.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

datasetXML

required

object

XML of a Dataset Object. This xml can be generated with the help of com.kyvos.client.reportobjects.wrappers.RegisteredFile class.
For e.g.

 <IROS><IRO ID="16612546785471127089091117761211" NAME="Untitled File 1" TYPE="QUERY" SUBTYPE="REGISTERED" FOLDER_ID="folder_16282337673341127087061149752657" ISPUBLIC="true" FOLDER_NAME="1JPMC_DRR">
      <COMMON>
        <DESC>
          <![CDATA[]]>
        </DESC>
      </COMMON>
      <SPECIFIC>
        <FILTERS>
          <FILTER NAME="COPY_ACCESS_RIGHTS" OPERATOR="=">
            <VALUE>
              <![CDATA[1]]>
            </VALUE>
          </FILTER>
          <FILTER NAME="SRC_ENTITY_ID" OPERATOR="=">
            <VALUE>
              <![CDATA[]]>
            </VALUE>
          </FILTER>
        </FILTERS>
        <QO CACHED="true" CONN_NAME="DefaultHadoopCluster01" ROLE="DIMENSION" CONN_TYPE="HADOOP_CLUSTER">
          <TRANSFORMATION>
            <LAYOUT HSCROLLVALUE="0" VSCROLLVALUE="0" STEPS_PANEL_WIDTH="" TRANSFORMATION_PANEL_HEIGHT="" SELECTED_STEP_ID=""/>
            <STEPS>
              <STEP ID="16612546785471127089091117761273" NAME="Fetch" TYPE="FETCH" LEFT="0" TOP="0">
                <INPUT_STEPS>
                <OUTPUT_STEPS>
                <STEP_INFO>
                  <FETCH_INFO>
                    <FETCH CONN_NAME="DefaultHadoopCluster01" CONN_TYPE="PARENT" LOOKUP_ENABLED="false" IS_SORTED="false" SOURCE="SEQ" INPUT_TYPE="">
                      <SPARK_JDBC_DATA_PARTITION_COLUMN>
                        <COLUMN_NAME>
                          <![CDATA[]]>
                        </COLUMN_NAME>
                        <TABLE_NAME>
                          <![CDATA[]]>
                        </TABLE_NAME>
                        <METADATA_MODE>
                          <![CDATA[DEFAULT]]>
                        </METADATA_MODE>
                        <NUMBER_OF_PARTITIONS>
                          <![CDATA[]]>
                        </NUMBER_OF_PARTITIONS>
                        <MIN_VALUE>
                          <![CDATA[]]>
                        </MIN_VALUE>
                        <MAX_VALUE>
                          <![CDATA[]]>
                        </MAX_VALUE>
                        <NUMBER_OF_RECORDS>
                          <![CDATA[]]>
                        </NUMBER_OF_RECORDS>
                      </SPARK_JDBC_DATA_PARTITION_COLUMN>
                      <SEQSOURCE>
                        <PATH>
                          <![CDATA[ranger/audit/hdfs/hdfs/20210716/hdfs_ranger_audit_intelli-i0051.kyvostest.com.log]]>
                        </PATH>
                        <FILE_TYPE>
                          <![CDATA[SEQ]]>
                        </FILE_TYPE>
                        <ENTITY_TYPE>
                          <![CDATA[FILE]]>
                        </ENTITY_TYPE>
                        <RECORD_SEPARATOR>
                          <![CDATA[]]>
                        </RECORD_SEPARATOR>
                        <SEPARATOR>
                          <![CDATA[SOH]]>
                        </SEPARATOR>
                        <ENCLOSURE>
                          <![CDATA["]]>
                        </ENCLOSURE>
                        <ESCAPECHAR>
                          <![CDATA[]]>
                        </ESCAPECHAR>
                        <HEADER>
                          <![CDATA[false]]>
                        </HEADER>
                        <IGNORE_EMPTY_ROWS>
                          <![CDATA[true]]>
                        </IGNORE_EMPTY_ROWS>
                        <ENCODING>
                          <![CDATA[ASCII]]>
                        </ENCODING>
                        <COMPRESSION>
                          <![CDATA[NONE]]>
                        </COMPRESSION>
                        <REQUEST_METHOD>
                          <![CDATA[GET]]>
                        </REQUEST_METHOD>
                        <KEY_AS_COLUMN>
                          <![CDATA[true]]>
                        </KEY_AS_COLUMN>
                        <NAME_AS_COLUMN>
                          <![CDATA[false]]>
                        </NAME_AS_COLUMN>
                        <SKIP_LINES TOP = "0" BOTTOM = "0" />
                        <DATE_FORMAT>
                          <![CDATA[null]]>
                        </DATE_FORMAT>
                      </SEQSOURCE>
                    </FETCH>
                    <COLUMNS></COLUMNS>
                  </FETCH_INFO>
                </STEP_INFO>
              </STEP>
            </STEPS>
          </TRANSFORMATION>
        </QO>
      </SPECIFIC>
    </IRO>
  </IROS>

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"RES": [{"MESSAGE": "Successfully added dataset: RestFile1",
"CODE": 0
},
{"MESSAGE": "Successfully added dataset: RestFile2",
"CODE": 0
}
]
}
}

Get Dataset Advanced Properties

This API is used to get Dataset Advanced Properties.

Authorizations:

sessionIdbasicAuth

query Parameters

folderId required	string Id of the folder from which you want to get the dataset.
folderName	string Name of a folder from which you want to get the dataset. If the dataset is present on the root directory, give folder name as [Root].
datasetId required	string Id of the dataset.
datasetName	string Name of the dataset.

header Parameters

Accept required	string Enum: "application/xml" "applcation/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"PROPERTIES": ""
}
}

Update properties of Dataset

This API is used to update one or more properties of the dataset. For example DESCRIPTION property, TAGS property etc.
Note - User should provide either "datasetId" or "datasetName" and "folderName" details.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

datasetId	string Id of the dataset for which you want to update properties. If you do not know the dataset id, use the dataset name and folder name.
datasetName	string Name of the dataset for which you want to update properties.
folderName	string Folder name of the dataset for which you want to update properties.
propertyJSON required	object JSON containing an array of property name and their values. For e.g. [ { "name": "DESCRIPTION", "value": "description" }, { "name": "TAGS" "value": "tag" } ]

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully updated properties of the dataset.",
"CODE": 0
}

Get dataset Job Execution Status

This API is used to get job execution status for the dataset.

Authorizations:

sessionIdbasicAuth

query Parameters

folderId	string Id of the folder from which you want to get the dataset.
folderName	string Name of a folder from which you want to get the dataset. If the dataset is present on the root directory, give folder name as [Root].
datasetId required	string Id of the dataset.
datasetName	string Name of the dataset.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"DATA": {"INQUEUEJOBS": "",
"JOBEXECUTIONSTATUS": {"UPCOMINGJOBS": "",
"HISTORY": {"HISTORYITEM": {"HISTORY_ID": "7897EF85-9600-9943-2FA5-A3E2D9EB058C",
"IS_IDEAL_BUILD": false,
"STATUS": "SUCCESSFUL",
"FREQUENCY_TYPE": "ONCE",
"SCHEDULED_TIME": "05/04/2022 11:39:10",
"RUNTIME": "05/04/2022 11:40:12",
"BUILD_TYPE": "DATA_PROFILE",
"USER_NAME": "RestAPIUser 2"
}
}
}
}
}

Get Dataset Last Job Summary

This API is used to get the last job summary of the dataset.

Authorizations:

sessionIdbasicAuth

query Parameters

folderId	string Id of the folder from which you want to get the dataset.
folderName	string Name of a folder from which you want to get the dataset. If the dataset is present on the root directory, give folder name as [Root].
datasetId required	string Id of the dataset.
datasetName	string Name of the dataset.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"ALL_BUILD_STATUS": {"BUILD_STATUS": {"BUILD_NO": 1,
"HISTORY_ID": "7897EF85-9600-9943-2FA5-A3E2D9EB058C",
"STATUS": "COMPLETED",
"BUILD_TYPE": "DATA_PROFILE",
"CURRENT_BUILD_STATUS": {"COMPLETED": {"SIZE": "0.00 B",
"TIMESTAMP": "05/04/2022 11:40:12",
"SECTIONS": {"SECTION": {"MESSAGES": {"MESSAGE": {"TYPE": "INFO",
"content": "Record Count: <B>Not able to fetch record count for ORC/Parquet</B>"
}
},
"TYPE": "DETAILS"
}
},
"TOTAL_TIME": 0,
"ELAPSED_TIME": 0,
"RECORD_COUNT": "Not able to fetch record count for ORC/Parquet"
}
},
"SUB_TYPE": "REGISTERED",
"TYPE": "QUERY",
"INSTANCE_ID": 0
}
}
}

Execute Data Profile Job on Dataset

This API is used to execute data profile job on dataset.

Authorizations:

sessionIdbasicAuth

query Parameters

folderId required	string Id of the folder from which you want to get the dataset.
folderName	string Name of a folder from which you want to get dataset. If the dataset is present on the root directory, give folder name as [Root].
datasetId required	string Id of the dataset.
datasetName	string Name of the dataset.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

runType	string Default: "NOW" Enum: "NOW" "ONCE" Job frequency to run (NOW/ONCE) Default Value: NOW Now: This will immediately start the job Once: Job will run at the specified time
onceDateTime	string Date time in format (09/20/2014 17:25) Required when runType is ONCE
userParams	string The parameters info which is to be used in file data profiling. Value in JSON should be passed. Example: [ { "name": "parameterName", "value": "parameterValue" } ]
jobConnectionName	string Name of job connection
dataProfileJson	object Data profile settings in string formatted JSON object. { "samplingOptions": "SAMPLE/ALL", "fieldsGroup": "COMPLETE/CUSTOM", "fields": [ { "fieldId": "id of element", "displayName": "name of element" } ] }

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Data profile job added successfully.",
"CODE": 0
}

Update Parameters in Dataset

This API is used to update parameters in dataset.

Authorizations:

sessionIdbasicAuth

query Parameters

folderId required	string Id of the folder from which you want to get the dataset.
folderName	string Name of a folder from which you want to get the dataset. If the dataset is present on the root directory, give folder name as [Root].
datasetId required	string Id of the dataset.
datasetName	string Name of the dataset.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

userParameters required	string Parameters information that needs to be updated in the dataset object. Value should be passed in JSON format. Example: [ { "name": "Parameter 1", "value": "value 1" }, { "name": "Parameter 2", "value": "value 2" } ]
action	string To replace/merge parameters info in the dataset object.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully replaced the dataset: Bu_D1",
"CODE": 0
}

Update Filter

This API is used to update the filter values for dataset's filter step.

Authorizations:

sessionIdbasicAuth

query Parameters

folderId	string Id of the folder from which you want to get dataset.
folderName	string Name of a folder from which you want to get the dataset. If the dataset is present on the root directory, give folder name as [Root].
datasetId	string Id of the dataset.
datasetName	string Name of the dataset.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

columnName	string Pass the column on which filter to apply
value	string Pass the value of the column
secondValue	string This is optional parameter which required in special case like between, in function

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully replaced dataset: RestApiTest",
"CODE": 0
}

Copy Dataset

This API is used to copy the dataset in the desired destination folder.
Note - User should provide either "sourceDatasetId" or "sourceDatasetName" and "sourceFolderName" details.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

sourceDatasetId	string Id of the dataset for which you want to create a copy. If you do not know the dataset id, use the dataset name and folder name.
sourceDatasetName	string Name of the dataset for which you want to create a copy.
sourceFolderName	string Folder name of the dataset for which you want to create a copy.
targetDatasetName required	string Name of the target dataset that you want to create.
targetFolderId	string Target folder id where you want to create the copy.
targetFolderName	string Target folder name where you want to create the copy.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Dataset copied successfully.",
"CODE": 0
}

Validate Dataset

This API is used to validate dataset design.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request value: 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 schema: application/x-www-form-urlencoded

datasetId	string Id of the dataset which you wants to get validated. If you do not know datasetId, use datasetName and folderName.
datasetName	string Name of the dataset which you wants to get validated.
folderName	string Name of the folder from which you want to validate dataset.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Dataset validated successfully",
"CODE": 200,
"VALIDATION_STATUS": "VALID"
}

Rename Dataset

This API is used to rename dataset design.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request value: 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 schema: application/x-www-form-urlencoded

datasetId	string Id of the dataset which you want to get rename. If you do not know datasetId, use datasetName and folderName.
datasetName	string Name of the dataset which you want to rename.
folderName	string Name of the folder from which you want to rename.
targetName	string Name to be which you want dataset to be renamed.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Dataset renamed successfully.",
"CODE": 200
}

Dataset Relationships

Get Dataset Relationships

This API is used to get DRD listing along with their folders.

Authorizations:

sessionIdbasicAuth

query Parameters

show	string Enum: "all" "folders" "list" Example: show=all This parameter is used to control the objects returned in the response. the response can have a list of only folders, a list of only entities, or both, based on other filters applied. The default value is 'all' all: Response list contains a combined list of folders and entities. list: Response list shows only the entity list. folders: Response list shows only the folders list.
OWNER	string This parameter filters entities by owner (the user who created that entity) name.
TAGS	string This parameter filters the entities by tags. This filter will only work if the entity has a single tag.
SEARCH_TEXT	string This parameter filters the entities by their names. All entities whose name contains the searched text are included in the result, irrespective of the case format.
MODIFIED_AFTER	string This parameter filters the entities by their last modified timestamp. All the entities modified after the provided timestamp are included in the result.
MODIFIED_BEFORE	string This parameter filters the entities by their last modified timestamp. All the entities modified before the provided timestamp are included in the result.
COUNT	number This parameter sets the number of the records displayed in the response. It is applicable only for show=list or show=folders but not with show=all.
LAST_ENTITY_NAME	string When this parameter is used, the response shows only the entities occurring after the entity name specified in this parameter. The list ignores all the entities before that.
LAST_ENTITY_ID	string When this parameter is used, the response shows only the entities occurring after the entity ID specified in this parameter. The list ignores all the entities before that.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"DATASETRELATIONSHIPS": {"DATASETRELATIONSHIP": [{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594136395,
"LAST_MODIFIED": "11/16/2022 15:52:16",
"id": "DRD_15330175283377127090074111439469",
"NAME": "History_audit"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594136446,
"LAST_MODIFIED": "11/16/2022 15:52:16",
"id": "DRD_15337270545205127081050159337782",
"NAME": "Querying_Audit"
},
{"ACCESSRIGHTS": 1,
"OWNER": "anshul.sharma",
"OWNERID": 253292788,
"LAST_MODIFIED_TIMESTAMP": 1669183684778,
"LAST_MODIFIED": "11/23/2022 11:38:04",
"id": "16691831568385127014035192989877",
"TAGS": "t1",
"NAME": "Untitled Relationship"
}
]
}
}
}

Create Dataset Relationship

This API is used to create a new DRD Object.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

drdXML

required

object

XML of a DRD Object. This XML can be generated with the help of com.kyvos.commons.entity.reportobjects.DRDObject class
For e.g.

  <IRO ID="16619387214356127036047153288694" NAME="Query Engine Details DRD copy 1" TYPE="DRD_OBJECT" SUBTYPE="" FOLDER_ID="folder_15396009522616127067071116521779" ISPUBLIC="true" FOLDER_NAME="Query Analyzer">
        <COMMON>
          <DESC>
            <![CDATA[]]>
          </DESC>
        </COMMON>
        <SPECIFIC>
          <FILTERS>
            <FILTER NAME="LAST_MODIFIED_TIMESTAMP" OPERATOR="=">
              <VALUE>
                <![CDATA[1661938834026]]>
              </VALUE>
            </FILTER>
          </FILTERS>
          <DRDOBJECT VIEW_TYPE="TABULAR" LINE_TYPE="NOODLE">
            <LAYOUT_PROPERTY>
              <PANEL_DETAILS>
                <![CDATA[{"files":{"style":{"height":451},"id":"files"},"datasets":{"style":{"height":451},"id":"datasets"},"properties":{"style":{"height":903},"id":"properties"}}]]>
              </PANEL_DETAILS>
              <COLUMN_DETAILS>
                <![CDATA[[{"panels":[],"index":0,"style":{}},{"panels":[],"index":1,"style":{"width":233.409}}]]]>
              </COLUMN_DETAILS>
            </LAYOUT_PROPERTY>
            <PANEL_PROPERTIES>
            <NODES>
              <NODE ID="15451324069223127060071132446763_2">
                <REL_DATASET ID="15451324069223127060071132446763" TYPE="">
                  <ALIAS_NAME>
                    <![CDATA[queryengine_details]]>
                  </ALIAS_NAME>
                </REL_DATASET>
              </NODE>
              <NODE ID="15337218288972127087010144746596_3">
                <REL_DATASET ID="15337218288972127087010144746596" TYPE="">
                  <ALIAS_NAME>
                    <![CDATA[Querying file]]>
                  </ALIAS_NAME>
                </REL_DATASET>
              </NODE>
            </NODES>
            <RELATIONS>
              <RELATION TYPE="ONE_TO_MANY" NODE1_ID="15337218288972127087010144746596_3" NODE2_ID="15451324069223127060071132446763_2" SOURCE_ID="15337218288972127087010144746596_3">
                <NAME>
                  <![CDATA[undefined]]>
                </NAME>
                <DESC>
                  <![CDATA[]]>
                </DESC>
                <JOIN TYPE="INNER">
                  <JOIN_BY OPERATOR="EQUAL_TO">
                    <NODE1_KEY>
                      <![CDATA[REQUEST_ID]]>
                    </NODE1_KEY>
                    <NODE2_KEY>
                      <![CDATA[sub_query_name]]>
                    </NODE2_KEY>
                  </JOIN_BY>
                </JOIN>
              </RELATION>
            </RELATIONS>
            <LAYOUT>
              <NODE ID="15451324069223127060071132446763_2" LEFT="545" TOP="176" HEIGHT="300" WIDTH="200" COLLAPSE="false">
              <NODE ID="15337218288972127087010144746596_3" LEFT="120.0078125" TOP="136.41927337646484" HEIGHT="300" WIDTH="200" COLLAPSE="false">
            </LAYOUT>
          </DRDOBJECT>
        </SPECIFIC>
      </IRO>

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully added drd object: RestApiTest",
"CODE": 0
}

Get Dataset Relationships from Folder

This API is used to get Dataset Relationship listing from a specific folder.

Authorizations:

sessionIdbasicAuth

path Parameters

folderNameOrId

required

string

Name or Id of a folder from which you want to get a list of DRD. Firstly, parameter nameOrId will be treated as Id. In case no DRD is found with that Id, then it will search for a DRD by taking nameOrId as Name

query Parameters

OWNER	string This parameter filters entities by owner (the user who created that entity) name.
TAGS	string This parameter filters the entities by tags.
SEARCH_TEXT	string This parameter filters the entities by their names. All entities whose name contains the searched text are included in the result, irrespective of the case format.
MODIFIED_AFTER	string This parameter filters the entities by their last modified timestamp. All the entities modified after the provided timestamp are included in the result.
MODIFIED_BEFORE	string This parameter filters the entities by their last modified timestamp. All the entities modified before the provided timestamp are included in the result.
COUNT	number This parameter sets the number of the records displayed in the response.
LAST_ENTITY_NAME	string When this parameter is used, the response shows only the entities occurring after the entity name specified in this parameter. The list ignores all the entities before that.
LAST_ENTITY_ID	string When this parameter is used, the response shows only the entities occurring after the entity ID specified in this parameter. The list ignores all the entities before that.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"DATASETRELATIONSHIPS": {"DATASETRELATIONSHIP": [{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594136395,
"LAST_MODIFIED": "11/16/2022 15:52:16",
"id": "DRD_15330175283377127090074111439469",
"NAME": "History_audit"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594136446,
"LAST_MODIFIED": "11/16/2022 15:52:16",
"id": "DRD_15337270545205127081050159337782",
"NAME": "Querying_Audit"
},
{"ACCESSRIGHTS": 1,
"OWNER": "anshul.sharma",
"OWNERID": 253292788,
"LAST_MODIFIED_TIMESTAMP": 1669183684778,
"LAST_MODIFIED": "11/23/2022 11:38:04",
"id": "16691831568385127014035192989877",
"TAGS": "t1",
"NAME": "Untitled Relationship"
}
]
}
}
}

Get Dataset Relationship

This API is used to get a DRD Object.

Authorizations:

sessionIdbasicAuth

query Parameters

folderNameOrId	string Name or Id of a folder from which you want to get Registered file. First, parameter folderNameOrId will be treated as Id. In case no folder is found with that Id, then it will search for a folder by taking folderNameOrId as Name
drdName	string Name of the dataset relationship of which you want to get the object.
drdId	string Id of the dataset relationship of which you want to get the object
addResponseTag	boolean Enum: true false Flag whether to wrap response in </ RESPONSE > tag or not

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"IRO": {"SUBTYPE": "",
"CATEGORY_ID": "folder_16282361609123127013094119780865",
"ACCESSRIGHTS": 1,
"FOLDER_ID": "folder_16282361609123127013094119780865",
"NAME": "BUD1_F1",
"FOLDER_NAME": "1. JPMC_TM1",
"OWNERAPPID": "15825358151067127060075128810359",
"SPECIFIC": {"DRDOBJECT": {"NODES": {"NODE": [{"ID": "15899689681320127010089161853467_3",
"REL_DATASET": {"ALIAS_NAME": "finance fact_inc_cube_build",
"ID": "15899689681320127010089161853467",
"TYPE": ""
}
},
{"ID": "15821164770238127060097115971367_3",
"REL_DATASET": {"ALIAS_NAME": "department",
"ID": "15821164770238127060097115971367",
"TYPE": ""
}
}
]
},
"RELATIONS": {"RELATION": [{"SOURCE_ID": "15821168436916127054085189816798_3",
"JOIN": {"JOIN_BY": {"NODE2_SECONDARY_KEY": "",
"OPERATOR": "EQUAL_TO",
"NODE1_KEY": "productkey",
"NODE2_KEY": "DAYNUMBEROFMONTH",
"NODE1_SECONDARY_KEY": ""
},
"TYPE": "INNER"
},
"TYPE": "ONE_TO_MANY",
"NODE1_ID": "15821168436916127054085189816798_3",
"NODE2_ID": "16412146248675127021083118653712_2",
"NAME": "undefined"
},
{"SOURCE_ID": "15894563184230127099087185270381_3",
"JOIN": {"JOIN_BY": {"NODE2_SECONDARY_KEY": "",
"OPERATOR": "EQUAL_TO",
"NODE1_KEY": "accountkey",
"NODE2_KEY": "currencykey",
"NODE1_SECONDARY_KEY": ""
},
"TYPE": "INNER"
},
"TYPE": "ONE_TO_MANY",
"NODE1_ID": "15894563184230127099087185270381_3",
"NODE2_ID": "15821166154786127015082176117651_3",
"NAME": "undefined"
}
]
},
"LAYOUT": {"NODE": [{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15899689681320127010089161853467_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15821164770238127060097115971367_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15899676796729127032054167482897_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15821166154786127015082176117651_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15821179570596127084040176656597_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15896387910864127015064198894036_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15899691897288127062051144342454_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15821164365314127030042173893868_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15821168041190127011018194282058_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15821175694067127051093161131885_3",
"HEIGHT": 300
},
{"LEFT": 106,
"TOP": 145.812,
"COLLAPSE": false,
"WIDTH": 201,
"ID": "16297055498295127036025171747958_0",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15967284189567127021038160629308_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15899692210447127047014149193780_3",
"HEIGHT": 300
},
{"LEFT": 78,
"TOP": 123.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "16412146248675127021083118653712_2",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15821171205520127021087197345644_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15821163866034127076053122354595_3",
"HEIGHT": 300
},
{"LEFT": 474,
"TOP": 118.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "16297055050147127079015181798373_1",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15821177857705127046060146935095_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15821163182138127072036116411602_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15899690098407127066099138926470_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15821203846674127032057161455912_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15821168436916127054085189816798_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15821170182379127025084131262325_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15821172402147127077045148224334_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15821203257432127071066121682943_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "16329158675251127035073190030567_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15821167288096127053016188722790_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15821171940447127029028172950754_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15821162416577127045052153465192_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15821178420849127022095180138114_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15967287626164127017046190288887_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15821169126761127078046191686909_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15899674519721127025035140125108_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15894563184230127099087185270381_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15821166918841127075092198122976_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "16324789289596127064010130685388_3",
"HEIGHT": 300
},
{"LEFT": 148,
"TOP": 205.8125,
"COLLAPSE": false,
"WIDTH": 200,
"ID": "15899680292914127055079187222327_3",
"HEIGHT": 300
}
]
},
"LINE_TYPE": "NOODLE",
"VIEW_TYPE": "TABULAR",
"PANEL_PROPERTIES": {"NODE_PANEL_SORT_DETAILS": "{\"sortOrderBy\":[\"aliasName\"],\"sortOrder\":[\"asc\"]}"
},
"LAYOUT_PROPERTY": {"COLUMN_DETAILS": "[{\"panels\":[\"properties\",\"datasets\"],\"style\":{\"width\":\"calc(var(--lg-ratio) * 256px)\",\"order\":-3}},{\"panels\":[\"files\"],\"style\":{\"width\":\"calc(var(--lg-ratio) * 280px)\",\"order\":-2}}]",
"PANEL_DETAILS": "{\"files\":{\"style\":{\"height\":526},\"id\":\"files\"},\"datasets\":{\"style\":{\"height\":263},\"id\":\"datasets\"},\"properties\":{\"style\":{\"height\":263},\"id\":\"properties\"}}"
}
}
},
"REPOSITDATE": "06/21/2022 16:11:14",
"ISPUBLIC": true,
"COMMON": {"DESC": ""
},
"LINKED_ENTITY_ID": "",
"ID": "16315302763394127016066152442810",
"OWNERAPPNAME": "-",
"TYPE": "DRD_OBJECT"
}
}
}

Update Dataset Relationship

This API is used to update an existing DRD.

Authorizations:

sessionIdbasicAuth

path Parameters

nameOrId

required

string

Name or Id of DRD. Firstly, parameter nameOrId will be treated as Id. In case no DRD is found with that Id, then it will search for a DRD by taking nameOrId as Name. In case of nameOrId as Name, folderNameOrId is used

query Parameters

folderNameOrId

string

Name or Id of a folder from which you want to get DRD. Firstly, parameter folderNameOrId will be treated as Id. In case no folder is found with that Id, then it will search for a folder by taking folderNameOrId as Name

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

drdXML

required

string

XML of a DRD Object. This XML can be generated with the help of com.kyvos.commons.entity.reportobjects.DRDObject class
For e.g.

  <IRO ID="16619387214356127036047153288694" NAME="Query Engine Details DRD copy 1" TYPE="DRD_OBJECT" SUBTYPE="" FOLDER_ID="folder_15396009522616127067071116521779" ISPUBLIC="true" FOLDER_NAME="Query Analyzer">
        <COMMON>
          <DESC>
            <![CDATA[]]>
          </DESC>
        </COMMON>
        <SPECIFIC>
          <FILTERS>
            <FILTER NAME="LAST_MODIFIED_TIMESTAMP" OPERATOR="=">
              <VALUE>
                <![CDATA[1661938834026]]>
              </VALUE>
            </FILTER>
          </FILTERS>
          <DRDOBJECT VIEW_TYPE="TABULAR" LINE_TYPE="NOODLE">
            <LAYOUT_PROPERTY>
              <PANEL_DETAILS>
                <![CDATA[{"files":{"style":{"height":451},"id":"files"},"datasets":{"style":{"height":451},"id":"datasets"},"properties":{"style":{"height":903},"id":"properties"}}]]>
              </PANEL_DETAILS>
              <COLUMN_DETAILS>
                <![CDATA[[{"panels":[],"index":0,"style":{}},{"panels":[],"index":1,"style":{"width":233.409}}]]]>
              </COLUMN_DETAILS>
            </LAYOUT_PROPERTY>
            <PANEL_PROPERTIES>
            <NODES>
              <NODE ID="15451324069223127060071132446763_2">
                <REL_DATASET ID="15451324069223127060071132446763" TYPE="">
                  <ALIAS_NAME>
                    <![CDATA[queryengine_details]]>
                  </ALIAS_NAME>
                </REL_DATASET>
              </NODE>
              <NODE ID="15337218288972127087010144746596_3">
                <REL_DATASET ID="15337218288972127087010144746596" TYPE="">
                  <ALIAS_NAME>
                    <![CDATA[Querying file]]>
                  </ALIAS_NAME>
                </REL_DATASET>
              </NODE>
            </NODES>
            <RELATIONS>
              <RELATION TYPE="ONE_TO_MANY" NODE1_ID="15337218288972127087010144746596_3" NODE2_ID="15451324069223127060071132446763_2" SOURCE_ID="15337218288972127087010144746596_3">
                <NAME>
                  <![CDATA[undefined]]>
                </NAME>
                <DESC>
                  <![CDATA[]]>
                </DESC>
                <JOIN TYPE="INNER">
                  <JOIN_BY OPERATOR="EQUAL_TO">
                    <NODE1_KEY>
                      <![CDATA[REQUEST_ID]]>
                    </NODE1_KEY>
                    <NODE2_KEY>
                      <![CDATA[sub_query_name]]>
                    </NODE2_KEY>
                  </JOIN_BY>
                </JOIN>
              </RELATION>
            </RELATIONS>
            <LAYOUT>
              <NODE ID="15451324069223127060071132446763_2" LEFT="545" TOP="176" HEIGHT="300" WIDTH="200" COLLAPSE="false">
              <NODE ID="15337218288972127087010144746596_3" LEFT="120.0078125" TOP="136.41927337646484" HEIGHT="300" WIDTH="200" COLLAPSE="false">
            </LAYOUT>
          </DRDOBJECT>
        </SPECIFIC>
      </IRO>

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully replaced drd object: RestApiTest",
"CODE": 0
}

Delete Dataset Relationship

This API is used to delete an existing DRD.

Authorizations:

sessionIdbasicAuth

query Parameters

folderName	string Folder Name of the dataset relationship of which you want to get the object
folderId	string Folder Id of the dataset relationship of which you want to get the object
drdName	string Name of the dataset relationship of which you want to delete the object.
drdId	string Id of the dataset relationship of which you want to delete the object

header Parameters

sessionid

string

The session Id is the token received from the login API.
Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully deleted drd object: RestApiTest",
"CODE": 0
}

Save Dataset Relationship

This API is used to add/update the DRD entity with the given entity XML. As this API performs bulk operation, you must have privileges to import and export objects to use this API.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

drdXML

required

string

XML of a DRD Object. This XML can be generated with the help of com.kyvos.commons.entity.reportobjects.DRDObject class
For e.g.

  </IROS><IRO ID="16619387214356127036047153288694" NAME="Query Engine Details DRD copy 1" TYPE="DRD_OBJECT" SUBTYPE="" FOLDER_ID="folder_15396009522616127067071116521779" ISPUBLIC="true" FOLDER_NAME="Query Analyzer">
        <COMMON>
          <DESC>
            <![CDATA[]]>
          </DESC>
        </COMMON>
        <SPECIFIC>
          <FILTERS>
            <FILTER NAME="LAST_MODIFIED_TIMESTAMP" OPERATOR="=">
              <VALUE>
                <![CDATA[1661938834026]]>
              </VALUE>
            </FILTER>
          </FILTERS>
          <DRDOBJECT VIEW_TYPE="TABULAR" LINE_TYPE="NOODLE">
            <LAYOUT_PROPERTY>
              <PANEL_DETAILS>
                <![CDATA[{"files":{"style":{"height":451},"id":"files"},"datasets":{"style":{"height":451},"id":"datasets"},"properties":{"style":{"height":903},"id":"properties"}}]]>
              </PANEL_DETAILS>
              <COLUMN_DETAILS>
                <![CDATA[[{"panels":[],"index":0,"style":{}},{"panels":[],"index":1,"style":{"width":233.409}}]]]>
              </COLUMN_DETAILS>
            </LAYOUT_PROPERTY>
            <PANEL_PROPERTIES>
            <NODES>
              <NODE ID="15451324069223127060071132446763_2">
                <REL_DATASET ID="15451324069223127060071132446763" TYPE="">
                  <ALIAS_NAME>
                    <![CDATA[queryengine_details]]>
                  </ALIAS_NAME>
                </REL_DATASET>
              </NODE>
              <NODE ID="15337218288972127087010144746596_3">
                <REL_DATASET ID="15337218288972127087010144746596" TYPE="">
                  <ALIAS_NAME>
                    <![CDATA[Querying file]]>
                  </ALIAS_NAME>
                </REL_DATASET>
              </NODE>
            </NODES>
            <RELATIONS>
              <RELATION TYPE="ONE_TO_MANY" NODE1_ID="15337218288972127087010144746596_3" NODE2_ID="15451324069223127060071132446763_2" SOURCE_ID="15337218288972127087010144746596_3">
                <NAME>
                  <![CDATA[undefined]]>
                </NAME>
                <DESC>
                  <![CDATA[]]>
                </DESC>
                <JOIN TYPE="INNER">
                  <JOIN_BY OPERATOR="EQUAL_TO">
                    <NODE1_KEY>
                      <![CDATA[REQUEST_ID]]>
                    </NODE1_KEY>
                    <NODE2_KEY>
                      <![CDATA[sub_query_name]]>
                    </NODE2_KEY>
                  </JOIN_BY>
                </JOIN>
              </RELATION>
            </RELATIONS>
            <LAYOUT>
              <NODE ID="15451324069223127060071132446763_2" LEFT="545" TOP="176" HEIGHT="300" WIDTH="200" COLLAPSE="false">
              <NODE ID="15337218288972127087010144746596_3" LEFT="120.0078125" TOP="136.41927337646484" HEIGHT="300" WIDTH="200" COLLAPSE="false">
            </LAYOUT>
          </DRDOBJECT>
        </SPECIFIC>
      </IRO>
    </IROS>

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"RES": [{"MESSAGE": "Successfully added drd object: RestTest1",
"CODE": 0
},
{"MESSAGE": "Successfully added drd object: RestTest2",
"CODE": 0
}
]
}
}

Copy Dataset Relationship

This API is used to copy the dataset relationship in the desired destination folder.
Note - User should provide either "sourceDatasetRelationshipId" or "sourceDatasetRelationshipName" and "sourceFolderName" details.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

sourceDatasetRelationshipId	string Id of the dataset relationship for which you want to create a copy. If you do not know the dataset relationship id, use the dataset relationship name and folder name.
sourceDatasetRelationshipName	string Name of the dataset relationship for which you want to create a copy.
sourceFolderName	string Folder name of the dataset relationship for which you want to create a copy.
targetDatasetRelationshipName required	string Name of the target dataset relationship that you want to create.
targetFolderId	string Target folder id where you want to create the copy.
targetFolderName	string Target folder name where you want to create the copy.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "DRD copied successfully.",
"CODE": 0
}

Update properties of Dataset Relationship Deprecated

This API is used to update one or more properties of the dataset relationship. For example DESCRIPTION property, TAGS property etc.
Note: User should provide either "datasetRelationshipId" or "datasetRelationshipName" and "folderName" details.

Note: This API has been deprecated. Please refer alternate API /datasetrelationship/entityProperties.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

datasetRelationshipId	string Id of the dataset relationship for which you want to update properties. If you do not know the dataset relationship id, use the dataset relationship name and folder name.
datasetRelationshipName	string Name of the dataset relationship for which you want to update properties.
folderName	string Folder name of the dataset relationship for which you want to update properties.
propertyJSON required	object JSON containing an array of property name and their values. For e.g. [ { "name": "DESCRIPTION", "value": "description" }, { "name": "TAGS" "value": "tag" } ]

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully updated properties of the dataset relationship.",
"CODE": 0
}

Update properties of Dataset Relationship

This API is used to update one or more properties of the dataset relationship. For example DESCRIPTION property, TAGS property etc.
Note: User should provide either "datasetRelationshipId" or "datasetRelationshipName" and "folderName" details.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

datasetRelationshipId	string Id of the dataset relationship for which you want to update properties. If you do not know the dataset relationship id, use the dataset relationship name and folder name.
datasetRelationshipName	string Name of the dataset relationship for which you want to update properties.
folderName	string Folder name of the dataset relationship for which you want to update properties.
propertyJSON required	object JSON containing an array of property name and their values. For e.g. [ { "name": "DESCRIPTION", "value": "description" }, { "name": "TAGS" "value": "tag" } ]

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully updated properties of the dataset relationship.",
"CODE": 0
}

Validate Dataset Relationship

This API is used to validate relationship design.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

drdId	string Id of the drd which you wants to get validated. If you do not know the drdId, use drdName and folderName.
drdName	string Name of drd which you wants to get validated.
folderName	string Name of the folder from which you want to validate drd.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "DRD validated successfully",
"CODE": 200,
"VALIDATION_STATUS": "VALID"
}

Rename Dataset Relationship

This API is used to rename relationship design.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

drdId	string Id of the drd which you want to rename. If you do not know the drdId, use drdName and folderName.
drdName	string Name of drd which you want to get rename.
folderName	string Name of the folder from which you want to validate drd.
targetName	string Name to which you want to rename drd.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "DRD renamed successfully.",
"CODE": 200
}

Semantic Models

Semantic models were previously referred to as cubes.

Get Semantic Models

This API is used to get a list of the semantic models along with the corresponding folders.

Authorizations:

sessionIdbasicAuth

query Parameters

fetchProcessedStatus	string Enum: true false Example: fetchProcessedStatus=false
show	string Enum: "all" "folders" "list" Example: show=all This parameter is used to control the objects returned in the response. The response can have a list of only folders, a list of only entities, or both, based on other filters applied. The default value is 'all' all: Response list contains a combined list of folders and entities. list: Response list shows only the entity list. folders: Response list shows only the folders list.
OWNER	string This parameter filters entities by owner (the user who created that entity) name.
TAGS	string This parameter filters the entities by tags. This filter will only work if the entity has a single tag.
SEARCH_TEXT	string This parameter filters the entities by their names. All entities whose name contains the searched text are included in the result, irrespective of the case format.
MODIFIED_AFTER	string This parameter filters the entities by their last modified timestamp. All the entities modified after the provided timestamp are included in the result.
MODIFIED_BEFORE	string This parameter filters the entities by their last modified timestamp. All the entities modified before the provided timestamp are included in the result.
COUNT	number This parameter sets the number of the records displayed in the response. It is applicable only for show=list or show=folders but not with show=all.
LAST_ENTITY_NAME	string When this parameter is used, the response shows only the entities occurring after the entity name specified in this parameter. The list ignores all the entities before that.
LAST_ENTITY_ID	string When this parameter is used, the response shows only the entities occurring after the entity ID specified in this parameter. The list ignores all the entities before that.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"CUBES": {"CUBE": [{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594136670,
"LAST_MODIFIED": "11/16/2022 15:52:16",
"id": "15336348064443127075025127247531",
"NAME": "History Audit cube"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594136964,
"LAST_MODIFIED": "11/16/2022 15:52:16",
"id": "CUBE_OBJECT_15337271008344127081028174162622",
"NAME": "Querying Audit"
},
{"ACCESSRIGHTS": 1,
"OWNER": "anshul.sharma",
"OWNERID": 253292788,
"LAST_MODIFIED_TIMESTAMP": 1669563712115,
"LAST_MODIFIED": "11/27/2022 21:11:52",
"id": "CUBE_OBJECT_16695639511453127095042179066816",
"NAME": "Untitled Cube"
}
]
}
}
}

Create Semantic Model

This API is used to create a new Semantic Model Object.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

smodelXML

required

object

XML of a semantic model object. This XML can be generated with the help of com.kyvos.commons.entity.reportobjects.CubeObject class.
For e.g.

  <IRO ID="15452933458461127071083153170947" NAME="Historical Field Details" TYPE="ANALYTICAL" SUBTYPE="CUBE" FOLDER_ID="folder_15396014106428127088047133277741" FOLDER_NAME="Query Analyzer" ISPUBLIC="">
  <COMMON>
    <DESC>
      <![CDATA[]]>
    </DESC>
    <COMPATIBILITY_VERSION>
      <![CDATA[1]]>
    </COMPATIBILITY_VERSION>
  </COMMON>
  <SPECIFIC>
    <ATTRS>
      <ATTR NAME="CUBEUNIQUENAME">
        <VALUE>
          <![CDATA[15452933458461127071083153170947]]>
        </VALUE>
      </ATTR>
    </ATTRS>
    <CUBEOBJECT>
      <LAYOUT_PROPERTY>
        <PANEL_DETAILS>
          <![CDATA[{"filters":{"style":{"height":-5},"id":"filters"},"properties":{"style":{"height":94},"id":"properties"},"sourceFields":{"id":"sourceFields","style":{"height":89}}}]]>
        </PANEL_DETAILS>
        <COLUMN_DETAILS>
          <![CDATA[[{"style":{},"panels":["sourceFields"]},{"index":0,"style":{"width":293.326},"panels":[]},{"index":1,"style":{}}]]]>
        </COLUMN_DETAILS>
      </LAYOUT_PROPERTY>
      <SLIDING_WINDOWS>
      <AGGREGATION_STRATEGY TYPE="CONFIGURATION_DRIVEN" >
        <CONFIGURATION_DRIVEN>
          <ENTITY_PROPS_VALUES>
            <PROPERTY>
              <NAME>
                <![CDATA[kyvos.build.precompute.level.threshold]]>
              </NAME>
              <VALUE>
                <![CDATA[]]>
              </VALUE>
              <MODE>
                <![CDATA[DEFAULT]]>
              </MODE>
            </PROPERTY>
            <PROPERTY>
              <NAME>
                <![CDATA[kyvos.build.dimensions.materialize]]>
              </NAME>
              <VALUE>
                <![CDATA[]]>
              </VALUE>
              <MODE>
                <![CDATA[DEFAULT]]>
              </MODE>
            </PROPERTY>
            <PROPERTY>
              <NAME>
                <![CDATA[kyvos.build.precompute.degree]]>
              </NAME>
              <VALUE>
                <![CDATA[]]>
              </VALUE>
              <MODE>
                <![CDATA[DEFAULT]]>
              </MODE>
            </PROPERTY>
            <PROPERTY>
              <NAME>
                <![CDATA[kyvos.build.precompute.hierarchy.levels]]>
              </NAME>
              <VALUE>
                <![CDATA[]]>
              </VALUE>
              <MODE>
                <![CDATA[DEFAULT]]>
              </MODE>
            </PROPERTY>
          </ENTITY_PROPS_VALUES>
        </CONFIGURATION_DRIVEN>
      </AGGREGATION_STRATEGY>
      <DIMENSIONS>
        <DIMENSION ID="Dim_Measures" RESTRICT="false" RESTRICTVALUES="false">
          <NAME>
            <![CDATA[Measures]]>
          </NAME>
          <UNIQUENAME>
            <![CDATA[Measures]]>
          </UNIQUENAME>
          <TYPE>
            <![CDATA[MEASURE]]>
          </TYPE>
          <DEFAULTHIERARCHYUNIQUENAME>
            <![CDATA[Measures]]>
          </DEFAULTHIERARCHYUNIQUENAME>
          <HIERARCHIES>
            <HIERARCHY HASALL="false">
              <UNIQUENAME>
                <![CDATA[Measures]]>
              </UNIQUENAME>
              <ALLMEMBERUNIQUENAME />/n
              <LEVELS>
                <LEVEL DATATYPE="Regular">
                  <UNIQUENAME>
                    <![CDATA[MeasuresLevel]]>
                  </UNIQUENAME>
                  <DATAFIELD />
                  <PROPERTIES />
                </LEVEL>
              </LEVELS>
            </HIERARCHY>
          </HIERARCHIES>
          <ATTRS>
            <ATTR DATATYPE="">
              <UNIQUENAME>
                <![CDATA[Attribute]]>
              </UNIQUENAME>
              <NAME>
                <![CDATA[Attribute]]>
              </NAME>
              <DATAFIELD />
            </ATTR>
          </ATTRS>
        </DIMENSION>
      </DIMENSIONS>
      <MEASURE_GROUPS>
        <MEASURE_GROUP NAME="Measure Group" ISVISIBLE="true" MATERIALIZE="">
          <DESCRIPTION>
            <![CDATA[]]>
          </DESCRIPTION>
          <MEASURE_ID>
            <![CDATA[MEASURE_34820]]>
          </MEASURE_ID>
        </MEASURE_GROUP>
      </MEASURE_GROUPS>
      <MEASURES>
        <MEASURE ID="MEASURE_34820" DATATYPE="NUMBER" ISDEFAULT="true" ISVISIBLE="true" SOLVE_ORDER="0" DISPLAY_FOLDER="" MATERIALIZE="">
          <UNIQUENAME>
            <![CDATA[MEASURE_34820]]>
          </UNIQUENAME>
          <NAME>
            <![CDATA[Query Count]]>
          </NAME>
          <FORMAT USEDEFAULT="0">
            <![CDATA[#,##0]]>
          </FORMAT>
          <FORMATTYPE>
            <![CDATA[2]]>
          </FORMATTYPE>
          <UNIT>
            <![CDATA[]]>
          </UNIT>
          <DATAFIELD QUERY_NAME="field_details" QUERY_ID="15451326173844127065091156882788_0">
            <![CDATA[field_used_count]]>
          </DATAFIELD>
          <EXPRESSION NON_EMPTY_BEHAVIOR="BY_MEASURE">
            <![CDATA[]]>
          </EXPRESSION>
          <DESCRIPTION>
            <![CDATA[]]>
          </DESCRIPTION>
          <SUMMARYFUNCTION>
            <![CDATA[0]]>
          </SUMMARYFUNCTION>
        </MEASURE>
      </MEASURES>
    </CUBEOBJECT>
  </SPECIFIC>
</IRO>

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully added semantic model object: RestApiTest",
"CODE": 0
}

Get Semantic Models From Folder

This API is used to get semantic model listing from a specific folder.

Authorizations:

sessionIdbasicAuth

path Parameters

folderNameOrId

required

string

Name or Id of a folder from which you want to get a list of semantic model objects. Firstly, parameter folderNameOrId will be treated as Id. In case no semantic model object is found with that Id, then it will search for a semantic model object by taking folderNameOrId as Name.

query Parameters

fetchProcessedStatus	string Default: false Enum: true false Example: fetchProcessedStatus=false Include status of last job.
OWNER	string This parameter filters entities by owner (the user who created that entity) name.
TAGS	string This parameter filters the entities by tags.
SEARCH_TEXT	string This parameter filters the entities by their names. All entities whose name contains the searched text are included in the result, irrespective of the case format.
MODIFIED_AFTER	string This parameter filters the entities by their last modified timestamp. All the entities modified after the provided timestamp are included in the result.
MODIFIED_BEFORE	string This parameter filters the entities by their last modified timestamp. All the entities modified before the provided timestamp are included in the result.
COUNT	number This parameter sets the number of the records displayed in the response.
LAST_ENTITY_NAME	string When this parameter is used, the response shows only the entities occurring after the entity name specified in this parameter. The list ignores all the entities before that.
LAST_ENTITY_ID	string When this parameter is used, the response shows only the entities occurring after the entity ID specified in this parameter. The list ignores all the entities before that.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"CUBES": {"CUBE": [{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594136670,
"LAST_MODIFIED": "11/16/2022 15:52:16",
"id": "15336348064443127075025127247531",
"NAME": "History Audit cube"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594136964,
"LAST_MODIFIED": "11/16/2022 15:52:16",
"id": "CUBE_OBJECT_15337271008344127081028174162622",
"NAME": "Querying Audit"
},
{"ACCESSRIGHTS": 1,
"OWNER": "anshul.sharma",
"OWNERID": 253292788,
"LAST_MODIFIED_TIMESTAMP": 1669563712115,
"LAST_MODIFIED": "11/27/2022 21:11:52",
"id": "CUBE_OBJECT_16695639511453127095042179066816",
"NAME": "Untitled Cube"
}
]
}
}
}

Save Semantic Model

This API is used to add/update semantic model entity with given entity XML. As this API performs bulk operation, you must have privileges to import and export objects to use this API.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

smodelXML

required

object

XML of the semantic model entity to be saved.

For e.g.

  <IROS>
    <IRO ID="CUBE_OBJECT_16619426349350127042065120488280" NAME="RestAPITestCube" TYPE="ANALYTICAL" SUBTYPE="CUBE" FOLDER_ID="" FOLDER_NAME="" ISPUBLIC="">
        <COMMON>
          <DESC>
            <![CDATA[]]>
          </DESC>
          <COMPATIBILITY_VERSION>
            <![CDATA[2]]>
          </COMPATIBILITY_VERSION>
        </COMMON>
        <SPECIFIC>
          <ATTRS>
            <ATTR NAME="CUBEUNIQUENAME">
              <VALUE>
                <![CDATA[CUBE_OBJECT_16619426349350127042065120488280]]>
              </VALUE>
            </ATTR>
          </ATTRS>
          <CUBEOBJECT>
            <SLIDING_WINDOWS>
            <AGGREGATION_STRATEGY TYPE="CONFIGURATION_DRIVEN" >
              <CONFIGURATION_DRIVEN>
                <ENTITY_PROPS_VALUES>
              </CONFIGURATION_DRIVEN>
            </AGGREGATION_STRATEGY>
            <DIMENSIONS>
              <DIMENSION ID="Dim_Measures" RESTRICT="false" RESTRICTVALUES="false">
                <NAME>
                  <![CDATA[Measures]]>
                </NAME>
                <UNIQUENAME>
                  <![CDATA[Measures]]>
                </UNIQUENAME>
                <TYPE>
                  <![CDATA[MEASURE]]>
                </TYPE>
                <DEFAULTHIERARCHYUNIQUENAME>
                  <![CDATA[Measures]]>
                </DEFAULTHIERARCHYUNIQUENAME>
                <HIERARCHIES>
                  <HIERARCHY HASALL="false">
                    <UNIQUENAME>
                      <![CDATA[Measures]]>
                    </UNIQUENAME>
                    <ALLMEMBERUNIQUENAME />/n
                    <LEVELS>
                      <LEVEL DATATYPE="Regular">
                        <UNIQUENAME>
                          <![CDATA[MeasuresLevel]]>
                        </UNIQUENAME>
                        <DATAFIELD />
                        <PROPERTIES />
                      </LEVEL>
                    </LEVELS>
                  </HIERARCHY>
                </HIERARCHIES>
                <ATTRS>
                  <ATTR DATATYPE="">
                    <UNIQUENAME>
                      <![CDATA[Attribute]]>
                    </UNIQUENAME>
                    <NAME>
                      <![CDATA[Attribute]]>
                    </NAME>
                    <DATAFIELD />
                  </ATTR>
                </ATTRS>
              </DIMENSION>
              <DIMENSION ID="DIM_809312" ISVISIBLE="true" MATERIALIZE="">
                <UNIQUENAME>
                  <![CDATA[DIM_809312]]>
                </UNIQUENAME>
                <NAME>
                  <![CDATA[field_details]]>
                </NAME>
                <TYPE>
                  <![CDATA[Regular]]>
                </TYPE>
                <DESCRIPTION>
                  <![CDATA[]]>
                </DESCRIPTION>
                <HIERARCHIES>
                <ATTRS>
                  <ATTR DATATYPE="CHAR" DISPLAY_FOLDER="" ISVISIBLE="true"  MATERIALIZE="">
                    <UNIQUENAME>
                      <![CDATA[DIMENSION_ATTRIBUTE_580323]]>
                    </UNIQUENAME>
                    <NAME>
                      <![CDATA[query_id]]>
                    </NAME>
                    <DATAFIELD QUERY_NAME="field_details" QUERY_ID="15451326173844127065091156882788_0">
                      <![CDATA[query_id]]>
                    </DATAFIELD>
                    <DISPLAYFIELD QUERY_NAME="" QUERY_ID="">
                      <![CDATA[]]>
                    </DISPLAYFIELD>
                    <DATEDATATYPE>
                      <![CDATA[]]>
                    </DATEDATATYPE>
                    <FIELDDATATYPE>
                      <![CDATA[]]>
                    </FIELDDATATYPE>
                    <GEOROLE>
                      <![CDATA[]]>
                    </GEOROLE>
                    <MAPLEVEL>
                      <![CDATA[]]>
                    </MAPLEVEL>
                    <TYPE>
                      <![CDATA[Regular]]>
                    </TYPE>
                    <HASTIMEINDATEFORMAT>
                      <![CDATA[false]]>
                    </HASTIMEINDATEFORMAT>
                    <DESCRIPTION>
                      <![CDATA[]]>
                    </DESCRIPTION>
                  </ATTR>
                </ATTRS>
                <CALC_MEMBERS>
                <SCD TYPE="2">
              </DIMENSION>
            </DIMENSIONS>
            <MEASURE_GROUPS>
              <MEASURE_GROUP NAME="field_details" ISVISIBLE="true" MATERIALIZE="">
                <DESCRIPTION>
                  <![CDATA[]]>
                </DESCRIPTION>
                <MEASURE_ID>
                  <![CDATA[MEASURE_527054]]>
                </MEASURE_ID>
              </MEASURE_GROUP>
            </MEASURE_GROUPS>
            <MEASURES>
              <MEASURE ID="MEASURE_527054" DATATYPE="NUMBER" ISDEFAULT="true" ISVISIBLE="true" SOLVE_ORDER="0" DISPLAY_FOLDER="" MATERIALIZE="">
                <UNIQUENAME>
                  <![CDATA[MEASURE_527054]]>
                </UNIQUENAME>
                <NAME>
                  <![CDATA[field_used_count]]>
                </NAME>
                <FORMAT USEDEFAULT="0">
                  <![CDATA[#,##0.00]]>
                </FORMAT>
                <FORMATTYPE>
                  <![CDATA[2]]>
                </FORMATTYPE>
                <UNIT>
                  <![CDATA[]]>
                </UNIT>
                <DATAFIELD QUERY_NAME="field_details" QUERY_ID="15451326173844127065091156882788_0">
                  <![CDATA[field_used_count]]>
                </DATAFIELD>
                <EXPRESSION NON_EMPTY_BEHAVIOR="BY_MEASURE">
                  <![CDATA[]]>
                </EXPRESSION>
                <DESCRIPTION>
                  <![CDATA[]]>
                </DESCRIPTION>
                <SUMMARYFUNCTION>
                  <![CDATA[0]]>
                </SUMMARYFUNCTION>
              </MEASURE>
            </MEASURES>
          </CUBEOBJECT>
        </SPECIFIC>
      </IRO>
    </IROS>

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"RES": [{"MESSAGE": "Successfully added semantic model object: RestTest1",
"CODE": 0
},
{"MESSAGE": "Successfully added semantic model object: RestTest2",
"CODE": 0
}
]
}
}

Get Semantic Model Object

This API is used to get Semantic Model Object.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model of which you want to get the object.If you do not know the smodelId, use the smodelName and folderName/folderId.
smodelName	string Name of the semantic model of which you want to get the object
folderId	string Folder id of the semantic model of which you want to get the object
folderName	string Folder name of the semantic model of which you want to get the object
addResponseTag	string Flag whether to wrap response in <RESPONSE> tag or not.

header Parameters

Accept	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/xml

<RESPONSE>
  <IRO ID="38C64DDA-4117-BB6F-A257-628777431843" NAME="Charter_Recommend_1" TYPE="ANALYTICAL" SUBTYPE="CUBE" CATEGORY_ID="" FOLDER_NAME="" FOLDER_ID=""  ACCESSRIGHTS="1" OWNERAPPID="Admin" OWNERAPPNAME="Admin" REPOSITDATE="06/06/2022 13:18:18" LINKED_ENTITY_ID="" ISPUBLIC="true">
    <COMMON>
      <DESC><![CDATA[]]></DESC>
      <COMPATIBILITY_VERSION><![CDATA[2]]></COMPATIBILITY_VERSION>
    </COMMON>
    <SPECIFIC>
      <ATTRS>
        <ATTR NAME="CUBEUNIQUENAME">
          <VALUE><![CDATA[]]></VALUE>
        </ATTR>
        <ATTR NAME="CONNECTION_NAME">
          <VALUE><![CDATA[]]></VALUE>
        </ATTR>
        <ATTR NAME="ISBOUND">
          <VALUE><![CDATA[false]]></VALUE>
        </ATTR>
        <ATTR NAME="RAW_DATA_QUERYING">
          <VALUE><![CDATA[0]]></VALUE>
        </ATTR>
        <ATTR NAME="DRD_ID">
          <VALUE><![CDATA[16540883111223127054086148794694]]></VALUE>
        </ATTR>
        <ATTR NAME="DRD_NAME">
          <VALUE><![CDATA[Charter1]]></VALUE>
        </ATTR>
        <ATTR NAME="CO_TYPE">
          <VALUE><![CDATA[INTERNAL]]></VALUE>
        </ATTR>
      </ATTRS>
      <COMMON>
        <DESC><![CDATA[]]></DESC>
        <COMPATIBILITY_VERSION><![CDATA[2]]></COMPATIBILITY_VERSION>
      </COMMON>
      <CUBEOBJECT VIEW_TYPE="">
        <LAYOUT_PROPERTY>
          <COLUMN_DETAILS><![CDATA[[{"panels":[],"style":{}},{"panels":[],"style":{}}]]]></COLUMN_DETAILS>
          <PANEL_DETAILS><![CDATA[{"sourceFields":{"style":{},"id":"sourceFields"},"filters":{"style":{},"id":"filters"},"properties":{"style":{},"id":"properties"}}]]></PANEL_DETAILS>
        </LAYOUT_PROPERTY>
        <SLIDING_WINDOWS>
        </SLIDING_WINDOWS>
        <AGGREGATION_STRATEGY TYPE="CONFIGURATION_DRIVEN">
          <CONFIGURATION_DRIVEN>
            <ENTITY_PROPS_VALUES>
              <PROPERTY>
                <NAME><![CDATA[kyvos.build.precompute.level.threshold]]></NAME>
                <VALUE><![CDATA[]]></VALUE>
                <MODE><![CDATA[DEFAULT]]></MODE>
              </PROPERTY>
              <PROPERTY>
                <NAME><![CDATA[kyvos.build.dimensions.materialize]]></NAME>
                <VALUE><![CDATA[]]></VALUE>
                <MODE><![CDATA[DEFAULT]]></MODE>
              </PROPERTY>
              <PROPERTY>
                <NAME><![CDATA[kyvos.build.precompute.degree]]></NAME>
                <VALUE><![CDATA[]]></VALUE>
                <MODE><![CDATA[DEFAULT]]></MODE>
              </PROPERTY>
              <PROPERTY>
                <NAME><![CDATA[kyvos.build.precompute.hierarchy.levels]]></NAME>
                <VALUE><![CDATA[]]></VALUE>
                <MODE><![CDATA[DEFAULT]]></MODE>
              </PROPERTY>
            </ENTITY_PROPS_VALUES>
          </CONFIGURATION_DRIVEN>
        </AGGREGATION_STRATEGY>
        <DIMENSIONS>
          <DIMENSION ID="Dim_Measures" DIM_TO_FACT_MAPPING="ONE_TO_MANY" RESTRICT="false" RESTRICTVALUES="false" IS_ACCESSIBLE="true" ISVISIBLE="true" MATERIALIZE="" CUBE_VIEW_TYPE="">
            <INCREMENTAL_UPDATE_PROPERTIES PROCESSING_MODE="1">
            </INCREMENTAL_UPDATE_PROPERTIES>
            <UNIQUENAME><![CDATA[Measures]]></UNIQUENAME>
            <NAME><![CDATA[Measures]]></NAME>
            <TYPE><![CDATA[MEASURE]]></TYPE>
            <PREDEF_TIME_HIERARCHY><![CDATA[]]></PREDEF_TIME_HIERARCHY>
            <DATAFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DATAFIELD>
            <DEFAULTHIERARCHYUNIQUENAME><![CDATA[Measures]]></DEFAULTHIERARCHYUNIQUENAME>
            <DESCRIPTION><![CDATA[]]></DESCRIPTION>
            <DATASOURCES>
            </DATASOURCES>
            <HIERARCHIES>
              <HIERARCHY HASALL="false" ISVISIBLE="true" ISDEFAULT="false" IS_CUSTOMCALENDAR="false" HAS_ALTERNATE_PATH="false" HAS_PARENTCHILD_RELATION="false" PC_LEVEL_COUNT="-1" IS_ACCESSIBLE="true" CUBE_VIEW_TYPE="" MATERIALIZE="">
                <UNIQUENAME><![CDATA[Measures]]></UNIQUENAME>
                <NAME><![CDATA[]]></NAME>
                <DEFAULTMEMBERUNIQUENAME><![CDATA[]]></DEFAULTMEMBERUNIQUENAME>
                <ALLMEMBERUNIQUENAME><![CDATA[]]></ALLMEMBERUNIQUENAME>
                <PREDEF_TIME_HIERARCHY><![CDATA[]]></PREDEF_TIME_HIERARCHY>
                <DATAFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DATAFIELD>
                <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                <LEVELS>
                  <LEVEL DATATYPE="Regular"  ISALL="false" SHOW_VALUES="0" MAPTYPE ="" IS_ACCESSIBLE="true" ISVISIBLE="true" IS_DELETED="false" HIDE_MEMBER="0" MATERIALIZE="">
                    <UNIQUENAME><![CDATA[MeasuresLevel]]></UNIQUENAME>
                    <NAME><![CDATA[]]></NAME>
                    <MEMBER_PROPERTIES>
                    </MEMBER_PROPERTIES>
                    <FULLY_QUALIFIED_NAME><![CDATA[]]></FULLY_QUALIFIED_NAME>
                    <DATEDATATYPE><![CDATA[]]></DATEDATATYPE>
                    <FIELDDATATYPE><![CDATA[]]></FIELDDATATYPE>
                    <SUBDATATYPE><![CDATA[]]></SUBDATATYPE>
                    <DISPLAYFIELDDATATYPE><![CDATA[]]></DISPLAYFIELDDATATYPE>
                    <GEOROLE><![CDATA[]]></GEOROLE>
                    <MAPLEVEL><![CDATA[]]></MAPLEVEL>
                    <DATAFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DATAFIELD>
                    <PARENTFIELD QUERY_NAME="" QUERY_ID="" DATA_TYPE=""><![CDATA[]]></PARENTFIELD>
                    <DISPLAYFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DISPLAYFIELD>
                    <HASTIMEINDATEFORMAT><![CDATA[false]]></HASTIMEINDATEFORMAT>
                    <DATEFORMAT><![CDATA[]]></DATEFORMAT>
                    <FORMATTYPE><![CDATA[]]></FORMATTYPE>
                    <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                    <PROPERTIES>
                    </PROPERTIES>
                  </LEVEL>
                </LEVELS>
              </HIERARCHY>
            </HIERARCHIES>
            <ATTRS>
              <ATTR DATATYPE="" IS_ACCESSIBLE="true" ISVISIBLE="true" IS_DELETED="false" DISPLAY_FOLDER="" MATERIALIZE="">
                <UNIQUENAME><![CDATA[Attribute]]></UNIQUENAME>
                <NAME><![CDATA[Attribute]]></NAME>
                <TYPE><![CDATA[]]></TYPE>
                <DATAFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DATAFIELD>
                <DISPLAYFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DISPLAYFIELD>
                <GEOROLE><![CDATA[]]></GEOROLE>
                <MAPLEVEL><![CDATA[]]></MAPLEVEL>
                <HASTIMEINDATEFORMAT><![CDATA[false]]></HASTIMEINDATEFORMAT>
                <DATEDATATYPE><![CDATA[]]></DATEDATATYPE>
                <FIELDDATATYPE><![CDATA[]]></FIELDDATATYPE>
                <SUBDATATYPE><![CDATA[]]></SUBDATATYPE>
                <DISPLAYFIELDDATATYPE><![CDATA[]]></DISPLAYFIELDDATATYPE>
                <DATEFORMAT><![CDATA[]]></DATEFORMAT>
                <FORMATTYPE><![CDATA[]]></FORMATTYPE>
                <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                <MEMBER_PROPERTIES>
                </MEMBER_PROPERTIES>
              </ATTR>
            </ATTRS>
            <CALC_MEMBERS>
            </CALC_MEMBERS>
            <SCD TYPE="2">
            </SCD>
          </DIMENSION>
          <DIMENSION ID="DIM_12" DIM_TO_FACT_MAPPING="ONE_TO_MANY" RESTRICT="false" RESTRICTVALUES="false" IS_ACCESSIBLE="true" ISVISIBLE="true" MATERIALIZE="" CUBE_VIEW_TYPE="">
            <INCREMENTAL_UPDATE_PROPERTIES PROCESSING_MODE="1">
            </INCREMENTAL_UPDATE_PROPERTIES>
            <UNIQUENAME><![CDATA[DIM_12]]></UNIQUENAME>
            <NAME><![CDATA[Dimension]]></NAME>
            <TYPE><![CDATA[Time]]></TYPE>
            <PREDEF_TIME_HIERARCHY><![CDATA[Y-M-D]]></PREDEF_TIME_HIERARCHY>
            <DATAFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DATAFIELD>
            <DEFAULTHIERARCHYUNIQUENAME><![CDATA[H_11]]></DEFAULTHIERARCHYUNIQUENAME>
            <DESCRIPTION><![CDATA[]]></DESCRIPTION>
            <DATASOURCES>
              <DATASOURCE ID="16540882697562127036042153362366_0" TYPE="REFERENCED">
              </DATASOURCE>
            </DATASOURCES>
            <HIERARCHIES>
              <HIERARCHY HASALL="false" ISVISIBLE="true" ISDEFAULT="false" IS_CUSTOMCALENDAR="false" HAS_ALTERNATE_PATH="false" HAS_PARENTCHILD_RELATION="false" PC_LEVEL_COUNT="-1" IS_ACCESSIBLE="true" CUBE_VIEW_TYPE="" MATERIALIZE="">
                <UNIQUENAME><![CDATA[H_11]]></UNIQUENAME>
                <NAME><![CDATA[H_Dimension]]></NAME>
                <DEFAULTMEMBERUNIQUENAME><![CDATA[]]></DEFAULTMEMBERUNIQUENAME>
                <ALLMEMBERUNIQUENAME><![CDATA[]]></ALLMEMBERUNIQUENAME>
                <PREDEF_TIME_HIERARCHY><![CDATA[Y-M-D]]></PREDEF_TIME_HIERARCHY>
                <DATAFIELD QUERY_NAME="Charter1" QUERY_ID="16540882697562127036042153362366_0"><![CDATA[saledate]]></DATAFIELD>
                <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                <LEVELS>
                  <LEVEL DATATYPE=""  ISALL="true" SHOW_VALUES="0" MAPTYPE ="" IS_ACCESSIBLE="true" ISVISIBLE="true" IS_DELETED="false" HIDE_MEMBER="0" MATERIALIZE="">
                    <UNIQUENAME><![CDATA[DIMENSION_LEVEL_920477996]]></UNIQUENAME>
                    <NAME><![CDATA[Hierarchy.ALL]]></NAME>
                    <MEMBER_PROPERTIES>
                    </MEMBER_PROPERTIES>
                    <FULLY_QUALIFIED_NAME><![CDATA[]]></FULLY_QUALIFIED_NAME>
                    <DATEDATATYPE><![CDATA[]]></DATEDATATYPE>
                    <FIELDDATATYPE><![CDATA[]]></FIELDDATATYPE>
                    <SUBDATATYPE><![CDATA[]]></SUBDATATYPE>
                    <DISPLAYFIELDDATATYPE><![CDATA[]]></DISPLAYFIELDDATATYPE>
                    <GEOROLE><![CDATA[]]></GEOROLE>
                    <MAPLEVEL><![CDATA[]]></MAPLEVEL>
                    <DATAFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DATAFIELD>
                    <PARENTFIELD QUERY_NAME="" QUERY_ID="" DATA_TYPE=""><![CDATA[]]></PARENTFIELD>
                    <DISPLAYFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DISPLAYFIELD>
                    <HASTIMEINDATEFORMAT><![CDATA[false]]></HASTIMEINDATEFORMAT>
                    <DATEFORMAT><![CDATA[]]></DATEFORMAT>
                    <FORMATTYPE><![CDATA[]]></FORMATTYPE>
                    <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                    <PROPERTIES>
                    </PROPERTIES>
                  </LEVEL>
                  <LEVEL DATATYPE="DATE"  ISALL="false" SHOW_VALUES="0" MAPTYPE ="" IS_ACCESSIBLE="true" ISVISIBLE="true" IS_DELETED="false" HIDE_MEMBER="0" MATERIALIZE="">
                    <UNIQUENAME><![CDATA[DIMENSION_LEVEL_17]]></UNIQUENAME>
                    <NAME><![CDATA[Year]]></NAME>
                    <MEMBER_PROPERTIES>
                    </MEMBER_PROPERTIES>
                    <FULLY_QUALIFIED_NAME><![CDATA[]]></FULLY_QUALIFIED_NAME>
                    <DATEDATATYPE><![CDATA[Year]]></DATEDATATYPE>
                    <FIELDDATATYPE><![CDATA[]]></FIELDDATATYPE>
                    <SUBDATATYPE><![CDATA[]]></SUBDATATYPE>
                    <DISPLAYFIELDDATATYPE><![CDATA[]]></DISPLAYFIELDDATATYPE>
                    <GEOROLE><![CDATA[]]></GEOROLE>
                    <MAPLEVEL><![CDATA[]]></MAPLEVEL>
                    <DATAFIELD QUERY_NAME="Charter1" QUERY_ID="16540882697562127036042153362366_0"><![CDATA[saledate]]></DATAFIELD>
                    <PARENTFIELD QUERY_NAME="" QUERY_ID="" DATA_TYPE=""><![CDATA[]]></PARENTFIELD>
                    <DISPLAYFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DISPLAYFIELD>
                    <HASTIMEINDATEFORMAT><![CDATA[false]]></HASTIMEINDATEFORMAT>
                    <DATEFORMAT><![CDATA[]]></DATEFORMAT>
                    <FORMATTYPE><![CDATA[]]></FORMATTYPE>
                    <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                    <PROPERTIES>
                    </PROPERTIES>
                  </LEVEL>
                  <LEVEL DATATYPE="DATE"  ISALL="false" SHOW_VALUES="0" MAPTYPE ="" IS_ACCESSIBLE="true" ISVISIBLE="true" IS_DELETED="false" HIDE_MEMBER="0" MATERIALIZE="">
                    <UNIQUENAME><![CDATA[DIMENSION_LEVEL_18]]></UNIQUENAME>
                    <NAME><![CDATA[Month]]></NAME>
                    <MEMBER_PROPERTIES>
                    </MEMBER_PROPERTIES>
                    <FULLY_QUALIFIED_NAME><![CDATA[]]></FULLY_QUALIFIED_NAME>
                    <DATEDATATYPE><![CDATA[Month]]></DATEDATATYPE>
                    <FIELDDATATYPE><![CDATA[]]></FIELDDATATYPE>
                    <SUBDATATYPE><![CDATA[]]></SUBDATATYPE>
                    <DISPLAYFIELDDATATYPE><![CDATA[]]></DISPLAYFIELDDATATYPE>
                    <GEOROLE><![CDATA[]]></GEOROLE>
                    <MAPLEVEL><![CDATA[]]></MAPLEVEL>
                    <DATAFIELD QUERY_NAME="Charter1" QUERY_ID="16540882697562127036042153362366_0"><![CDATA[saledate]]></DATAFIELD>
                    <PARENTFIELD QUERY_NAME="" QUERY_ID="" DATA_TYPE=""><![CDATA[]]></PARENTFIELD>
                    <DISPLAYFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DISPLAYFIELD>
                    <HASTIMEINDATEFORMAT><![CDATA[false]]></HASTIMEINDATEFORMAT>
                    <DATEFORMAT><![CDATA[]]></DATEFORMAT>
                    <FORMATTYPE><![CDATA[]]></FORMATTYPE>
                    <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                    <PROPERTIES>
                    </PROPERTIES>
                  </LEVEL>
                  <LEVEL DATATYPE="DATE"  ISALL="false" SHOW_VALUES="0" MAPTYPE ="" IS_ACCESSIBLE="true" ISVISIBLE="true" IS_DELETED="false" HIDE_MEMBER="0" MATERIALIZE="">
                    <UNIQUENAME><![CDATA[DIMENSION_LEVEL_19]]></UNIQUENAME>
                    <NAME><![CDATA[Day]]></NAME>
                    <MEMBER_PROPERTIES>
                    </MEMBER_PROPERTIES>
                    <FULLY_QUALIFIED_NAME><![CDATA[]]></FULLY_QUALIFIED_NAME>
                    <DATEDATATYPE><![CDATA[Day]]></DATEDATATYPE>
                    <FIELDDATATYPE><![CDATA[]]></FIELDDATATYPE>
                    <SUBDATATYPE><![CDATA[]]></SUBDATATYPE>
                    <DISPLAYFIELDDATATYPE><![CDATA[]]></DISPLAYFIELDDATATYPE>
                    <GEOROLE><![CDATA[]]></GEOROLE>
                    <MAPLEVEL><![CDATA[]]></MAPLEVEL>
                    <DATAFIELD QUERY_NAME="Charter1" QUERY_ID="16540882697562127036042153362366_0"><![CDATA[saledate]]></DATAFIELD>
                    <PARENTFIELD QUERY_NAME="" QUERY_ID="" DATA_TYPE=""><![CDATA[]]></PARENTFIELD>
                    <DISPLAYFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DISPLAYFIELD>
                    <HASTIMEINDATEFORMAT><![CDATA[false]]></HASTIMEINDATEFORMAT>
                    <DATEFORMAT><![CDATA[]]></DATEFORMAT>
                    <FORMATTYPE><![CDATA[]]></FORMATTYPE>
                    <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                    <PROPERTIES>
                    </PROPERTIES>
                  </LEVEL>
                </LEVELS>
              </HIERARCHY>
            </HIERARCHIES>
            <ATTRS>
            </ATTRS>
            <CALC_MEMBERS>
            </CALC_MEMBERS>
            <SCD TYPE="2">
            </SCD>
          </DIMENSION>
          <DIMENSION ID="DIM_13" DIM_TO_FACT_MAPPING="ONE_TO_MANY" RESTRICT="false" RESTRICTVALUES="false" IS_ACCESSIBLE="true" ISVISIBLE="true" MATERIALIZE="" CUBE_VIEW_TYPE="">
            <INCREMENTAL_UPDATE_PROPERTIES PROCESSING_MODE="1">
            </INCREMENTAL_UPDATE_PROPERTIES>
            <UNIQUENAME><![CDATA[DIM_13]]></UNIQUENAME>
            <NAME><![CDATA[Dimension_1]]></NAME>
            <TYPE><![CDATA[Regular]]></TYPE>
            <PREDEF_TIME_HIERARCHY><![CDATA[]]></PREDEF_TIME_HIERARCHY>
            <DATAFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DATAFIELD>
            <DEFAULTHIERARCHYUNIQUENAME><![CDATA[H_12]]></DEFAULTHIERARCHYUNIQUENAME>
            <DESCRIPTION><![CDATA[]]></DESCRIPTION>
            <DATASOURCES>
              <DATASOURCE ID="16540882697562127036042153362366_0" TYPE="REFERENCED">
              </DATASOURCE>
            </DATASOURCES>
            <HIERARCHIES>
              <HIERARCHY HASALL="false" ISVISIBLE="true" ISDEFAULT="false" IS_CUSTOMCALENDAR="false" HAS_ALTERNATE_PATH="false" HAS_PARENTCHILD_RELATION="false" PC_LEVEL_COUNT="-1" IS_ACCESSIBLE="true" CUBE_VIEW_TYPE="" MATERIALIZE="">
                <UNIQUENAME><![CDATA[H_12]]></UNIQUENAME>
                <NAME><![CDATA[H_Dimension_1]]></NAME>
                <DEFAULTMEMBERUNIQUENAME><![CDATA[]]></DEFAULTMEMBERUNIQUENAME>
                <ALLMEMBERUNIQUENAME><![CDATA[]]></ALLMEMBERUNIQUENAME>
                <PREDEF_TIME_HIERARCHY><![CDATA[]]></PREDEF_TIME_HIERARCHY>
                <DATAFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DATAFIELD>
                <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                <LEVELS>
                  <LEVEL DATATYPE=""  ISALL="true" SHOW_VALUES="0" MAPTYPE ="" IS_ACCESSIBLE="true" ISVISIBLE="true" IS_DELETED="false" HIDE_MEMBER="0" MATERIALIZE="">
                    <UNIQUENAME><![CDATA[DIMENSION_LEVEL_890916495]]></UNIQUENAME>
                    <NAME><![CDATA[Hierarchy.ALL]]></NAME>
                    <MEMBER_PROPERTIES>
                    </MEMBER_PROPERTIES>
                    <FULLY_QUALIFIED_NAME><![CDATA[]]></FULLY_QUALIFIED_NAME>
                    <DATEDATATYPE><![CDATA[]]></DATEDATATYPE>
                    <FIELDDATATYPE><![CDATA[]]></FIELDDATATYPE>
                    <SUBDATATYPE><![CDATA[]]></SUBDATATYPE>
                    <DISPLAYFIELDDATATYPE><![CDATA[]]></DISPLAYFIELDDATATYPE>
                    <GEOROLE><![CDATA[]]></GEOROLE>
                    <MAPLEVEL><![CDATA[]]></MAPLEVEL>
                    <DATAFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DATAFIELD>
                    <PARENTFIELD QUERY_NAME="" QUERY_ID="" DATA_TYPE=""><![CDATA[]]></PARENTFIELD>
                    <DISPLAYFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DISPLAYFIELD>
                    <HASTIMEINDATEFORMAT><![CDATA[false]]></HASTIMEINDATEFORMAT>
                    <DATEFORMAT><![CDATA[]]></DATEFORMAT>
                    <FORMATTYPE><![CDATA[]]></FORMATTYPE>
                    <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                    <PROPERTIES>
                    </PROPERTIES>
                  </LEVEL>
                  <LEVEL DATATYPE="CHAR"  ISALL="false" SHOW_VALUES="0" MAPTYPE ="" IS_ACCESSIBLE="true" ISVISIBLE="true" IS_DELETED="false" HIDE_MEMBER="0" MATERIALIZE="">
                    <UNIQUENAME><![CDATA[DIMENSION_LEVEL_23]]></UNIQUENAME>
                    <NAME><![CDATA[country]]></NAME>
                    <MEMBER_PROPERTIES>
                    </MEMBER_PROPERTIES>
                    <FULLY_QUALIFIED_NAME><![CDATA[]]></FULLY_QUALIFIED_NAME>
                    <DATEDATATYPE><![CDATA[]]></DATEDATATYPE>
                    <FIELDDATATYPE><![CDATA[]]></FIELDDATATYPE>
                    <SUBDATATYPE><![CDATA[]]></SUBDATATYPE>
                    <DISPLAYFIELDDATATYPE><![CDATA[]]></DISPLAYFIELDDATATYPE>
                    <GEOROLE><![CDATA[]]></GEOROLE>
                    <MAPLEVEL><![CDATA[]]></MAPLEVEL>
                    <DATAFIELD QUERY_NAME="Charter1" QUERY_ID="16540882697562127036042153362366_0"><![CDATA[country]]></DATAFIELD>
                    <PARENTFIELD QUERY_NAME="" QUERY_ID="" DATA_TYPE=""><![CDATA[]]></PARENTFIELD>
                    <DISPLAYFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DISPLAYFIELD>
                    <HASTIMEINDATEFORMAT><![CDATA[false]]></HASTIMEINDATEFORMAT>
                    <DATEFORMAT><![CDATA[]]></DATEFORMAT>
                    <FORMATTYPE><![CDATA[]]></FORMATTYPE>
                    <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                    <PROPERTIES>
                    </PROPERTIES>
                  </LEVEL>
                  <LEVEL DATATYPE="CHAR"  ISALL="false" SHOW_VALUES="0" MAPTYPE ="" IS_ACCESSIBLE="true" ISVISIBLE="true" IS_DELETED="false" HIDE_MEMBER="0" MATERIALIZE="">
                    <UNIQUENAME><![CDATA[DIMENSION_LEVEL_22]]></UNIQUENAME>
                    <NAME><![CDATA[city]]></NAME>
                    <MEMBER_PROPERTIES>
                    </MEMBER_PROPERTIES>
                    <FULLY_QUALIFIED_NAME><![CDATA[]]></FULLY_QUALIFIED_NAME>
                    <DATEDATATYPE><![CDATA[]]></DATEDATATYPE>
                    <FIELDDATATYPE><![CDATA[]]></FIELDDATATYPE>
                    <SUBDATATYPE><![CDATA[]]></SUBDATATYPE>
                    <DISPLAYFIELDDATATYPE><![CDATA[]]></DISPLAYFIELDDATATYPE>
                    <GEOROLE><![CDATA[]]></GEOROLE>
                    <MAPLEVEL><![CDATA[]]></MAPLEVEL>
                    <DATAFIELD QUERY_NAME="Charter1" QUERY_ID="16540882697562127036042153362366_0"><![CDATA[city]]></DATAFIELD>
                    <PARENTFIELD QUERY_NAME="" QUERY_ID="" DATA_TYPE=""><![CDATA[]]></PARENTFIELD>
                    <DISPLAYFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DISPLAYFIELD>
                    <HASTIMEINDATEFORMAT><![CDATA[false]]></HASTIMEINDATEFORMAT>
                    <DATEFORMAT><![CDATA[]]></DATEFORMAT>
                    <FORMATTYPE><![CDATA[]]></FORMATTYPE>
                    <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                    <PROPERTIES>
                    </PROPERTIES>
                  </LEVEL>
                </LEVELS>
              </HIERARCHY>
            </HIERARCHIES>
            <ATTRS>
            </ATTRS>
            <CALC_MEMBERS>
            </CALC_MEMBERS>
            <SCD TYPE="2">
            </SCD>
          </DIMENSION>
        </DIMENSIONS>
        <MEASURE_GROUPS>
          <DATASOURCES>
            <DATASOURCE ID="16540882697562127036042153362366_0" TYPE="REFERENCED">
            </DATASOURCE>
          </DATASOURCES>
          <MEASURE_GROUP NAME="MeasureGroup" IS_ACCESSIBLE="true" ISVISIBLE="true" MATERIALIZE="">
            <DESCRIPTION><![CDATA[]]></DESCRIPTION>
            <MEASURE_ID><![CDATA[MEASURE_11]]></MEASURE_ID>
          </MEASURE_GROUP>
        </MEASURE_GROUPS>
        <MEASURES>
          <INCREMENTAL_UPDATE_PROPERTIES PROCESSING_MODE="1">
          </INCREMENTAL_UPDATE_PROPERTIES>
          <MEASURE ID="MEASURE_11" TYPE="STANDARD" DATATYPE="NUMBER" SUBTYPE= "" ISVISIBLE="true" ISDEFAULT="true" RESTRICT="false" SOLVE_ORDER="0" ISADJUSTMENT="false" ADJUSTMENT_TYPE="NEGATIVE" DISPLAY_FOLDER="" COLOR="" IS_ACCESSIBLE="true" MATERIALIZE="">
            <UNIQUENAME><![CDATA[MEASURE_11]]></UNIQUENAME>
            <NAME><![CDATA[saleamount]]></NAME>
            <FORMAT USEDEFAULT="0"><![CDATA[#,##0.00]]></FORMAT>
            <FORMATTYPE><![CDATA[2]]></FORMATTYPE>
            <UNIT>
            </UNIT>
            <SUMMARYFUNCTION><![CDATA[0]]></SUMMARYFUNCTION>
            <ACTUALSUMMARYFUNCTION><![CDATA[0]]></ACTUALSUMMARYFUNCTION>
            <DATAFIELD QUERY_NAME="Charter1" QUERY_ID="16540882697562127036042153362366_0"><![CDATA[saleamount]]></DATAFIELD>
            <MINON_MAXON_DATAFIELD QUERY_NAME="Charter1" QUERY_ID="16540882697562127036042153362366_0"><![CDATA[]]></MINON_MAXON_DATAFIELD>
            <EXPRESSION NON_EMPTY_BEHAVIOR="BY_MEASURE"><![CDATA[]]></EXPRESSION>
            <DESCRIPTION><![CDATA[]]></DESCRIPTION>
            <IS_BOUNDARY_DIST_COUNT><![CDATA[false]]></IS_BOUNDARY_DIST_COUNT>
          </MEASURE>
        </MEASURES>
        <LINK_DESIGN_LAYOUT>
        </LINK_DESIGN_LAYOUT>
      </CUBEOBJECT>
      <DELTA_INFO>
      </DELTA_INFO>
    </SPECIFIC>
  </IRO>
</RESPONSE>

Update Semantic Model

This API is used to update an existing semantic model.

Authorizations:

sessionIdbasicAuth

path Parameters

nameOrId

required

string

Name or Id of Semantic Model Object.

header Parameters

Accept	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

cubeXML

object

XML of a semantic model. This XML can be generated with the help of com.kyvos.commons.entity.reportobjects.CubeObject class.
For e.g.

  <IRO ID="15452933458461127071083153170947" NAME="Historical Field Details" TYPE="ANALYTICAL" SUBTYPE="CUBE" FOLDER_ID="folder_15396014106428127088047133277741" FOLDER_NAME="Query Analyzer" ISPUBLIC="">
  <COMMON>
    <DESC>
      <![CDATA[]]>
    </DESC>
    <COMPATIBILITY_VERSION>
      <![CDATA[1]]>
    </COMPATIBILITY_VERSION>
  </COMMON>
  <SPECIFIC>
    <ATTRS>
      <ATTR NAME="CUBEUNIQUENAME">
        <VALUE>
          <![CDATA[15452933458461127071083153170947]]>
        </VALUE>
      </ATTR>
    </ATTRS>
    <CUBEOBJECT>
      <LAYOUT_PROPERTY>
        <PANEL_DETAILS>
          <![CDATA[{"filters":{"style":{"height":-5},"id":"filters"},"properties":{"style":{"height":94},"id":"properties"},"sourceFields":{"id":"sourceFields","style":{"height":89}}}]]>
        </PANEL_DETAILS>
        <COLUMN_DETAILS>
          <![CDATA[[{"style":{},"panels":["sourceFields"]},{"index":0,"style":{"width":293.326},"panels":[]},{"index":1,"style":{}}]]]>
        </COLUMN_DETAILS>
      </LAYOUT_PROPERTY>
      <SLIDING_WINDOWS>
      <AGGREGATION_STRATEGY TYPE="CONFIGURATION_DRIVEN" >
        <CONFIGURATION_DRIVEN>
          <ENTITY_PROPS_VALUES>
            <PROPERTY>
              <NAME>
                <![CDATA[kyvos.build.precompute.level.threshold]]>
              </NAME>
              <VALUE>
                <![CDATA[]]>
              </VALUE>
              <MODE>
                <![CDATA[DEFAULT]]>
              </MODE>
            </PROPERTY>
            <PROPERTY>
              <NAME>
                <![CDATA[kyvos.build.dimensions.materialize]]>
              </NAME>
              <VALUE>
                <![CDATA[]]>
              </VALUE>
              <MODE>
                <![CDATA[DEFAULT]]>
              </MODE>
            </PROPERTY>
            <PROPERTY>
              <NAME>
                <![CDATA[kyvos.build.precompute.degree]]>
              </NAME>
              <VALUE>
                <![CDATA[]]>
              </VALUE>
              <MODE>
                <![CDATA[DEFAULT]]>
              </MODE>
            </PROPERTY>
            <PROPERTY>
              <NAME>
                <![CDATA[kyvos.build.precompute.hierarchy.levels]]>
              </NAME>
              <VALUE>
                <![CDATA[]]>
              </VALUE>
              <MODE>
                <![CDATA[DEFAULT]]>
              </MODE>
            </PROPERTY>
          </ENTITY_PROPS_VALUES>
        </CONFIGURATION_DRIVEN>
      </AGGREGATION_STRATEGY>
      <DIMENSIONS>
        <DIMENSION ID="Dim_Measures" RESTRICT="false" RESTRICTVALUES="false">
          <NAME>
            <![CDATA[Measures]]>
          </NAME>
          <UNIQUENAME>
            <![CDATA[Measures]]>
          </UNIQUENAME>
          <TYPE>
            <![CDATA[MEASURE]]>
          </TYPE>
          <DEFAULTHIERARCHYUNIQUENAME>
            <![CDATA[Measures]]>
          </DEFAULTHIERARCHYUNIQUENAME>
          <HIERARCHIES>
            <HIERARCHY HASALL="false">
              <UNIQUENAME>
                <![CDATA[Measures]]>
              </UNIQUENAME>
              <ALLMEMBERUNIQUENAME />/n
              <LEVELS>
                <LEVEL DATATYPE="Regular">
                  <UNIQUENAME>
                    <![CDATA[MeasuresLevel]]>
                  </UNIQUENAME>
                  <DATAFIELD />
                  <PROPERTIES />
                </LEVEL>
              </LEVELS>
            </HIERARCHY>
          </HIERARCHIES>
          <ATTRS>
            <ATTR DATATYPE="">
              <UNIQUENAME>
                <![CDATA[Attribute]]>
              </UNIQUENAME>
              <NAME>
                <![CDATA[Attribute]]>
              </NAME>
              <DATAFIELD />
            </ATTR>
          </ATTRS>
        </DIMENSION>
      </DIMENSIONS>
      <MEASURE_GROUPS>
        <MEASURE_GROUP NAME="Measure Group" ISVISIBLE="true" MATERIALIZE="">
          <DESCRIPTION>
            <![CDATA[]]>
          </DESCRIPTION>
          <MEASURE_ID>
            <![CDATA[MEASURE_34820]]>
          </MEASURE_ID>
        </MEASURE_GROUP>
      </MEASURE_GROUPS>
      <MEASURES>
        <MEASURE ID="MEASURE_34820" DATATYPE="NUMBER" ISDEFAULT="true" ISVISIBLE="true" SOLVE_ORDER="0" DISPLAY_FOLDER="" MATERIALIZE="">
          <UNIQUENAME>
            <![CDATA[MEASURE_34820]]>
          </UNIQUENAME>
          <NAME>
            <![CDATA[Query Count]]>
          </NAME>
          <FORMAT USEDEFAULT="0">
            <![CDATA[#,##0]]>
          </FORMAT>
          <FORMATTYPE>
            <![CDATA[2]]>
          </FORMATTYPE>
          <UNIT>
            <![CDATA[]]>
          </UNIT>
          <DATAFIELD QUERY_NAME="field_details" QUERY_ID="15451326173844127065091156882788_0">
            <![CDATA[field_used_count]]>
          </DATAFIELD>
          <EXPRESSION NON_EMPTY_BEHAVIOR="BY_MEASURE">
            <![CDATA[]]>
          </EXPRESSION>
          <DESCRIPTION>
            <![CDATA[]]>
          </DESCRIPTION>
          <SUMMARYFUNCTION>
            <![CDATA[0]]>
          </SUMMARYFUNCTION>
        </MEASURE>
      </MEASURES>
    </CUBEOBJECT>
  </SPECIFIC>
</IRO>

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully replaced semantic model object: Untitled Cube 1",
"CODE": 0
}

Delete Semantic Model

This API is used to delete an existing semantic model.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model of which you want to get the object. If you do not know the smodelId, use the smodelName and folderName/folderId.
smodelName	string Name of the semantic model of which you want to get the object
folderName	string Folder name of the semantic model of which you want to get the object.
folderId	string Folder id of the semantic model of which you want to get the object.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Semantic model deleted successfully.",
"CODE": 0
}

Process Semantic Model

This API is used to process semantic model.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model for which you want to add job.
smodelName	string Name of the semantic model for which you want to add job
folderName	string Folder name in which the semantic model is located.
folderId	string Folder id in which the semantic model is located.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

jobType	string Default: "FULL" Enum: "FULL" "INCREMENTAL" "DROP_PARTITION" "UPDATE_AGGREGATES" "CACHE_POPULATION" "FULL_TEST" Provide the details for semantic model job type. Possible values: FULL, INCREMENTAL, DROP_PARTITION, UPDATE_AGGREGATES, CACHE_POPULATION and FULL_TEST FULL: Recreates the semantic model with all available data including recalculation of all aggregations. INCREMENTAL: Updates the semantic model with latest data. FULL_TEST: Recreates the semantic model with limited rows. UPDATE_AGGREGATES: Updates semantic model aggregates based on current aggregation strategy. CACHE_POPULATION: Clears cached query responses and then re-populates it with latest semantic model data. DROP_PARTITION: Create rules to select partitions to drop. Default Value: FULL
replacePartition	boolean Default: false Enum: true false Determines whether the incremental job type should be with replace partition or not. Default Value: False
runType	string Default: "NOW" Enum: "NOW" "ONCE" Determines whether the semantic model job would be performed just now or once at a given date and time. Possible values are NOW, ONCE. Default Value: NOW Now: This will immediately start the job Once: Job will run at the specified time
onceDateTime	string This parameter is only applicable for runType ONCE. It specifies the date and time when the job would start(format: mm/dd/yyyy hh:mm)
userParams	string The parameters info which is to be used in semantic model job. Value in JSON should be passed. Example: [ { "name": "parameterName", "value": "parameterValue" } ]
incrementalJobProcessType	string Type of process if job type is incremental. The possible value is FACT_ADJUSTMENTS
jobConnectionName	string Job Connection Name
tagsJSON	object The parameters info which is to be used in semantic model job. Value in JSON should be passed. Example: [ "Tag1", "Admin", "Finance"]
dropPartitionRulesJson	object Value in JSON should be passed as what is in the database, not the display value. IsValueQualified is true when year and month both are present in value and must be passed at that time only as shown in the above JSON example. valueSeparator is used when we need to pass more than one value as shown in the below JSON Example. { "rules": [ { "factNames": [ "PurchaseDS", "SalesDS" ], "conditions": [ { "dimensionName": "DatesGTD", "levelName": "Month", "operator": "INLIST", "value": "JAN-2012@FEB-2012", "valueSeparator": "@", "isValueQualified": true }, { "dimensionName": "DatesGTD", "levelName": "Month", "operator": "EQUAL_TO", "value": "JUL-2012", "isValueQualified": true } ] }, { "factNames": [ "SalesDS" ], "conditions": [ { "dimensionName": "DatesGTD", "levelName": "Month", "operator": "BETWEEN", "value": "FEB-2013", "secondValue": "APR-2013", "isValueQualified": true } ] } ] }
updateAggregatesPartitions	object List of partitions needs to be updated should be passed in JSON format. Example: { "partitions": [ { "caption": "2020-06-30", "id": "18444", "factName": "", } ] }
systemParamsJson	object Value in JSON should be passed. The system parameters key value pair JSON array of object which is to be used in cube build. Example: user can pass selected datasets for Incremental job in system Params. { "name": "DATASETS", "value": [ { "name": "Join of HospitalDetails, Hospitals" }, { "name": "Accounting" } ] }
recommendationParamsJson	object Value in JSON should be passed. JSON Example. { "RECOMMENDATION_TYPE": "AGGREGATION", "AGGREGATION_STRATEGY_TYPE": "ONLY_NEW_AGGREGATION/KEEP_EXISTING/MINIMAL_AGGREGATION", "QUERY_DAYS": 3, "QUERY_EXECUTION_TIME": 10, "SELECTED_USERS": "system-user", //user names of user whose queries needs to be considered "CONSIDER_QUERY_PATTERNS": false //whether to inclue additonal query or not }

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Semantic Model job submitted successfully.",
"CODE": 0
}

Get Job Status

This API is used to fetch semantic model job status.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model of which you want to get the job status. If you do not know the smodelId, use the smodelName and folderName/folderId.
smodelName	string Name of the semantic model of which you want to get the job status.
folderName	string Folder name of the semantic model of which you want to get the job status.
folderId	string Folder id of the semantic model of which you want to get the job status.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": "COMPLETED"
}

Get Job Summary

This API is used to fetch semantic model job summary.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model of which you want to get the job summary.
folderId	string Folder id of the semantic model of which you want to get the job summary.
smodelName	string Name of the semantic model of which you want to get the job summary.
folderName	string Folder name of the semantic model of which you want to get the job summary.
historyId	string History ID of the job for which summary is required. This parameter is optional and required only when specific process job summary is needed. If not given, the job summary from the most recent process is retrieved.
jobType	string Enum: "FULL" "INCREMENTAL" "DROP_PARTITION" "UPDATE_AGGREGATES" "CACHE_POPULATION" "FULL_TEST" Example: jobType=FULL Provide the details for job summary type. Possible values: FULL, INCREMENTAL, DROP_PARTITION, UPDATE_AGGREGATES, CACHE_POPULATION and FULL_TEST FULL: Recreates the semantic model with all available data including recalculation of all aggregations. INCREMENTAL: Updates the semantic model with latest data. FULL_TEST: Recreates the semantic model with limited rows. UPDATE_AGGREGATES: Updates semantic model aggregates based on current aggregation strategy. CACHE_POPULATION: Clears cached query responses and then re-populates it with latest semantic model data. DROP_PARTITION: Create rules to select partitions to drop.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"ALL_BUILD_STATUS": {"BUILD_STATUS": {"BUILD_FUNCTION": "Test",
"CONSOLIDATED_BUILD_STATUS": {"COMPLETED": {"PROBLEMS": {"PROBLEM": [{"MESSAGE": "The hierarchy or attribute names are either duplicate across dimensions or invalid. Following are the invalid entities:",
"PROBLEM_FUNCTIONAL_TYPE": "DEFAULT",
"CUBE_VIEW_TYPE": "PHYSICAL",
"TYPE": "WARNING",
"STACKTRACE": {"REASON": {"MESSAGE": "Hierarchy/Attribute Name:Hierarchy : (Dim Name: Geography, Type:hierarchy); (Dim Name: Time, Type:hierarchy); (Dim Name: tManufacturer, Type:hierarchy);",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "Hierarchy",
"OBJECT": "CURRENT",
"NAME": "Hierarchy"
}
}
},
{"MESSAGE": "Registered file Product-Sales_Detail_50GB contains some invalid entries.",
"PROBLEM_FUNCTIONAL_TYPE": "DEFAULT",
"OBJECTS": {"OBJECT": {"SUBTYPE": "REGISTERED",
"ID": "14078499836997127032066196431512",
"TYPE": "QUERY",
"NAME": "Product-Sales_Detail_50GB"
}
},
"TYPE": "WARNING",
"STACKTRACE": {"REASON": [{"MESSAGE": "Blank number values replaced to default for step Fetch :2",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Blank row for step Fetch :1",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Blank column value for step Fetch :1",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Blank date values replaced to default for step Fetch :0",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Mismatch data format for step Fetch :0",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Mismatch column size for step Fetch :0",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Mismatch data type for step Fetch :0",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
}
]
}
}
]
},
"CUBEBUILD_ELAPSED_TIME": 317974,
"IS_AGGREGATE_BUILD": false,
"SIZE": 500882823,
"TIMESTAMP": "08/28/2022 12:32:39",
"SECTIONS": {"SECTION": [{"MESSAGES": {"MESSAGE": [{"TYPE": "INFO",
"content": "<B>Dimensions</B>"
},
{"TYPE": "INFO",
"content": "Dimension: <B>Geography</B> (Member count: <B>51,304</B>, Metadata size: <B>47.2 MB</B>, Type: <B>Regular</B>)<BR>&nbsp;&nbsp;&nbsp;Hierarchy:&nbsp;<B>Hierarchy</B>(Member count: <B>51,304</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Continent</B> (Member count: <B>7</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Country</B> (Member count: <B>247</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>State</B> (Member count: <B>2,724</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>City</B> (Member count: <B>51,304</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Geography_Implicit_Level</B> (Member count: <B>51,304</B>)<BR>&nbsp;&nbsp;&nbsp;Attributes:&nbsp<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Attribute:&nbsp;<B>Region(Profit)%, : / \\ * | ? % $ ! + = {} < ></B> (Member count: <B>156</B>)<BR>"
},
{"TYPE": "INFO",
"content": "Dimension: <B>Time</B> (Member count: <B>1,703</B>, Metadata size: <B>52.4 MB</B>, Type: <B>Regular</B>)<BR>&nbsp;&nbsp;&nbsp;Hierarchy:&nbsp;<B>Hierarchy</B>(Member count: <B>1,703</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Year</B> (Member count: <B>6</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Quarter</B> (Member count: <B>20</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Month</B> (Member count: <B>57</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Week</B> (Member count: <B>276</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Day</B> (Member count: <B>1,703</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Date</B> (Member count: <B>1,703</B>)<BR>"
},
{"TYPE": "INFO",
"content": "Dimension: <B>DCustomer-Detail</B> (Member count: <B>795</B>, Metadata size: <B>18.9 MB</B>, Type: <B>Regular</B>)<BR>&nbsp;&nbsp;&nbsp;Hierarchy:&nbsp;<B>CustomerHierarchy</B>(Member count: <B>795</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Customer_Segment</B> (Member count: <B>4</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Customer_Name</B> (Member count: <B>795</B>)<BR>"
},
{"TYPE": "INFO",
"content": "Dimension: <B>Product-Detail</B> (Member count: <B>46</B>, Metadata size: <B>27.3 MB</B>, Type: <B>Regular</B>)<BR>&nbsp;&nbsp;&nbsp;Hierarchy:&nbsp;<B>Hierarchy(Profit)%, : / \\ * | ? % $ ! + = {} < ></B>(Member count: <B>46</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Product_Category(Profit)%, : / \\ * | ? % $ ! + = {} < ></B> (Member count: <B>3</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Product_Type(Profit)%, : / \\ * | ? % $ ! + = {} < ></B> (Member count: <B>10</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Product_Name</B> (Member count: <B>46</B>)<BR>"
},
{"TYPE": "INFO",
"content": "Dimension: <B>tManufacturer</B> (Member count: <B>21</B>, Metadata size: <B>8.4 MB</B>, Type: <B>Regular</B>)<BR>&nbsp;&nbsp;&nbsp;Hierarchy:&nbsp;<B>Hierarchy</B>(Member count: <B>21</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Manufacturer</B> (Member count: <B>21</B>)<BR>"
},
{"TYPE": "INFO",
"content": "<B>Measure Datasets</B>"
},
{"TYPE": "INFO",
"content": "Measure dataset: <B> Product-Sales_Detail_50GB</B> (Rows processed: <B>1,814,808</B>, Rows skipped: <B>1</B>, Total file size: <B>402.91 MB</B>, Execution Time: <B>08/28/2022 12:32:26</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Shipping_Cost</B>,&nbsp;Function: <B>sum</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Discount</B>,&nbsp;Function: <B>average</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Product_Type_DC</B>,&nbsp;Function: <B>distinct count</B>,&nbsp;Accuracy Type:&nbsp;<B>Accurate</B>,&nbsp;Calculated on:&nbsp;<B>Product_Type</B>,&nbsp;Member count:&nbsp;<B>10</B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Product_ID</B>,&nbsp;Function: <B>count</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Order_Quantity</B>,&nbsp;Function: <B>count</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Region_DC</B>,&nbsp;Function: <B>distinct count</B>,&nbsp;Accuracy Type:&nbsp;<B>Accurate</B>,&nbsp;Calculated on:&nbsp;<B>Region</B>,&nbsp;Member count:&nbsp;<B>156</B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>(Profit)%, : / \\ * | ? % $ ! + = {} < ></B>,&nbsp;Function: <B>sum</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Sale_Amount</B>,&nbsp;Function: <B>sum</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Row Count - Product-Sales_Detail_50GB - SYSTEM MEASURE</B>,&nbsp;Function: <B>count</B></B>"
}
]
},
"TYPE": "PHYSICAL_VIEW"
},
{"MESSAGES": {"MESSAGE": [{"TYPE": "INFO",
"content": "Measure dataset: <B> Product-Sales_Detail_50GB</B>"
},
{"TYPE": "INFO",
"content": "&nbsp;&nbsp;&nbsp;<B>Design:</B>\t\t\tPartition column: <B>None</B>\tBase partition range size: <B>None</B>"
}
]
},
"TYPE": "PARTITION_STRATEGY"
},
{"MESSAGES": "",
"TYPE": "ADVANCED_PROPERTIES"
},
{"MESSAGES": "",
"TYPE": "AGGREGATION_STRATEGY"
},
{"MESSAGES": {"MESSAGE": [{"TYPE": "INFO",
"content": "Cube metadata size: <B>158.43 MB</B>"
},
{"TYPE": "INFO",
"content": "Connection Name: <B>DefaultHadoopCluster01</B>"
},
{"TYPE": "INFO",
"content": "Cube Compatibility Version: <B>1</B>"
},
{"TYPE": "INFO",
"content": "<BR><B>Test build details:</B><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Last fact partitions processed:&nbsp<B>3</B><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Minimal aggregation:&nbsp<B>true</B>"
}
]
},
"TYPE": "MISCELLANEOUS"
},
{"MESSAGES": {"MESSAGE": {"TYPE": "INFO",
"content": "{\"total\":{\"cuboidSize\":\"342.45 MB\",\"maxCuboidSize\":\"22.10 MB\",\"avgCuboidSize\":\"14.89 MB\",\"cuboidCount\":23,\"minCuboidSize\":\"4.09 KB\"},\"colOrder\":{\"cuboidSize\":4,\"dimName\":2,\"maxCuboidSize\":6,\"avgCuboidSize\":5,\"cuboidCount\":3,\"minCuboidSize\":7,\"measureDatasetName\":1},\"dimensions\":[{\"cuboidSize\":\"195.54 MB\",\"dimName\":\"Geography\",\"maxCuboidSize\":\"22.10 MB\",\"avgCuboidSize\":\"21.73 MB\",\"cuboidCount\":9,\"minCuboidSize\":\"21.30 MB\",\"measureDatasetName\":\"Product-Sales_Detail_50GB\"},{\"cuboidSize\":\"140.19 MB\",\"dimName\":\"Time\",\"maxCuboidSize\":\"17.68 MB\",\"avgCuboidSize\":\"17.52 MB\",\"cuboidCount\":8,\"minCuboidSize\":\"17.41 MB\",\"measureDatasetName\":\"Product-Sales_Detail_50GB\"},{\"cuboidSize\":\"6.70 MB\",\"dimName\":\"DCustomer-Detail\",\"maxCuboidSize\":\"3.35 MB\",\"avgCuboidSize\":\"3.35 MB\",\"cuboidCount\":2,\"minCuboidSize\":\"3.34 MB\",\"measureDatasetName\":\"Product-Sales_Detail_50GB\"},{\"cuboidSize\":\"17.61 KB\",\"dimName\":\"Product-Detail\",\"maxCuboidSize\":\"8.81 KB\",\"avgCuboidSize\":\"8.81 KB\",\"cuboidCount\":2,\"minCuboidSize\":\"8.80 KB\",\"measureDatasetName\":\"Product-Sales_Detail_50GB\"},{\"cuboidSize\":\"8.26 KB\",\"dimName\":\"tManufacturer\",\"maxCuboidSize\":\"4.17 KB\",\"avgCuboidSize\":\"4.13 KB\",\"cuboidCount\":2,\"minCuboidSize\":\"4.09 KB\",\"measureDatasetName\":\"Product-Sales_Detail_50GB\"}]}"
}
},
"TYPE": "CUBOID_DETAILS"
}
]
}
}
},
"BUILD_NO": 1,
"HISTORY_ID": "840C10B0-DC58-6C95-5C63-C02CC9FD4AC8",
"STATUS": "COMPLETED",
"BUILD_TYPE": "FULL_TEST",
"CURRENT_BUILD_STATUS": {"COMPLETED": {"PROBLEMS": {"PROBLEM": [{"MESSAGE": "The hierarchy or attribute names are either duplicate across dimensions or invalid. Following are the invalid entities:",
"PROBLEM_FUNCTIONAL_TYPE": "DEFAULT",
"CUBE_VIEW_TYPE": "PHYSICAL",
"TYPE": "WARNING",
"STACKTRACE": {"REASON": {"MESSAGE": "Hierarchy/Attribute Name:Hierarchy : (Dim Name: Geography, Type:hierarchy); (Dim Name: Time, Type:hierarchy); (Dim Name: tManufacturer, Type:hierarchy);",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "Hierarchy",
"OBJECT": "CURRENT",
"NAME": "Hierarchy"
}
}
},
{"MESSAGE": "Registered file Product-Sales_Detail_50GB contains some invalid entries.",
"PROBLEM_FUNCTIONAL_TYPE": "DEFAULT",
"OBJECTS": {"OBJECT": {"SUBTYPE": "REGISTERED",
"ID": "14078499836997127032066196431512",
"TYPE": "QUERY",
"NAME": "Product-Sales_Detail_50GB"
}
},
"TYPE": "WARNING",
"STACKTRACE": {"REASON": [{"MESSAGE": "Blank number values replaced to default for step Fetch :2",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Blank row for step Fetch :1",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Blank column value for step Fetch :1",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Blank date values replaced to default for step Fetch :0",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Mismatch data format for step Fetch :0",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Mismatch column size for step Fetch :0",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Mismatch data type for step Fetch :0",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
}
]
}
}
]
},
"CUBEBUILD_ELAPSED_TIME": 317974,
"IS_AGGREGATE_BUILD": false,
"SIZE": 500882823,
"TIMESTAMP": "08/28/2022 12:32:39",
"SECTIONS": {"SECTION": [{"MESSAGES": {"MESSAGE": [{"TYPE": "INFO",
"content": "<B>Dimensions</B>"
},
{"TYPE": "INFO",
"content": "Dimension: <B>Geography</B> (Member count: <B>51,304</B>, Metadata size: <B>47.2 MB</B>, Type: <B>Regular</B>)<BR>&nbsp;&nbsp;&nbsp;Hierarchy:&nbsp;<B>Hierarchy</B>(Member count: <B>51,304</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Continent</B> (Member count: <B>7</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Country</B> (Member count: <B>247</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>State</B> (Member count: <B>2,724</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>City</B> (Member count: <B>51,304</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Geography_Implicit_Level</B> (Member count: <B>51,304</B>)<BR>&nbsp;&nbsp;&nbsp;Attributes:&nbsp<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Attribute:&nbsp;<B>Region(Profit)%, : / \\ * | ? % $ ! + = {} < ></B> (Member count: <B>156</B>)<BR>"
},
{"TYPE": "INFO",
"content": "Dimension: <B>Time</B> (Member count: <B>1,703</B>, Metadata size: <B>52.4 MB</B>, Type: <B>Regular</B>)<BR>&nbsp;&nbsp;&nbsp;Hierarchy:&nbsp;<B>Hierarchy</B>(Member count: <B>1,703</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Year</B> (Member count: <B>6</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Quarter</B> (Member count: <B>20</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Month</B> (Member count: <B>57</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Week</B> (Member count: <B>276</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Day</B> (Member count: <B>1,703</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Date</B> (Member count: <B>1,703</B>)<BR>"
},
{"TYPE": "INFO",
"content": "Dimension: <B>DCustomer-Detail</B> (Member count: <B>795</B>, Metadata size: <B>18.9 MB</B>, Type: <B>Regular</B>)<BR>&nbsp;&nbsp;&nbsp;Hierarchy:&nbsp;<B>CustomerHierarchy</B>(Member count: <B>795</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Customer_Segment</B> (Member count: <B>4</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Customer_Name</B> (Member count: <B>795</B>)<BR>"
},
{"TYPE": "INFO",
"content": "Dimension: <B>Product-Detail</B> (Member count: <B>46</B>, Metadata size: <B>27.3 MB</B>, Type: <B>Regular</B>)<BR>&nbsp;&nbsp;&nbsp;Hierarchy:&nbsp;<B>Hierarchy(Profit)%, : / \\ * | ? % $ ! + = {} < ></B>(Member count: <B>46</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Product_Category(Profit)%, : / \\ * | ? % $ ! + = {} < ></B> (Member count: <B>3</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Product_Type(Profit)%, : / \\ * | ? % $ ! + = {} < ></B> (Member count: <B>10</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Product_Name</B> (Member count: <B>46</B>)<BR>"
},
{"TYPE": "INFO",
"content": "Dimension: <B>tManufacturer</B> (Member count: <B>21</B>, Metadata size: <B>8.4 MB</B>, Type: <B>Regular</B>)<BR>&nbsp;&nbsp;&nbsp;Hierarchy:&nbsp;<B>Hierarchy</B>(Member count: <B>21</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Manufacturer</B> (Member count: <B>21</B>)<BR>"
},
{"TYPE": "INFO",
"content": "<B>Measure Datasets</B>"
},
{"TYPE": "INFO",
"content": "Measure dataset: <B> Product-Sales_Detail_50GB</B> (Rows processed: <B>1,814,808</B>, Rows skipped: <B>1</B>, Total file size: <B>402.91 MB</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Shipping_Cost</B>,&nbsp;Function: <B>sum</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Discount</B>,&nbsp;Function: <B>average</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Product_Type_DC</B>,&nbsp;Function: <B>distinct count</B>,&nbsp;Accuracy Type:&nbsp;<B>Accurate</B>,&nbsp;Calculated on:&nbsp;<B>Product_Type</B>,&nbsp;Member count:&nbsp;<B>10</B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Product_ID</B>,&nbsp;Function: <B>count</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Order_Quantity</B>,&nbsp;Function: <B>count</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Region_DC</B>,&nbsp;Function: <B>distinct count</B>,&nbsp;Accuracy Type:&nbsp;<B>Accurate</B>,&nbsp;Calculated on:&nbsp;<B>Region</B>,&nbsp;Member count:&nbsp;<B>156</B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>(Profit)%, : / \\ * | ? % $ ! + = {} < ></B>,&nbsp;Function: <B>sum</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Sale_Amount</B>,&nbsp;Function: <B>sum</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Row Count - Product-Sales_Detail_50GB - SYSTEM MEASURE</B>,&nbsp;Function: <B>count</B></B>"
}
]
},
"TYPE": "PHYSICAL_VIEW"
},
{"MESSAGES": {"MESSAGE": [{"TYPE": "INFO",
"content": "Measure dataset: <B> Product-Sales_Detail_50GB</B>"
},
{"TYPE": "INFO",
"content": "&nbsp;&nbsp;&nbsp;<B>Design:</B>\t\t\tPartition column: <B>None</B>\tBase partition range size: <B>None</B>"
}
]
},
"TYPE": "PARTITION_STRATEGY"
},
{"MESSAGES": {"MESSAGE": {"TYPE": "INFO",
"content": "\n\t\t\t\t\t<P>Modified Properties:<BR>&nbsp;&nbsp;&nbsp;kyvos.mdx.minifyUniqueName.hierarchyDepth :&nbsp<B>100</B><BR>&nbsp;&nbsp;&nbsp;kyvos.query.cuboidcache.strategy :&nbsp<B>Full</B><BR>&nbsp;&nbsp;&nbsp;kyvos.query.resultcache.strategy :&nbsp<B>None</B><BR>&nbsp;&nbsp;&nbsp;kyvos.sync.rows.mismatchcolumns :&nbsp<B>True</B><BR>&nbsp;&nbsp;&nbsp;kyvos.query.unrelateddim.ignore :&nbsp<B>True</B><BR>&nbsp;&nbsp;&nbsp;kyvos.query.cuboid.cache.minDims :&nbsp<B>0</B><BR>&nbsp;&nbsp;&nbsp;kyvos.extended.logging :&nbsp<B>true</B><BR>&nbsp;&nbsp;&nbsp;kyvos.query.cuboidcache.compression :&nbsp<B>True</B><BR>&nbsp;&nbsp;&nbsp;kyvos.query.nonrelatedfact.ignore :&nbsp<B>true</B><BR>&nbsp;&nbsp;&nbsp;kyvos.cuboid.replication.type :&nbsp<B>None</B><BR>&nbsp;&nbsp;&nbsp;kyvos.query.cuboidcache.tier :&nbsp<B>Disk Backed Off-Heap</B><BR>&nbsp;&nbsp;&nbsp;kyvos.mdx.multidimensional.optimize :&nbsp<B>True</B></P>\n\t\t\t\t\t<BR><P>Inherited Properties:<BR>&nbsp;&nbsp;&nbsp;spark.driver.memory :&nbsp<B>8g</B><BR>&nbsp;&nbsp;&nbsp;spark.dynamicAllocation.minExecutors :&nbsp<B>0</B><BR>&nbsp;&nbsp;&nbsp;kyvos.build.execution.engine :&nbsp<B>Spark</B><BR>&nbsp;&nbsp;&nbsp;spark.executor.cores :&nbsp<B>4</B><BR>&nbsp;&nbsp;&nbsp;spark.yarn.executor.memoryOverhead :&nbsp<B>6144</B><BR>&nbsp;&nbsp;&nbsp;kyvos.number.blank.default :&nbsp<B>0</B><BR>&nbsp;&nbsp;&nbsp;spark.executor.memory :&nbsp<B>20g</B><BR>&nbsp;&nbsp;&nbsp;spark.dynamicAllocation.maxExecutors :&nbsp<B>100</B></P>\n\t\t\t\t\t<BR><P>Default Properties:<BR>&nbsp;&nbsp;&nbsp;kyvos.build.clustering.maxlength :&nbsp<B>4</B><BR>&nbsp;&nbsp;&nbsp;kyvos.build.speculative.enabled :&nbsp<B>False</B><BR>&nbsp;&nbsp;&nbsp;kyvos.build.aggregate.storage.optimized :&nbsp<B>False</B><BR>&nbsp;&nbsp;&nbsp;kyvos.dim.shared.member.identifier :&nbsp<B>~</B><BR>&nbsp;&nbsp;&nbsp;kyvos.split.combination :&nbsp<B>False</B><BR>&nbsp;&nbsp;&nbsp;kyvos.build.aggregation.persistSummary :&nbsp<B>True</B><BR>&nbsp;&nbsp;&nbsp;kyvos.build.dimension.hop :&nbsp<B>0:2,2:4,4:6,6:8,8:10,10:12,12:14,14:16,16:18,1:3,3:5,5:7,7:9,9:11,11:13,13:15,15:17,17:19</B><BR>&nbsp;&nbsp;&nbsp;kyvos.build.sample.percent :&nbsp<B>0.01</B><BR>&nbsp;&nbsp;&nbsp;kyvos.cuboid.clustering.blocksize :&nbsp<B>524288</B><BR>&nbsp;&nbsp;&nbsp;kyvos.build.blankvalue.badrow :&nbsp<B>True</B></P>\n\t\t\t\t\t\t"
}
},
"TYPE": "ADVANCED_PROPERTIES"
},
{"MESSAGES": {"MESSAGE": {"TYPE": "INFO",
"content": "Aggregation Strategy :<B> Expert mode </B><BR>&nbsp;&nbsp;&nbsp;Selective hierarchy materialization :<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[tManufacturer].[Hierarchy]:Manufacturer<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Geography].[Hierarchy]:Geography_Implicit_Level<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[DCustomer-Detail].[CustomerHierarchy]:Customer_Name<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Product-Detail].[Hierarchy(Profit)%, : / \\ * | ? % $ ! + = {} < >]:Product_Name<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Time].[Hierarchy]:Date<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"
}
},
"TYPE": "AGGREGATION_STRATEGY"
},
{"MESSAGES": {"MESSAGE": [{"TYPE": "INFO",
"content": "Cube metadata size: <B>158.43 MB</B>"
},
{"TYPE": "INFO",
"content": "Server Version: <B>2022.3 R9_2022.3_dev-08280030</B>"
},
{"TYPE": "INFO",
"content": "Connection Name: <B>DefaultHadoopCluster01</B>"
},
{"TYPE": "INFO",
"content": "Cube Compatibility Version: <B>1</B>"
},
{"TYPE": "INFO",
"content": "<BR><B>Test build details:</B><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Last fact partitions processed:&nbsp<B>3</B><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Minimal aggregation:&nbsp<B>true</B>"
}
]
},
"TYPE": "MISCELLANEOUS"
},
{"MESSAGES": {"MESSAGE": {"TYPE": "INFO",
"content": "{\"total\":{\"cuboidSize\":\"342.45 MB\",\"maxCuboidSize\":\"22.10 MB\",\"avgCuboidSize\":\"14.89 MB\",\"cuboidCount\":23,\"minCuboidSize\":\"4.09 KB\"},\"colOrder\":{\"cuboidSize\":4,\"dimName\":2,\"maxCuboidSize\":6,\"avgCuboidSize\":5,\"cuboidCount\":3,\"minCuboidSize\":7,\"measureDatasetName\":1},\"dimensions\":[{\"cuboidSize\":\"195.54 MB\",\"dimName\":\"Geography\",\"maxCuboidSize\":\"22.10 MB\",\"avgCuboidSize\":\"21.73 MB\",\"cuboidCount\":9,\"minCuboidSize\":\"21.30 MB\",\"measureDatasetName\":\"Product-Sales_Detail_50GB\"},{\"cuboidSize\":\"140.19 MB\",\"dimName\":\"Time\",\"maxCuboidSize\":\"17.68 MB\",\"avgCuboidSize\":\"17.52 MB\",\"cuboidCount\":8,\"minCuboidSize\":\"17.41 MB\",\"measureDatasetName\":\"Product-Sales_Detail_50GB\"},{\"cuboidSize\":\"6.70 MB\",\"dimName\":\"DCustomer-Detail\",\"maxCuboidSize\":\"3.35 MB\",\"avgCuboidSize\":\"3.35 MB\",\"cuboidCount\":2,\"minCuboidSize\":\"3.34 MB\",\"measureDatasetName\":\"Product-Sales_Detail_50GB\"},{\"cuboidSize\":\"17.61 KB\",\"dimName\":\"Product-Detail\",\"maxCuboidSize\":\"8.81 KB\",\"avgCuboidSize\":\"8.81 KB\",\"cuboidCount\":2,\"minCuboidSize\":\"8.80 KB\",\"measureDatasetName\":\"Product-Sales_Detail_50GB\"},{\"cuboidSize\":\"8.26 KB\",\"dimName\":\"tManufacturer\",\"maxCuboidSize\":\"4.17 KB\",\"avgCuboidSize\":\"4.13 KB\",\"cuboidCount\":2,\"minCuboidSize\":\"4.09 KB\",\"measureDatasetName\":\"Product-Sales_Detail_50GB\"}]}"
}
},
"TYPE": "CUBOID_DETAILS"
},
{"MESSAGES": "",
"TYPE": "BUILD_INPUTS"
},
{"MESSAGES": "",
"TYPE": "TIME_INFO"
}
]
},
"BUILD_STATUS": "SUCCESSFUL"
}
},
"SUB_TYPE": "CUBE",
"TYPE": "ANALYTICAL",
"INSTANCE_ID": "D9639F71-E256-3CD7-3803-67C5D3A61DD8"
}
}
}
}

Execute Data Profiling on Semantic Model

This API is used to execute data profiling job for the semantic model.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model of which you want to profile data.
smodelName	string Name of the semantic model of which you want to profile data.
folderName	string Folder name of the semantic of which you want to profile data.
folderId	string Folder id of the semantic model of which you want to profile data.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

runType	string Default: "NOW" Enum: "NOW" "ONCE" Job frequency to run (NOW/ONCE) Default Value: NOW Now: This will immediately start the job Once: Job will run at the specified time
onceDateTime	string Date time in format (09/20/2014 17:25) Required when runType is ONCE
userParams	string The parameters info which is to be used in semantic model data profiling. Value in JSON should be passed. Example: [ { "name": "parameterName", "value": "parameterValue" } ]
jobConnectionName	string Name of job connection.
dataProfileJson	object Data profile settings in string formatted JSON object. { "samplingOptions": "SAMPLE/ALL", "fieldsGroup": "COMPLETE / ALLDIMENSIONS /CUSTOM", "fields": [ { "fieldId": "id of element", "fieldType": "DIMENSION/LEVEL/ATTRIBUTE/MEASURE/MEASURE_GROUP", "displayName": "name of element", "parentName": "display name of parent element required for Levels,attributes & measures" } ] }

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Data profile job added successfully.",
"CODE": 0
}

Get Aggregates

This API is used to get aggregates XML with respect to the semantic model entity.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model object. Either smodelId or smodelName is mandatory to get the semantic model object
smodelName	string Name of the semantic model of which you want to get the object
folderName	string Folder name of the semantic model of which you want to get the object.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/xml

<RESPONSE>
    <ENTITIES>
    <ENTITY ID="16027542124359127032012146854717" SUB_TYPE="CUBE" TYPE="ANALYTICAL">
        <AGGREGATION_STRATEGY TYPE="QUERY_DRIVEN">
            <QUERY_DRIVEN>
                <AGGREGATES_DEF_ID>
                    <![CDATA[16028500517512AGGREGATION235746]]>
                </AGGREGATES_DEF_ID>
                <AGGREGATES_COUNT>
                    <![CDATA[14]]>
                </AGGREGATES_COUNT>
                <LAST_ACCEPTED_TIME>
                    <![CDATA[10/16/2020 05:07:52]]>
                </LAST_ACCEPTED_TIME>
            </QUERY_DRIVEN>
        </AGGREGATION_STRATEGY>
        <AGGREGATE_INFOS>
            <AGGREGATE_INFO>
                <![CDATA[{"AGGREGATE_ID":"16038722479529AGGREGATION351759","AGGREGATION_SUMMARY":"{\"ORDERED_DIMS\":{\"15821179570596127084040176656597\":\"DIM_698~DIM_175~DIM_240~DIM_266~DIM_291~DIM_490~DIM_502~DIM_188~DIM_527~DIM_303~DIM_342~DIM_358\",\"15821168436916127054085189816798\":\"DIM_621~DIM_175~DIM_240~DIM_266~DIM_291~DIM_188~DIM_303~DIM_342~DIM_358\",\"15821163182138127072036116411602\":\"DIM_240~DIM_303~DIM_458\",\"15821167288096127053016188722790\":\"DIM_240~DIM_815~DIM_763~DIM_906~DIM_945\",\"15821172402147127077045148224334\":\"DIM_606~DIM_240~DIM_266~DIM_291~DIM_490~DIM_502~DIM_188~DIM_527~DIM_303~DIM_342~DIM_358\"},\"AGGREGATES_COUNT\":\"14\",\"ORIENTATION_INFO\":\"1\",\"AGGREGATES\":[{\"15821179570596127084040176656597\":{\"DIM_240\":[{\"DIMENSIONS\":[{\"DIMENSION\":{\"FIELDS\":[{\"LEVEL\":{\"UNIQUE_NAME\":\"DIM_188_Implicit_Level\",\"NAME\":\"Product_Implicit_Level\"}}],\"UNIQUE_NAME\":\"DIM_188\",\"NAME\":\"Product{\"MEASURE\":{\"UNIQUE_NAME\":\"MEASURE_1472\",\"NAME\":\"Extended AmountD\"}},{\"MEASURE\":{\"UNIQUE_NAME\":\"MEASURE_1473\",\"NAME\":\"Standard Product CostD\"}},{\"MEASURE\":{\"UNIQUE_NAME\":\"MEASURE_1474\",\"NAME\":\"Total Product CostD\"}},{\"MEASURE\":{\"UNIQUE_NAME\":\"MEASURE_1475\",\"NAME\":\"Sales AmountD\"}},{\"MEASURE\":{\"UNIQUE_NAME\":\"MEASURE_1476\",\"NAME\":\"Tax AmountD\"}},{\"MEASURE\":{\"UNIQUE_NAME\":\"MEASURE_1477\",\"NAME\":\"Freight CostD\"}},{\"MEASURE\":{\"UNIQUE_NAME\":\"MEASURE_1478\",\"NAME\":\"Transaction Cost\"}},{\"MEASURE\":{\"UNIQUE_NAME\":\"MEASURE_3767\",\"NAME\":\"Order Count\"}}],\"UNIQUE_NAME\":\"MEASURE\",\"NAME\":\"MEASURE\"}},\"AGGREGATE_STATUS\":\"Not Modified\",\"ID\":-2077199616}],\"DIM_175\":[{\"DIMENSIONS\":[{\"DIMENSION\":{\"FIELDS\":[{\"LEVEL\":{\"UNIQUE_NAME\":\"DIMENSION_LEVEL_648\",\"NAME\":\"Country\"}}],\"UNIQUE_NAME\":\"DIM_175\",\"NAME\":\"Customer\"}},{\"DIMENSION\":{\"FIELDS\":[{\"LEVEL\":{\"UNIQUE_NAME\":\"DIM_240_ALL\",\"NAME\":\"Date_ALL\"}},{\"LEVEL\":{\"UNIQUE_NAME\":\"DIM_240_Implicit_Level\",\"NAME\":\"Date_ATTR_]}}]}"}]]>
            </AGGREGATE_INFO>
    </AGGREGATE_INFOS>
    </ENTITY>
    </ENTITIES>
</RESPONSE>

Save Aggregates

This API is used to save aggregates information with the given semantic model entity. As this API performs bulk operation, you must have privileges to import and export objects to use this API.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/json or application/xml
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request value: 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 schema: application/x-www-form-urlencoded

aggregatesXML

required

object

Aggregates information to be saved.

For e.g.

      <ENTITY ID="16027542124359127032012146854717" SUB_TYPE="CUBE" TYPE="ANALYTICAL">

          <AGGREGATION_STRATEGY TYPE="QUERY_DRIVEN">

              <QUERY_DRIVEN>

                  <AGGREGATES_DEF_ID>

                      <![CDATA[16028500517512AGGREGATION235746]]>

                  </AGGREGATES_DEF_ID>

                  <AGGREGATES_COUNT>

                      <![CDATA[14]]>

                  </AGGREGATES_COUNT>

                  <LAST_ACCEPTED_TIME>

                      <![CDATA[10/16/2020 05:07:52]]>

                  </LAST_ACCEPTED_TIME>

              </QUERY_DRIVEN>

          </AGGREGATION_STRATEGY>

          <AGGREGATE_INFOS>

              <AGGREGATE_INFO>

                  <![CDATA[{"AGGREGATE_ID":"16038722479529AGGREGATION351759","AGGREGATION_SUMMARY":"{"ORDERED_DIMS":{"15821179570596127084040176656597":"DIM_698DIM_175DIM_240DIM_266DIM_291DIM_490DIM_502DIM_188DIM_527DIM_303DIM_342DIM_358","15821168436916127054085189816798":"DIM_621DIM_175DIM_240DIM_266DIM_291DIM_188DIM_303DIM_342DIM_358","15821163182138127072036116411602":"DIM_240DIM_303DIM_458","15821167288096127053016188722790":"DIM_240DIM_815DIM_763DIM_906DIM_945","15821172402147127077045148224334":"DIM_606DIM_240DIM_266DIM_291DIM_490DIM_502DIM_188DIM_527DIM_303DIM_342~DIM_358"},"AGGREGATES_COUNT":"14","ORIENTATION_INFO":"1","AGGREGATES":[{"15821179570596127084040176656597":{"DIM_240":[{"DIMENSIONS":[{"DIMENSION":{"FIELDS":[{"LEVEL":{"UNIQUE_NAME":"DIM_188_Implicit_Level","NAME":"Product_Implicit_Level"}}],"UNIQUE_NAME":"DIM_188","NAME":"Product{"MEASURE":{"UNIQUE_NAME":"MEASURE_1472","NAME":"Extended AmountD"}},{"MEASURE":{"UNIQUE_NAME":"MEASURE_1473","NAME":"Standard Product CostD"}},{"MEASURE":{"UNIQUE_NAME":"MEASURE_1474","NAME":"Total Product CostD"}},{"MEASURE":{"UNIQUE_NAME":"MEASURE_1475","NAME":"Sales AmountD"}},{"MEASURE":{"UNIQUE_NAME":"MEASURE_1476","NAME":"Tax AmountD"}},{"MEASURE":{"UNIQUE_NAME":"MEASURE_1477","NAME":"Freight CostD"}},{"MEASURE":{"UNIQUE_NAME":"MEASURE_1478","NAME":"Transaction Cost"}},{"MEASURE":{"UNIQUE_NAME":"MEASURE_3767","NAME":"Order Count"}}],"UNIQUE_NAME":"MEASURE","NAME":"MEASURE"}},"AGGREGATE_STATUS":"Not Modified","ID":-2077199616}],"DIM_175":[{"DIMENSIONS":[{"DIMENSION":{"FIELDS":[{"LEVEL":{"UNIQUE_NAME":"DIMENSION_LEVEL_648","NAME":"Country"}}],"UNIQUE_NAME":"DIM_175","NAME":"Customer"}},{"DIMENSION":{"FIELDS":[{"LEVEL":{"UNIQUE_NAME":"DIM_240_ALL","NAME":"Date_ALL"}},{"LEVEL":{"UNIQUE_NAME":"DIM_240_Implicit_Level","NAME":"Date_ATTR_]}}]}"}]]>

              </AGGREGATE_INFO>

          </AGGREGATE_INFOS>

      </ENTITY>

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"RES": [{"MESSAGE": "Successfully added semantic model aggregates",
"CODE": 0,
"ENTITY_ID": 1.6738468902733127e+31,
"EXT_MESSAGE": ""
},
{"MESSAGE": "Successfully added semantic model aggregates",
"CODE": 0,
"ENTITY_ID": 1.6826783821132128e+31,
"EXT_MESSAGE": ""
}
]
}
}

Get Cache Population Rules

This API is used to get cache population rules XML with respect to the semantic model entity.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model object. Either smodelId or smodelName is mandatory to get the semantic model object
smodelName	string Name of the semantic model of which you want to get the object
folderName	string Name of the folder from which you want to get the semantic model. If the semantic model is present on the root directory, give the folder name as [Root]

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/xml

<RESPONSE>
  <ENTITIES>
          <ENTITY ID="15639500788366127066047191013171" SUBTYPE="CUBE" TYPE="ANALYTICAL">
      <RULES>
      <RULE CACHE_ACTION="REPOPULATE_CACHE" CACHE_ON_CUBE_REBUILD="NONE" ID="16037484241013123417809" PRECAHE_SQL_CASCADING_FILTERS="YES" TYPE="HISTORICAL">
  <FILTERS MAXROWS="">
  </FILTERS></RULE>
  </RULES>
  </ENTITY>
  </ENTITIES>
</RESPONSE>

Save Cache Population Rules

This API is used to save cache population rules information with the given semantic model entity.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/json" "application/xml" Example: application/xml Supported response types are JSON or XML. Possible value: application/json or application/xml
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request value: 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 schema: application/x-www-form-urlencoded

cachePopulationRuleXML

required

string

Cache Population information to be saved.
For e.g.

 <ENTITY ID="15639500788366127066047191013171" SUBTYPE="CUBE" TYPE="ANALYTICAL">

              <RULES>

                  <RULE CACHE_ACTION="REPOPULATE_CACHE" CACHE_ON_CUBE_REBUILD="NONE" ID="16037484241013123417809" PRECAHE_SQL_CASCADING_FILTERS="YES" TYPE="HISTORICAL">

                      <FILTERS MAXROWS=""></FILTERS>

                  </RULE>

              </RULES>

          </ENTITY>

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"RES": [{"MESSAGE": "Successfully updated  rules",
"CODE": 0,
"ENTITY_ID": 16738467644739660000,
"EXT_MESSAGE": "Successfully updated"
}
]
}
}

Save Recommendations

This API is used to save recommendations on the same semantic model or generate a new copy of it.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Semantic model id on which need to apply recommendation
smodelName	string Semantic model name on which need to apply recommendation
folderId	string Folder id on which need to apply recommendation
folderName	string Folder name on which need to apply recommendation

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

materializationLevel	string Enum: "high" "medium" "low" High Materialization level will create more aggregates giving better query performance, but it increases semantic model process size. Low materialization will create less aggregates, resulting in reduced semantic model process size, but all queries may not perform fast. Possible Values: `high` `medium` `low`
recommendationType	string Enum: "completeDesign" "onlyAggregationStrategy" "onlyAdditionalAgreegates (Aggregatoin Strategy = Smart)" "onlyPhysicalView" "onlyPartitionStrategy" The type of recommendation. Possible values: `completeDesign`: Complete semantic model design will be recommended and updated (Physical view, Partition strategy & Aggregation strategy) `onlyAggregationStrategy`: Only Aggregation strategy will be recommended and updated. `onlyAdditionalAgreegates`: Only additional aggregates will be recommended and updated, only applicable in smart mode. `onlyPhysicalView`: Only Physical View will be recommended and updated. `onlyPartitionStrategy`: Only Partition Strategy will be recommended and updated.
aggregation Strategy	string Need to take recommendation either in Expert or smart mode
createCopy	boolean Enum: true false True if need to create new semantic model, false if need to apply recommendation on same semantic model.
queryFilters	object Pass the following input in json format. For e.g. { "QueryDays": "10", "queryTimeThreshold": "245", "selectedUsers": "ankit,ashish", "IncludeAdditionalQueries": "true" }

Responses

Get Partition Strategy

This API is used to get fact wise partition strategy for a semantic model.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model object. Either smodelId or smodelName is mandatory to get the semantic model object.
smodelName	string Name of the semantic model of which you want to get the object
folderName	string Name of the folder from which you want to get the semantic model. If the semantic model is present on the root directory, give the folder name as [Root]

header Parameters

Accept required	string Value: "application/json" Example: application/json Supported response type is JSON. Possible value: application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"14823984009460127044035111861522": {"partitionStrategy": [{"name": "date",
"id": "DIM_230166!!!H_678469!!!DIMENSION_LEVEL_314482",
"type": "LEVEL",
"isBasePartition": "true"
}
],
"name": "fact"
}
}

Get Partition List

This API is used to get list of partitions created on a semantic model.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model object of which you want to get the partition list. Either smodelId or smodelName is mandatory to get the semantic model partition list.
smodelName	string Name of the semantic model of which you want to get the partition list.
folderName	string Name of the folder of the semantic model of which you want to get the partition list.
folderId	string Id of the folder of the semantic model of which you want to get the partition list.

header Parameters

Accept required	string Value: "application/json" Example: application/json Supported response types are JSON. Possible values: application/json
sessionid	string The session id is the token received from the login API. Note: Session id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"partitions": [{"caption": "2013",
"id": "44",
"factName": ""
},
{"caption": "2012",
"id": "43",
"factName": ""
},
{"caption": "2011",
"id": "42",
"factName": ""
},
{"caption": "2010",
"id": "41",
"factName": ""
}
]
}

Cancel Job

This API is used to cancel jobs on the semantic model.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model of which you want to cancel job. If you do not know the smodelId, use the smodelName and folderName/folderId.
smodelName	string Name of the semantic model of which you want to cancel job.
folderName	string Folder name of the semantic model of which you want to cancel job.
folderId	string Folder id of the semantic model of which you want to cancel job.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Cancel job success.",
"CODE": 0
}

Resume Semantic Model Job

This API is used to resume semantic model job if any resumable failed job is present in job history.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model of which you want to resume job. If you do not know the smodelId, use the smodelName and folderName/folderId.
smodelName	string Name of the semantic model of which you want to resume job.
folderName	string Folder name of the semantic model of which you want to resume job.If semantic model is present in root directory then provide [Root] as its value. If no value is provided then semantic model will be searched in root directory.
folderId	string Folder id of the semantic model of which you want to resume job.

header Parameters

Accept required	string Enum: "application/xml" "application/job" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully resumed semantic model job.",
"CODE": 0
}

Get Semantic Model Advanced Properties

This API is used to get Semantic Model Advanced Properties.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model of which you want to get the advanced properties. If you do not know the smodelId, use the smodelName and folderName/folderId.
smodelName	string Name of the semantic model of which you want to get the advanced properties
folderName	string Name of the folder of semantic model of which you want get the advanced properties. If the semantic model is present on the root directory, give the folder name as [Root]
folderId	string Folder id of the semantic model of which you want to get the advanced properties.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"PROPERTIES": ""
}
}

Add or Update Semantic Model Advanced Properties

This API is used to add or update semantic model advanced properties.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model of which you want to update advanced properties. If you do not know the smodelId, use the smodelName and folderName/folderId.
smodelName	string Name of the semantic model of which you want to update the advanced properties.
folderName	string Name of the folder of semantic model. If the semantic model is present on the root directory, give the folder name as [Root]
folderId	string Folder id of the semantic model.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

propertyJSON

required

object

propertyJSON should be a valid JSON array having objects with name and value. "name" is the property name and "value" is property value.

for e.g.

 [
  {
    "name": "kyvos.build.precompute.hierarchy.levels",
    "value": "Kyvos_GIS_UpToZip.H_Kyvos_GIS_UpToZip"
  }
]

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully updated entity level properties",
"CODE": 0
}

Update Properties of Semantic Model

This API is used to update one or more properties of the semantic model. For example DESCRIPTION property, TAGS property etc.
Note - User should provide either "smodelId" or "smodelName" and "folderName" details.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

smodelId	string Id of the semantic model for which you want to update properties. If you do not know the semantic model id, use the semantic model name and folder name.
smodelName	string Name of the semantic model for which you want to update properties.
folderName	string Folder name of the cube for which you want to update properties.
propertyJSON required	object JSON containing an array of property name and their values. For e.g. [ { "name": "DESCRIPTION", "value": "description" }, { "name": "TAGS" "value": "tag" } ]

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully updated properties of the semantic model.",
"CODE": 0
}

Add and Update Calculated Measures

This API is used to add/update calculated measures in a semantic model. The API will only add/update calculated measures. If the measure is not calculated, then any update in that measure will be ignored.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model object. Either smodelId or smodelName is mandatory to get the semantic model object.
smodelName	string Name of semantic model object.
folderName	string Name of the folder of semantic model. If semantic model is present in root directory then provide [Root] as its value. If no value is provided then semantic model will be searched in root directory.
folderId	string Folder id from which you want to get the semantic model object.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

measureJSON

object

A JSON string containing the name of the measure as key and another JSON containing the properties of the measure as value.

The input for format type would be a numerical value with mapping as
2-Number
3-Currency
4-Date
5-Time
6- Percentage
7-Scientific
9-Custom
10-Duration

The input for nonEmptyBehaviour should be as follows
BY_EXPRESSION-Expression must evaluate itself to determine whether the calculated measure is empty.
BY_MEASURE-When you specify one or more measures in the list, Kyvos treats the calculated measure as empty if all the specified measures are empty.
BY_MEASURE_THEN_EXPRESSION-Treats the calculated measure as empty if values of all the specified measures are empty or if the calculated value of the expression is empty.

Sample JSON

{
  "measureName1": {
    "expression": "expression1",

    "description": "description1",

    "groupName": "groupName1",

    "groupDescription": "groupDescription1",

    "solveOrder": "solveOrder1",

    "formatType": "formatType1",

    "format": "format1",

    "isVisible": "true/false",

    "nonEmptyBehaviour": "nonEmptyBehaviour1",

    "nonEmptyMeasures": "nonEmptyMeasures1"
  },
  "measureName2": {
    "expression": "expression2",

    "description": "description2",

    "groupName": "groupName2",

    "groupDescription": "groupDescription2",

    "solveOrder": "solveOrder2",

    "formatType": "formatType2",

    "format": "format2",,

    "isVisible": "true/false"

    "nonEmptyBehaviour": "nonEmptyBehaviour2",

    "nonEmptyMeasures": "nonEmptyMeasures2"
  }
}

validate

boolean

Default: false

Enum: true false

A boolean flag, whether to validate measure expression or not. Note: Expressions will only be validated if the semantic model is built.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully replaced semantic model object: Untitled Semantic Model 1",
"CODE": 0
}

Get Calculated Measures

This API is used to get calculated measures from a semantic model.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model object. Either smodelId or smodelName is mandatory to get the semantic model object.
smodelName	string Name of semantic model object.
folderName	string Folder name from which you want to get semantic model object.
folderId	string Folder id from which you want to get the semantic model object.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Request Body schema: application/x-www-form-urlencoded

measureNames

string

Default: ""

Comma separated names of measures which you want to fetch. If this value is not provided then all measures will be fetched.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"MEASURES": {"MEASURE": {"DICTIONARY_TYPE": "INDEX",
"FORMAT": {"USEDEFAULT": 0,
"content": "#,##0.00"
},
"DISPLAY_FOLDER": "",
"MINON_MAXON_DATAFIELD": {"QUERY_NAME": "",
"QUERY_ID": ""
},
"ISVISIBLE": true,
"ISDEFAULT": false,
"DESCRIPTION": "",
"COLOR": "",
"ISADJUSTMENT": false,
"ID": "MEASURE_37",
"UNIQUENAME": "MEASURE_37",
"TYPE": "STANDARD",
"IS_ACCESSIBLE": true,
"SUBTYPE": "",
"SOLVE_ORDER": 0,
"UNIT": "",
"SUMMARYFUNCTION": "",
"RESTRICT": false,
"ADJUSTMENT_TYPE": "NEGATIVE",
"NON_EMPTY_MEASURES": "MEASURE_35966",
"NAME": "GrandTotal",
"MATERIALIZE": "",
"DATATYPE": "NUMBER",
"FORMATTYPE": "2",
"DATAFIELD": {"QUERY_NAME": "",
"QUERY_ID": ""
},
"EXPRESSION": {"NON_EMPTY_BEHAVIOR": "BY_MEASURE",
"content": "AllValue([Measures].[Sale_Amount])"
},
"IS_BOUNDARY_DIST_COUNT": "false"
}
}
}
}

Delete Calculated Measures

This API is used to delete calculated measures from a semantic model.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model object. Either smodelId or smodelName is mandatory to get the semantic model object.
smodelName	string Name of semantic model object.
folderName	string Folder name from which you want to get semantic model object.
folderId	string Folder id from which you want to get the semantic model object.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Request Body schema: application/x-www-form-urlencoded

measureNames	string Default: "" Comma separated names of measures which you want to delete. one of measureNames and deleteAll must be provided.
deleteAll	boolean Default: false It's an optional parameter, when provided, all the calculated measures will be deleted. When both measureNames and deleteAll are provided, deleteAll will be used.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully replaced semantic model object: cube1",
"CODE": 0
}

Get Calculated Members

This API is used to get calculated members from a semantic model.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model object. Either smodelId or smodelName is mandatory to get the semantic model object.
smodelName	string Name of semantic model object.
folderName	string Folder name from which you want to get semantic model object.
folderId	string Folder id from which you want to get the semantic model object.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Request Body schema: application/x-www-form-urlencoded

memberJSON

string

Default: ""

A JSON array containing JSON objects with details of calculated members to be fetched . Example:

[

{

"memberName": "MemberName1",

"dimensionName": "Geography",

"type": "HIERARCHY",

"hierarchyName": "Hierarchy"
},

{

"memberName": "ATTRMEMBER",

"dimensionName": "Geography",

"type": "ATTRIBUTE",

"attributeName": "Region"

}

]

Responses

Response samples

200

Content type

application/xml

<RESPONSE>
      <CALCULATED_MEMBERS>

          <CALC_MEMBER ID="CALC_MEMBER_1" SOLVE_ORDER="">
  
              <NAME>
  
                  <![CDATA[MemberName1]]>
  
              </NAME>
  
              <EXPRESSION>
  
                  <![CDATA[sfsdfdsf]]>
  
              </EXPRESSION>
  
              <PARENT_MEMBER_UNAME PARENT_ID="[Geography].[Hierarchy]">
  
                  <![CDATA[ALLMEMBER]]>
  
              </PARENT_MEMBER_UNAME>
  
              <PARENT_HRCH>
  
                  <![CDATA[DIMENSION_HIERARCHY_11]]>
  
              </PARENT_HRCH>
  
              <PARENT_LEVEL_MEMB>
  
                  <![CDATA[ALLMEMBER]]>
  
              </PARENT_LEVEL_MEMB>
  
              <LAT>
  
                  <![CDATA[]]>
  
              </LAT>
  
              <LONG>
  
                  <![CDATA[]]>
  
              </LONG>
  
              <DESCRIPTION>
  
                  <![CDATA[]]>
  
              </DESCRIPTION>
  
          </CALC_MEMBER>
  
      </CALCULATED_MEMBERS>
  
  </RESPONSE>

Delete Calculated Members

This API is used to delete calculated members from a semantic model.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model object. Either smodelId or smodelName is mandatory to get the semantic model object.
smodelName	string Name of semantic model object.
folderName	string Folder name from which you want to get semantic model object.
folderId	string Folder id from which you want to get the semantic model object.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Request Body schema: application/x-www-form-urlencoded

memberJSON

string

Default: ""

A JSON array containing JSON objects with details of calculated members to be deleted . Example:

[

{

"memberName": "MemberName1",

"dimensionName": "Geography",

"type": "HIERARCHY",

"hierarchyName": "Hierarchy"
},

{

"memberName": "ATTRMEMBER",

"dimensionName": "Geography",

"type": "ATTRIBUTE",

"attributeName": "Region"

}

]

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully replaced semantic model object: cube1",
"CODE": 0
}

Add and Update Calculated Members

This API is used to add/update calculated member in a semantic model. The API will only add/update calculated member. If the member is not calculated, then any update in that member will be ignored.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model object. Either smodelId or smodelName is mandatory to get the semantic model object.
smodelName	string Name of semantic model object.
folderName	string Name of the folder of semantic model. If semantic model is present in root directory then provide [Root] as its value. If no value is provided then semantic model will be searched in root directory.
folderId	string Folder id of the semantic model of which you want to get the object

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

memberJSON	string A JSON string containing the name of the calculated member as a key and another JSON object containing other required information including a description key for providing details of the calculated member. The value for the description key should be String with a character limit of 200. Structure of member JSON: { "memberName1": { "dimensionName": "", "type": "Type can be HIERARCHY or ATTRIBUTE", "hierarchyName": "Needed in case of type=HIERARCHY and having multiple hierarchies", "attributeName": "Needed when type is ATTRIBUTE", "parentMember": "Not needed in case of ALLMEMBER. Should be in the form of [Level name].fully qualified name", "expression": "", "solveOrder": "", "description": "Description for memberName1" } }
validate	boolean Default: false Enum: true false A Boolean flag, whether to validate member expression OR not. Note: Expressions will only be validated if the cube is built.
save	boolean Default: false Enum: true false A Boolean flag, whether to save member expression OR not.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully replaced semantic model object: Untitled Semantic Model 1",
"CODE": 0
}

Get Job Execution Status List

This API is used to get status of all the jobs executed on a semantic model.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model of which you want the status of executed jobs.
smodelName	string Name of the semantic model of which you want the status of executed jobs.
folderName	string Folder name of the semantic model of which you want the status of executed jobs.
folderId	string Folder id of the semantic model of which you want the status of executed jobs.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"DATA": {"INQUEUEJOBS": "",
"JOBEXECUTIONSTATUS": {"UPCOMINGJOBS": "",
"HISTORY": {"HISTORYITEM": [{"HISTORY_ID": "8E824B07-8618-3630-7867-928E97FCD18F",
"IS_IDEAL_BUILD": false,
"STATUS": "CANCELED",
"FREQUENCY_TYPE": "NOW",
"SCHEDULED_TIME": "09/11/2023 21:55:44",
"RUNTIME": "09/11/2023 22:14:34",
"BUILD_TYPE": "DATA_PROFILE",
"USER_NAME": "Admin",
"TAGS": "latest"
}
]
}
}
}
}

Get Filtered List of Job Execution Status

This API is used to get status of the jobs executed on a semantic model. User can filter jobs using jobFilterJson parameter.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model of which you want the status of executed jobs.
smodelName	string Name of the semantic model of which you want the status of executed jobs.
folderName	string Folder name of the semantic model of which you want the status of executed jobs.
folderId	string Folder id of the semantic model of which you want the status of executed jobs.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Request Body schema: application/x-www-form-urlencoded

jobFilterJson

object

Job filters in string formatted JSON.
Example:

[ {
"fieldName":"BUILD_TYPE",
"operation":"INLIST",
"dataType":"CHAR",
"firstValue":"'CACHE_POPULATION'"
},
{
"fieldName":"ORIGINAL_RUNTIME",
"operation":"LAST",
"dataType":"NUMBER",
"firstValue":"3000"
},
{
"fieldName":"ELAPSED_TIME",
"operation":"BETWEEN",
"dataType":"NUMBER",
"firstValue":"1000",
"secondValue":"100000"
},
{
"fieldName":"OVERALL_STATUS",
"operation":"INLIST",
"dataType":"CHAR",
"firstValue":"'Success', 'CANCELED'"
},
{
"fieldName":"USER_ID",
"operation":"STARTSWITHIGNORECASE",
"dataType":"CHAR",
"firstValue":"'a'"
},
{
"fieldName":"TAGS",
"operation":"EQUALSIGNORECASE",
"dataType":"CHAR",
"firstValue":"latest"
}
]

Responses

Response samples

200

Content type

application/json

{"DATA": {"INQUEUEJOBS": "",
"JOBEXECUTIONSTATUS": {"UPCOMINGJOBS": "",
"HISTORY": {"HISTORYITEM": [{"HISTORY_ID": "CC25863F-CE2A-F9AC-8F9F-55F4FC82AA75",
"IS_IDEAL_BUILD": false,
"STATUS": "SUCCESSFUL",
"FREQUENCY_TYPE": "NOW",
"SCHEDULED_TIME": "07/07/2023 10:37:47",
"RUNTIME": "07/07/2023 10:55:31",
"BUILD_TYPE": "DATA_PROFILE",
"USER_NAME": "Admin",
"TAGS": "latest"
},
{"HISTORY_ID": "3732C536-2AB1-3B4A-022B-430505F048EB",
"IS_IDEAL_BUILD": false,
"STATUS": "CANCELED",
"FREQUENCY_TYPE": "NOW",
"SCHEDULED_TIME": "06/09/2023 13:39:55",
"RUNTIME": "06/09/2023 13:44:50",
"BUILD_TYPE": "FULL_TEST",
"USER_NAME": "Admin",
"TAGS": "latest"
}
]
}
}
}
}

Get Dataset List

This API is used to get JSON list of all the datasets currently used in semantic model design.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model of which you want to get the dataset list.
smodelName	string Name of the semantic model of which you want to get the dataset list.
folderName	string Folder name of the semantic model of which you want to get the dataset list.
folderId	string Folder id of the semantic model of which you want to get the dataset list.
datasetType	string Enum: "ALL_DATASETS" "ALL_FACT_DATASETS" "PARTITIONED_FACT_DATASETS" "ALL_DIMENSION_DATASETS" Additional filter to get filtered list. `ALL_DATASETS`: Datasets which are used in the semantic model for creating dimensions or measures `ALL_DIMENSION_DATASETS`: Datasets which are used in the semantic model for creating dimensions. `ALL_FACT_DATASETS`: Datasets which are used in the semantic model for creating measures `PARTITIONED_FACT_DATASETS`: Datasets which are used in the semantic model for creating measures and are related with the dimension which is used to create base partition in semantic model (Partition Strategy)

header Parameters

Accept required	string Value: "application/json" Example: application/json Supported response type is JSON. Possible value: application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

[{"name": "Product-Sales_Detail_50GB",
"id": "14078499836997127032066196431512",
"type": "FACT"
}
]

Get Scripts

This API is used to get all the scripts currently saved in a semantic model.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model of which you want to get the scripts
smodelName	string Name of the semantic model of which you want to get the scripts
folderName	string Folder name of the semantic model of which you want to get the scripts.
folderId	string Folder id of the semantic model of which you want to get the scripts

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON and XML. Possible values: application/json or application/xml
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

[{"expression": "SCOPE(subcube_expression1); \n\t This = [Mdx_statement]; \nEND SCOPE;",
"name": "DEFAULT_SCRIPT",
"disabled": false
}
]

Add/Update Scripts

This API is used to add or update the script in a semantic model.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model to which you want to add scripts
smodelName	string Name of the semantic model to which you want to add scripts
folderName	string Folder name of the semantic to which you want to add scripts
folderId	string Folder id of the semantic model to which you want to add scripts

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

scripts

object

The script info which is to be added in semantic model
For example:

 [
   {
     "expression": "SCOPE(subcube_expression1); \n\t This = [Mdx_statement]; \nEND SCOPE;",
     "name": "DEFAULT_SCRIPT",
     "disabled": false
   }
 ]

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Script added/updated successfully",
"CODE": 0
}

Delete Script

This API is used to delete an existing script in semantic model.

Authorizations:

sessionIdbasicAuth

path Parameters

scriptName

required

string

Example: DEFAULT_SCRIPT

Name of script to be deleted.

query Parameters

smodelId	string Id of the semantic model of which you want to delete the script
smodelName	string Name of the semantic model of which you want to delete the script
folderName	string Folder name of the semantic model of which you want to delete the script
folderId	string Folder id of the semantic model of which you want to delete the script

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON. Possible values: application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Script deleted successfully",
"CODE": 0
}

Copy Semantic Model

This API is used to copy the semantic model in the desired destination folder.
Note - User should provide either "sourceSmodelId" or "sourceSmodelName" and "sourceFolderName" details.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

sourceSmodelId	string Id of the semantic model for which you want to create a copy. If you do not know the semantic model id, use the semantic model name and folder name.
sourceSmodelName	string Name of the semantic model for which you want to create a copy.
sourceFolderName	string Folder name of the semantic model for which you want to create a copy.
targetSmodelName required	string Name of the target semantic model that you want to create.
targetFolderId	string Target folder id where you want to create the copy.
targetFolderName	string Target folder name where you want to create the copy.
copyLinkedData	boolean Default: false Enum: true false A flag to indicate whether the historical queries of the source semantic model should be linked to the new semantic model or not.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Semantic model copied successfully.",
"CODE": 0
}

Validate Semantic Model

This API is used for semantic model validation.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

smodelId	string Id of semantic model which you want to be validated. If smodelId isn't available, use smodelName and folderName.
smodelName	string Name of the semantic model which you want to get validated.
folderName	string Name of the folder from which you want to validate semantic model.
propertiesXML	string Properties XML if properties needs to be validated along with semantic model.
jobType	string Type of job validations that are required (Valid values: "UPDATE_AGGREGATES"/"INCREMENTAL")
incrementalType	string Type of incremental job validations that are to be done (Valid value: "FACT_ADJUSTMENTS")
validateDependentEntities	string If dependent entities are to be validated (Valid values: true/false)
validationType	string Only semantic model design or design with it's impact on subsequent build needs to be validated (Valid value: DESIGN_SUBSEQUENT_BUILD)
smodelViewType	string If validating only physical view of semantic model (Valid value: "PHYSICAL")
physicalViewXML	object XML of physical view of semantic model.
smodelXML	object XML of logical view of semantic model.
requestId	string Request identifier that can be used to track this request.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Semantic model validated successfully",
"CODE": 200,
"VALIDATION_STATUS": "VALID"
}

Rename Semantic Model

This API is used for semantic model rename.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

smodelId	string Id of semantic model which you want rename. If smodelId isn't available, use smodelName and folderName.
smodelName	string Name of the semantic model which you want to rename.
folderName	string Name of the folder from which you want to rename semantic model.
targetName	string Name to which you want semantic model to be renamed.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Semantic model renamed successfully.",
"CODE": 200
}

Download Semantic Model Design Metadata (CAB file)

This REST API is used to download the CAB file which is associated with each build version of the semantic model. The CAB file includes the complete semantic model design plus its source entities like Dataset(s), Relationship.

Authorizations:

sessionIdbasicAuth

query Parameters

hostName required	string Where to find Go to Activity Monitor BI Server/Query Engines on Kyvos. Navigate to the Kyvos Engines tab. Look for the Host Name in the BI Server/Query Engines section. Note: You must choose the same BI Server/Query Engines for all parameters
port required	string Where to find Go to Activity Monitor BI Server/Query Engines on Kyvos. Navigate to the Kyvos Engines tab. Right-click the BI Server/Query Engines and click Show Details. Look for the Rest Port. Note: You must choose the same BI Server/Query Engines for all parameters
instanceName required	string Where to find Go to Activity Monitor BI Server/Query Engines on Kyvos. Navigate to the Kyvos Engines tab. Look for the Instance Name in the BI Server/Query Engines section. Note: You must choose the same BI Server/Query Engines for all parameters
component	string Enum: "olapengine" "queryengine"
metadata	string Downloading Semantic Model Design Metadata (CAB file) CUBE_ID: Id of the semantic model of which you want to get the object. BUILD_VERSION: Open the job summary of the semantic model job for which you want to download the CAB file Look for the Job Number Possible Values: Integer representing job versions like 3, or the integer prepended with keyword v like v3 For e.g. streamservice?service=DOWNLOAD_CAB$%$CUBE_ID={cubeID}$%$BUILD_VERSION={version} Sync Property File metadata: service Change Query Engine Memory Property metadata: service Update Property File and Sync metadata: service
responseType	string Applicable for Downloading Semantic Model Design Metadata (CAB file) Response Type : file
data	string Sync Property File {"SERVICE_NAME":"UPDATE_QE_PROPERTIES", "SYNC_PROPERTIES_WITH_FILE":"true"} Change Query Engine Memory Property {"SERVICE_NAME":"UPDATE_QE_PROPERTIES", "PROPERTIES":"LOG_LEVEL=DEBUG"} Update Property File and Sync {"SERVICE_NAME":"UPDATE_QE_PROPERTIES", "PROPERTIES":"LOG_LEVEL=DEBUG", "UPDATE_PROPERTY_FILE":"true"}

header Parameters

Accept required	string Example: text/plain Supported response types are plain text or html i.e. text/plain or text/html
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Workbooks and Worksheets

Get Workbook Object

This API is used to get Workbook Object.

Authorizations:

sessionIdbasicAuth

query Parameters

workbookName	string Name of the workbook.
workbookId	string Id of the Workbook object.Either workbookId or workbook name is mandatory to get the Workbook object
folderName	string Folder name that contains the requested Workbook Object.
addResponseTag	boolean Default: true Enum: true false Flag whether to wrap response in </ RESPONSE > tag or not.
addWorksheets	boolean Default: false Enum: true false Flag to get the worksheets along with the workbook. This response XML will be used to add or update the workbook along with worksheets. This will also remove any worksheet that becomes an orphan because of the workbook update.
addShortcuts	boolean Default: false Enum: true false Flag to get the shortcuts along with the workbook. This response XML will be used to add or update the workbook along with shortcuts. This will also remove any shortcut that becomes an orphan because of the workbook update.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"IRO": {"SUBTYPE": "",
"CATEGORY_ID": "folder_15846126346430127045094149774657",
"ACCESSRIGHTS": 1,
"FOLDER_ID": "folder_15846126346430127045094149774657",
"NAME": "test workbook",
"FOLDER_NAME": "2020.2 Neha",
"OWNERAPPID": 253292788,
"SPECIFIC": {"WORKBOOK": {"WORKSHEET": [{"ACCESSRIGHTS": 1,
"OWNER": "anshul.sharma",
"OWNERID": "",
"LAST_MODIFIED_TIMESTAMP": 1668769028503,
"LAST_MODIFIED": "11/18/2022 16:27:08",
"ID": "Sheet16542468891052127054089148346546",
"TYPE": "SHEET",
"NAME": "Sheet 2",
"VIZ_TYPE": "BAR"
},
{"ACCESSRIGHTS": 1,
"OWNER": "TestUserNEw 230",
"OWNERID": "",
"LAST_MODIFIED_TIMESTAMP": 1666772460405,
"LAST_MODIFIED": "10/26/2022 13:51:00",
"ID": "Dashboard16667724073616127062098151768133",
"TYPE": "DASHBOARD",
"NAME": "Dashboard 2"
},
{"ACCESSRIGHTS": 1,
"OWNER": "anshul.sharma",
"OWNERID": "",
"LAST_MODIFIED_TIMESTAMP": 1663839742274,
"LAST_MODIFIED": "09/22/2022 15:12:22",
"ID": "Dashboard16542469277181127042098123041856",
"TYPE": "DASHBOARD",
"NAME": "Dashboard 1"
}
]
}
},
"REPOSITDATE": "11/18/2022 16:27:08",
"ISPUBLIC": true,
"COMMON": {"DESC": "description",
"TAGS": "TAG 1"
},
"LINKED_ENTITY_ID": "",
"ID": "Workbook16542466776643127060051168179358",
"OWNERAPPNAME": "admin",
"TYPE": "WORKBOOK"
}
}
}

Get Worksheet Object

This API is used to get worksheet object.

Authorizations:

sessionIdbasicAuth

query Parameters

worksheetId	string Id of the Worksheet object.
workbookName	string Name of the workbook.
workbookId	string Id of the Workbook object.Either workbookId or workbook name is mandatory to get the Workbook object
worksheetName	string Requested Worksheet’s Name.
folderName	string Folder’s name that contains the requested Worksheet Object.
addResponseTag	boolean Default: true Enum: true false Flag whether to wrap response in </ RESPONSE > tag or not.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"IRO": {"SUBTYPE": "DASHBOARD",
"CATEGORY_ID": "folder_15452049085231127062081162357107",
"ACCESSRIGHTS": 1,
"FOLDER_ID": "folder_15452049085231127062081162357107",
"NAME": "Live Query Analysis",
"FOLDER_NAME": "Query Analyzer",
"OWNERAPPID": 61431,
"SPECIFIC": {"WORKSHEET": {"VIEWER_WIDTH": 1200,
"DASHBOARD": {"WIDGETS": {"IS_CONTAINER_CARD_EXISTS": false,
"WIDGET": [{"IS_TARGET": false,
"WIDGET_STYLE": "{\"padding\":{\"isAllMargin\":true,\"all\":16,\"left\":16,\"right\":16,\"top\":16,\"bottom\":16},\"backgroundColor\":\"\",\"transparent\":false,\"contentAlignment\":\"\"}",
"UI_CLASS": "table-hide-row-counter hide-alert-icon",
"IS_SOURCE": false,
"TITLE": "Query details",
"ID": "dbwidget15476256377356127013011134839909",
"TYPE": "SHEET",
"UI_IDENTIFIER": "standard",
"LAYOUT_PROPERTY": {"COLUMN_DETAILS": "[{\"index\":0,\"style\":{},\"panels\":[]}]",
"PANEL_DETAILS": "{\"LEGEND\":{\"style\":{},\"id\":\"LEGEND\"}}"
},
"SHEET_ID": "Sheet15480639986125127039051156167297",
"LAYER_INDEX": 1
},
{"IS_TARGET": false,
"WIDGET_STYLE": "{\"padding\":{\"isAllMargin\":true,\"all\":16,\"left\":16,\"right\":16,\"top\":16,\"bottom\":16},\"backgroundColor\":\"\",\"transparent\":false,\"contentAlignment\":\"\"}",
"UI_CLASS": "table-wrap-text table-allow-html table-hide-row-counter table-disable-tooltip hide-alert-icon",
"IS_SOURCE": false,
"TITLE": "Query string",
"ID": "dbwidget15476256377379127041039117960813",
"TYPE": "SHEET",
"UI_IDENTIFIER": "standard",
"LAYOUT_PROPERTY": {"COLUMN_DETAILS": "[{\"index\":0,\"style\":{},\"panels\":[]}]",
"PANEL_DETAILS": "{\"LEGEND\":{\"style\":{},\"id\":\"LEGEND\"}}"
},
"SHEET_ID": "Sheet15480639986016127057029111626348",
"LAYER_INDEX": 1
},
{"IS_TARGET": false,
"WIDGET_STYLE": "{\"padding\":{\"isAllMargin\":true,\"all\":16,\"left\":16,\"right\":16,\"top\":16,\"bottom\":16},\"backgroundColor\":\"\",\"transparent\":false,\"contentAlignment\":\"\"}",
"IS_SOURCE": false,
"TITLE": "Fields used in this query",
"ID": "dbwidget15476256377372127072089131429559",
"TYPE": "SHEET",
"UI_IDENTIFIER": "standard",
"LAYOUT_PROPERTY": {"COLUMN_DETAILS": "[{\"index\":0,\"style\":{},\"panels\":[]}]",
"PANEL_DETAILS": "{\"LEGEND\":{\"style\":{},\"id\":\"LEGEND\"}}"
},
"SHEET_ID": "Sheet15480639986104127068049132264523",
"LAYER_INDEX": 1
},
{"IS_TARGET": false,
"WIDGET_STYLE": "{\"padding\":{\"isAllMargin\":true,\"all\":16,\"left\":16,\"right\":16,\"top\":16,\"bottom\":16},\"backgroundColor\":\"\",\"transparent\":false,\"contentAlignment\":\"\"}",
"TITLE": "Sub queries execution time",
"ID": "dbwidget15481415776985127040081183065240",
"TYPE": "SHEET",
"UI_IDENTIFIER": "standard",
"LAYOUT_PROPERTY": {"COLUMN_DETAILS": "[{\"index\":0,\"style\":{},\"panels\":[]}]",
"PANEL_DETAILS": "{\"LEGEND\":{\"style\":{},\"id\":\"LEGEND\"}}"
},
"SHEET_ID": "Sheet15481413097158127094066151354660",
"LAYER_INDEX": 1
},
{"WIDGET_STYLE": "{\"padding\":{\"isAllMargin\":true,\"all\":16,\"left\":16,\"right\":16,\"top\":16,\"bottom\":16},\"backgroundColor\":\"\",\"transparent\":false,\"contentAlignment\":\"\"}",
"TITLE": "Query engine execution time",
"ID": "dbwidget15476256377374127057088184472624",
"TYPE": "SHEET",
"UI_IDENTIFIER": "standard",
"LAYOUT_PROPERTY": {"COLUMN_DETAILS": "[{\"index\":0,\"style\":{},\"panels\":[]}]",
"PANEL_DETAILS": "{\"LEGEND\":{\"style\":{},\"id\":\"LEGEND\"}}"
},
"SHEET_ID": "Sheet15480639986133127021065172736506",
"LAYER_INDEX": 1
},
{"WIDGET_STYLE": "{\"padding\":{\"isAllMargin\":true,\"all\":16,\"left\":16,\"right\":16,\"top\":16,\"bottom\":16},\"backgroundColor\":\"\",\"transparent\":false,\"contentAlignment\":\"\"}",
"TITLE": "Per query statistics",
"ID": "dbwidget15476256377371127059026111186784",
"TYPE": "SHEET",
"UI_IDENTIFIER": "standard",
"LAYOUT_PROPERTY": {"COLUMN_DETAILS": "[{\"index\":0,\"style\":{},\"panels\":[]}]",
"PANEL_DETAILS": "{\"LEGEND\":{\"style\":{},\"id\":\"LEGEND\"}}"
},
"SHEET_ID": "Sheet15480639986001127047035171786748",
"LAYER_INDEX": 1
},
{"WIDGET_STYLE": "{\"padding\":{\"isAllMargin\":true,\"all\":16,\"left\":16,\"right\":16,\"top\":16,\"bottom\":16},\"backgroundColor\":\"\",\"transparent\":false,\"contentAlignment\":\"\"}",
"TITLE": "Query engine state while executing query",
"ID": "dbwidget15499519839334127047039126349379",
"TYPE": "SHEET",
"UI_IDENTIFIER": "standard",
"LAYOUT_PROPERTY": {"COLUMN_DETAILS": "[{\"index\":0,\"style\":{},\"panels\":[]}]",
"PANEL_DETAILS": "{\"LEGEND\":{\"style\":{},\"id\":\"LEGEND\"}}"
},
"SHEET_ID": "Sheet15499518592063127012027174127638",
"LAYER_INDEX": 1
},
{"WIDGET_STYLE": "{\"padding\":{\"isAllMargin\":true,\"all\":16,\"left\":16,\"right\":16,\"top\":16,\"bottom\":16},\"backgroundColor\":\"\",\"transparent\":false,\"contentAlignment\":\"\"}",
"TITLE": "Live Query Aggregates",
"ID": "dbwidget15889341284094127021092184938684",
"TYPE": "SHEET",
"UI_IDENTIFIER": "standard",
"LAYOUT_PROPERTY": {"COLUMN_DETAILS": "[{\"index\":0,\"style\":{\"width\":120},\"panels\":[]}]",
"PANEL_DETAILS": "{\"LEGEND\":{\"style\":{\"height\":336},\"id\":\"LEGEND\"}}"
},
"SHEET_ID": "Sheet15889339161378127090061144927242",
"LAYER_INDEX": 1
},
{"WIDGET_STYLE": "{\"padding\":{\"isAllMargin\":true,\"all\":16,\"left\":16,\"right\":16,\"top\":16,\"bottom\":16},\"backgroundColor\":\"\",\"transparent\":false,\"contentAlignment\":\"\"}",
"UI_CLASS": "table-wrap-text table-allow-html table-hide-row-counter table-disable-tooltip hide-alert-icon",
"IS_SOURCE": false,
"TITLE": "Time breakup",
"ID": "dbwidget15499517226656127021015141017275",
"TYPE": "SHEET",
"UI_IDENTIFIER": "standard",
"LAYOUT_PROPERTY": {"COLUMN_DETAILS": "[{\"index\":0,\"style\":{},\"panels\":[]}]",
"PANEL_DETAILS": "{\"LEGEND\":{\"style\":{},\"id\":\"LEGEND\"}}"
},
"SHEET_ID": "Sheet15499151721356127069059196991961",
"LAYER_INDEX": 1
},
{"STATIC_TEXT": "<span style=\"color: #868686;\">Query ID </span>{{Filter.[Query ID].value}} <span style=\"color: #868686;\">on cube </span>{{Filter.[Cube Name].value}}&nbsp; <span style=\"color: #55a7f9;\">&nbsp;<a style=\"color: #55a7f9;\" href=\"#/default/summary/{{Filter.[Cube ID].value}}?historyId={{Filter.[History ID].value}}&amp;cubeName={{Filter.[Cube Name].value}}\" target=\"_blank\" rel=\"noopener\">Show Build Summary</a></span><br /><br />\n<table style=\"border-collapse: collapse; width: 100%; box-sizing: border-box; height: 36px; border-width: 0px;\" border=\"1\">\n<tbody>\n<tr>\n<td style=\"height: 18px; vertical-align: top; border-width: 0px;\"><span style=\"color: #868686;\">Note:</span></td>\n<td style=\"height: 18px; vertical-align: top; border-width: 0px;\"><span style=\"color: #868686;\">Sub Queries, Query Engines Execution Time, Query Statistics, Query Engine Time Breakup are available only if query takes more than certain configurable threshold time. (Default value of threshold is 5 seconds)</span></td>\n</tr>\n<tr>\n<td style=\"height: 18px; border-width: 0px;\">&nbsp;</td>\n<td style=\"height: 18px; vertical-align: top; border-width: 0px;\"><span style=\"color: #868686;\">This dashboard is best view for analyzing single query from activity monitor.</span></td>\n</tr>\n</tbody>\n</table>",
"WIDGET_STYLE": "{\"padding\":{\"isAllMargin\":true,\"all\":16,\"left\":16,\"right\":16,\"top\":16,\"bottom\":16},\"backgroundColor\":\"\",\"transparent\":false,\"contentAlignment\":\"\"}",
"UI_CLASS": "flat-card",
"HTML_CARD_INFO": "{\"cardVersion\":\"TINY_MCE\"}",
"ID": "dbwidget15471281797728127086023192529161",
"TYPE": "TEXT",
"UI_IDENTIFIER": "standard",
"LAYOUT_PROPERTY": {"COLUMN_DETAILS": "[]"
},
"LAYER_INDEX": 1
}
]
},
"DASHBOARD_STYLE": "{\"loaderStyle\":\"GHOST_LOADER\",\"widgetGap\":4,\"widgetShadow\":0,\"backgroundColor\":\"\",\"dashboardMargin\":{\"isAllMargin\":true,\"all\":8,\"left\":8,\"right\":8,\"top\":8,\"bottom\":8},\"customCss\":\"\"}",
"LAYOUT": {"HIDE_WIDGETS_STATE": false,
"WIDGETS_PER_ROW": "",
"COLOR_PALETTE_ID": "rainbowParadise",
"TYPE": "RESPONSIVE",
"content": "{\"dbwidget15476256377356127013011134839909\":{\"col\":0,\"row\":0,\"sizeX\":400,\"sizeY\":56,\"isWidgetPinned\":true,\"isShowMaximize\":false,\"isNoDataOnWidget\":false},\"dbwidget15476256377379127041039117960813\":{\"col\":0,\"row\":56,\"sizeX\":224,\"sizeY\":88,\"isWidgetPinned\":true,\"isShowMaximize\":true,\"isNoDataOnWidget\":true},\"dbwidget15476256377372127072089131429559\":{\"col\":224,\"row\":56,\"sizeX\":176,\"sizeY\":88,\"isWidgetPinned\":true,\"isShowMaximize\":true,\"isNoDataOnWidget\":true},\"dbwidget15481415776985127040081183065240\":{\"col\":0,\"row\":144,\"sizeX\":400,\"sizeY\":88,\"isWidgetPinned\":true,\"isShowMaximize\":true,\"isNoDataOnWidget\":true},\"dbwidget15476256377374127057088184472624\":{\"col\":0,\"row\":232,\"sizeX\":400,\"sizeY\":96,\"isWidgetPinned\":true,\"isShowMaximize\":true,\"isNoDataOnWidget\":true},\"dbwidget15476256377371127059026111186784\":{\"col\":0,\"row\":328,\"sizeX\":400,\"sizeY\":96,\"isWidgetPinned\":true,\"isShowMaximize\":true,\"isNoDataOnWidget\":true},\"dbwidget15499519839334127047039126349379\":{\"col\":0,\"row\":424,\"sizeX\":400,\"sizeY\":96,\"isWidgetPinned\":true,\"isShowMaximize\":false,\"isNoDataOnWidget\":true},\"dbwidget15889341284094127021092184938684\":{\"col\":0,\"row\":520,\"sizeX\":400,\"sizeY\":96,\"isWidgetPinned\":true,\"isShowMaximize\":false,\"isNoDataOnWidget\":false},\"dbwidget15499517226656127021015141017275\":{\"col\":0,\"row\":616,\"sizeX\":400,\"sizeY\":176,\"isWidgetPinned\":true,\"isShowMaximize\":true,\"isNoDataOnWidget\":true},\"dbwidget15471281797728127086023192529161\":{\"col\":0,\"row\":792,\"sizeX\":384,\"sizeY\":32,\"isWidgetPinned\":false,\"isShowMaximize\":false,\"isNoDataOnWidget\":false},\"DB_PROPS\":{\"columnWidth\":4,\"columns\":400}}"
},
"THEME": "{\"id\":\"\",\"name\":\"None\"}"
},
"TITLE": "",
"TYPE": "DASHBOARD",
"WORKBOOK_ID": "Workbook15480639975721127087014122788695"
}
},
"REPOSITDATE": "08/18/2022 15:21:28",
"ISPUBLIC": true,
"COMMON": {"DESC": "description",
"TAGS": "TAG 1"
},
"LINKED_ENTITY_ID": "",
"ID": "Sheet15480639985900473162",
"OWNERAPPNAME": "-",
"TYPE": "WORKSHEET"
}
}
}

Get Workbooks from Folder

This API is used to get Workbook listing from a specific folder.

Authorizations:

sessionIdbasicAuth

path Parameters

folderNameOrId

required

string

Name or Id of a folder from which you want to get a list of Workbooks. Firstly, parameter folderNameOrId will be treated as Id. In case no Workbook is found with that Id, then it will search for a Workbook by taking nameOrId as Name

query Parameters

OWNER	string This parameter filters entities by owner (the user who created that entity) name.
TAGS	string This parameter filters the entities by tags. This filter will only work if the entity has a single tag.
SEARCH_TEXT	string This parameter filters the entities by their names. All entities whose name contains the searched text are included in the result, irrespective of the case format.
MODIFIED_AFTER	string This parameter filters the entities by their last modified timestamp. All the entities modified after the provided timestamp are included in the result.
MODIFIED_BEFORE	string This parameter filters the entities by their last modified timestamp. All the entities modified before the provided timestamp are included in the result.
COUNT	number This parameter sets the number of the records displayed in the response.
LAST_ENTITY_NAME	string When this parameter is used, the response shows only the entities occurring after the entity name specified in this parameter. The list ignores all the entities before that.
LAST_ENTITY_ID	string When this parameter is used, the response shows only the entities occurring after the entity ID specified in this parameter. The list ignores all the entities before that.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"WORKBOOKS": {"WORKBOOK": [{"ACCESSRIGHTS": 1,
"OWNER": "admin",
"OWNERID": 253292705,
"LAST_MODIFIED_TIMESTAMP": 1666863777804,
"LAST_MODIFIED": "10/27/2022 15:12:57",
"id": "Workbook16370588721112127042076110228564",
"NAME": "123",
"DESC": "description",
"TAGS": "TAG 1"
},
{"ACCESSRIGHTS": 1,
"OWNER": "designer",
"OWNERID": 15850555,
"LAST_MODIFIED_TIMESTAMP": 1648794948699,
"LAST_MODIFIED": "04/01/2022 12:05:48",
"id": "Workbook15873734276967127021058191124393",
"NAME": "20042020",
"DESC": "description",
"TAGS": "TAG 2"
}
]
}
}
}

Delete Workbook

This API is used to get worksheet object.

Authorizations:

sessionIdbasicAuth

query Parameters

workbookName	string Name of the workbook.
workbookId	string Id of the Workbook object.Either workbookId or workbook name is mandatory to get the Workbook object
folderName	string Folder’s name that contains the requested Worksheet Object.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Workbook deleted successfully.",
"CODE": 0
}

Delete Worksheet

This API is used to delete Worksheet.

Authorizations:

sessionIdbasicAuth

query Parameters

workbookName	string Workbook’s name that contains the requested Worksheet Object.
worksheetName	string Requested Worksheet’s Name.
worksheetId	string Id of the Worksheet object.
folderName	string Folder’s name that contains the requested Worksheet Object.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Worksheet deleted successfully.",
"CODE": 0
}

Save Workbook

This API is used to add/update workbook entity in the given entity's XML. To use this API with hasWorksheets=true or hasShortcuts=true or both, you must have privileges to import and export objects.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

workbookXML

required

object

XML of the workbook entity to be saved.

  With hasWorksheets=true

  <ACTION TYPE="ADD/UPDATE">
    <IROS>
      <IRO ID="Workbook16618695382211127067046137916461" NAME="RestAPITestWorkbook" TYPE="WORKBOOK" SUBTYPE="" FOLDER_ID="folder_15452049085231127062081162357107" ISPUBLIC="true" FOLDER_NAME="Query Analyzer">
        <COMMON>
          <DESC>
            <![CDATA[]]>
          </DESC>
        </COMMON>
        <SPECIFIC>
          <WORKBOOK>
            <WORKSHEET ID="Sheet16618695519065127089092181892688" NAME="Sheet 1" TYPE="SHEET"/>
          </WORKBOOK>
        </SPECIFIC>
      </IRO>
      <IRO ID="Sheet16618695519065127089092181892688" NAME="Sheet 1" TYPE="WORKSHEET" SUBTYPE="SHEET" FOLDER_ID="folder_15452049085231127062081162357107" ISPUBLIC="true">
        <COMMON>
          <DESC>
            <![CDATA[]]>
          </DESC>
        </COMMON>
        <SPECIFIC>
          <WORKSHEET TYPE="SHEET" VIEWER_WIDTH="1200" WORKBOOK_ID="Workbook16618695382211127067046137916461">
            <TITLE>
              <![CDATA[]]>
            </TITLE>
            <SHEET>
              <LAYOUT_PROPERTY>
                <LAYOUT>
                  <![CDATA[{"isShowMaximize":true}]]>
                </LAYOUT>
                <PANEL_DETAILS>
                  <![CDATA[{"viewType":{"id":"viewType","style":{}},"sourceCube":{"id":"cube","style":{}},"DIMENSION":{"id":"dimensions","style":{"height":98}},"MEASURE":{"id":"measures","style":{"height":98}},"X":{"id":"xAxis","style":{}},"Y":{"id":"yAxis","style":{},"expand":false},"COLOR":{"id":"color","style":{},"expand":false},"SIZE":{"id":"size","style":{},"expand":false},"DETAIL":{"id":"detail","style":{},"expand":false},"HIGHLIGHT":{"id":"highlight","style":{}},"FILTER":{"id":"filter","style":{"height":134}},"LEGEND":{"id":"legend","style":{}},"WSPROPERTIES":{"id":"properties","style":{"height":134}}}]]>
                </PANEL_DETAILS>
                <COLUMN_DETAILS>
                  <![CDATA[[{"style":{},"panels":[]},{"style":{},"panels":[]},{"style":{},"panels":[]}]]]>
                </COLUMN_DETAILS>
              </LAYOUT_PROPERTY>
              <ACTIONS>
                <![CDATA[[]]]>
              </ACTIONS>
              <THEME>
                <![CDATA[{"id":"","name":"None"}]]>
              </THEME>
              <OLAPLAYOUT VIEW="CARDEX"  ALL_SLIDERS_DIRTY="true" SELECTED_MEMBER_VALID="false"  VIEW_DATA_AS="Summarized" CHART_TYPE="TABLECONTROL" VIEWER_LIMIT="10000" SHOW_DIMENSION_FILTER="true" SHOW_CONTEXTUAL_FILTER="true" SHOW_MEASURE_FILTER="true" IS_FILTER_MODE_MANUAL="false">
                <CUBEOBJECT ID="15480664115043127036015142487028" NAME="Live Query Details" FOLDER_NAME="Query Analyzer"/>
                <SHELVES>
                  <SHELF TYPE="X">
                    <MEASURES>
                      <MEASURE ID="MEASURE_34820" QUALIFIED_NAME="Total Query Count"/>
                    </MEASURES>
                  </SHELF>
               </SHELVES>
                <VISUALIZATION TYPE="MANUAL" CHARTTYPE="TABLECONTROL" CURRENTVIEW="CHART">
                  <SPECIFIC_PROPS>
                    <VIZ TYPE="CHART">
                      <GLOBAL>
                        <PROP NAME="SHOW_GRAND_TOTAL">
                          <![CDATA[false]]>
                        </PROP>
                        <PROP NAME="COLORPALETTE_ID">
                          <![CDATA[Kyvos7]]>
                        </PROP>
                        <PROP NAME="isKpiCustomTemplateDirty">
                          <![CDATA[false]]>
                        </PROP>
                      </GLOBAL>
                    </VIZ>
                  </SPECIFIC_PROPS>
                </VISUALIZATION>
                <CROSSTAB_PROPERTIES ROW_DRILL_MODE="MEMBER_EXPANSION"  COLUMN_DRILL_MODE="MEMBER_EXPANSION"     IS_SHOW_TOTAL_AT_TOP ="false"  MAX_ROW="10000" MAX_COLUMN="100" RESP_CHUNK_MODE="AUTOMATIC" RESP_CHUNK_SIZE="1000" IS_ROW_CLASSIC_EXPANSION="false"  IS_COL_CLASSIC_EXPANSION ="false" IS_SHOW_TOTAL="false" SHOW_TOTAL_TYPE="GRAND_TOTAL" SHOW_TOTAL_AXIS="BOTH" IS_PERSIST_EXPANSION="true" USE_MDX_FLOW="true"  IS_HEATMAP ="false" IS_ALL_HIDDEN="true" REPEAT_MEMBER_VALUES="false" SHOW_EXPAND_COLLAPSE="true" HIGHLIGHT_ALTERNATE_ROWS="true" HIGHLIGHTED_ROW_DIM_POS="INNERMOST" >
              </OLAPLAYOUT>
            </SHEET>
          </WORKSHEET>
        </SPECIFIC>
      </IRO>
      </IROS>
  </ACTION>

 
 With hasWorksheets=false    <IRO
    ID="Workbook16317736991063127036038161768705"
    NAME="kyvosworksheets" TYPE="WORKBOOK" SUBTYPE=""
    CATEGORY_ID="folder_16310208223453127093031155815558"
    FOLDER_NAME="kyvosworksheets"
    FOLDER_ID="folder_16310208223453127093031155815558"
    ACCESSRIGHTS="1" OWNERAPPID="191364207"
    OWNERAPPNAME="kyvos.user" REPOSITDATE="12/08/2021 18:55:15"
    ISPUBLIC="true">
      <COMMON>
        <DESC>
          <![CDATA[]]>
        </DESC>
      </COMMON>
      <SPECIFIC>
        <WORKBOOK>
          <WORKSHEET ID="Sheet16317737089492127081031131530629" NAME="Sheet 1 updated" TYPE="SHEET"/>
          <WORKSHEET ID="Sheet16381845931756127087043126165796" NAME="Sheet 2" TYPE="SHEET"/>
          <WORKSHEET ID="Sheet16382635133061127080056161146639" NAME="Sheet 4" TYPE="SHEET"/>
        </WORKBOOK>
      </SPECIFIC>
    </IRO>

hasWorksheets

boolean

Default: false

Enum: true false

Flag to indicate that the workbookXML contains worksheets XML also. So the save operation will be executed accordingly.
Default Value: false

hasShortcuts

boolean

Default: false

Enum: true false

Flag to indicate that the workbookXML contains shortcuts XML also. So the save operation will be executed accordingly.
Default Value: false

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"RES": [{"MESSAGE": "Successfully replaced workbook: RestAPITestWorkbook",
"CODE": 0
},
{"MESSAGE": "Successfully replaced worksheet: Sheet 1",
"CODE": 0
}
]
}
}

Save Worksheet

This API is used to add/update worksheet entity with given entity XML. As this API performs bulk operation, you must have privileges to import and export objects to use this API.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

worksheetXML

required

object

XML of the worksheet entity to be saved.
For e.g.

  <ACTION TYPE="ADD/REPLACE">
    <IROS>
      <IRO ID="Sheet16618707220207127049058124394078" NAME="Sheet 2" TYPE="WORKSHEET" SUBTYPE="SHEET" FOLDER_ID="folder_15452049085231127062081162357107" ISPUBLIC="true">
        <COMMON>
          <DESC>
            <![CDATA[]]>
          </DESC>
        </COMMON>
        <SPECIFIC>
          <WORKSHEET TYPE="SHEET" VIEWER_WIDTH="1200" WORKBOOK_ID="Workbook16618695382211127067046137916461">
            <TITLE>
              <![CDATA[]]>
            </TITLE>
            <SHEET>
              <LAYOUT_PROPERTY>
                <LAYOUT>
                  <![CDATA[{"isShowMaximize":true}]]>
                </LAYOUT>
                <\PANEL_DETAILS>
                  
                </PANEL_DETAILS>
                <COLUMN_DETAILS>
                  <![CDATA[[{"style":{},"panels":[]},{"style":{},"panels":[]},{"style":{},"panels":[]}]]]>
                </COLUMN_DETAILS>
              </LAYOUT_PROPERTY>
              <ACTIONS>
                <![CDATA[[]]]>
              </ACTIONS>
              <THEME>
                <![CDATA[{"id":"","name":"None"}]]>
              </THEME>
              <OLAPLAYOUT VIEW="CARDEX"  ALL_SLIDERS_DIRTY="true" SELECTED_MEMBER_VALID="false"  VIEW_DATA_AS="Summarized" CHART_TYPE="TABLECONTROL" VIEWER_LIMIT="10000" SHOW_DIMENSION_FILTER="true" SHOW_CONTEXTUAL_FILTER="true" SHOW_MEASURE_FILTER="true" IS_FILTER_MODE_MANUAL="false">
                <CUBEOBJECT ID="15469777168753127022016197985271" NAME="Historical Query Details" FOLDER_NAME="Query Analyzer"/>
                <SHELVES>
                  <SHELF TYPE="X">
                    <MEASURES>
                      <MEASURE ID="MEASURE_34820" QUALIFIED_NAME="Total Query Count"/>
                    </MEASURES>
                  </SHELF>
                </SHELVES>
                <VISUALIZATION TYPE="MANUAL" CHARTTYPE="TABLECONTROL" CURRENTVIEW="CHART">
                  <SPECIFIC_PROPS>
                    <VIZ TYPE="CHART">
                      <GLOBAL>
                        <PROP NAME="SHOW_GRAND_TOTAL">
                          <![CDATA[false]]>
                        </PROP>
                        <PROP NAME="COLORPALETTE_ID">
                          <![CDATA[Kyvos7]]>
                        </PROP>
                        <PROP NAME="isKpiCustomTemplateDirty">
                          <![CDATA[false]]>
                        </PROP>
                      </GLOBAL>
                    </VIZ>
                  </SPECIFIC_PROPS>
                </VISUALIZATION>
                <CROSSTAB_PROPERTIES ROW_DRILL_MODE="MEMBER_EXPANSION"  COLUMN_DRILL_MODE="MEMBER_EXPANSION"     IS_SHOW_TOTAL_AT_TOP ="false"  MAX_ROW="10000" MAX_COLUMN="100" RESP_CHUNK_MODE="AUTOMATIC" RESP_CHUNK_SIZE="1000" IS_ROW_CLASSIC_EXPANSION="false"  IS_COL_CLASSIC_EXPANSION ="false" IS_SHOW_TOTAL="false" SHOW_TOTAL_TYPE="GRAND_TOTAL" SHOW_TOTAL_AXIS="BOTH" IS_PERSIST_EXPANSION="true" USE_MDX_FLOW="true"  IS_HEATMAP ="false" IS_ALL_HIDDEN="true" REPEAT_MEMBER_VALUES="false" SHOW_EXPAND_COLLAPSE="true" HIGHLIGHT_ALTERNATE_ROWS="true" HIGHLIGHTED_ROW_DIM_POS="INNERMOST" >
              </OLAPLAYOUT>
            </SHEET>
          </WORKSHEET>
        </SPECIFIC>
      </IRO>
    </IROS>
  </ACTION>
  <ACTION TYPE="REPLACE">
    <IROS>
      <IRO ID="Workbook16618695382211127067046137916461" NAME="RestAPITestWorkbook" TYPE="WORKBOOK" SUBTYPE="" FOLDER_ID="folder_15452049085231127062081162357107" ISPUBLIC="true" FOLDER_NAME="Query Analyzer">
        <COMMON>
          <DESC>
            <![CDATA[]]>
          </DESC>
        </COMMON>
        <SPECIFIC>
          <FILTERS>
            <FILTER NAME="LAST_MODIFIED_TIMESTAMP" OPERATOR="=">
              <VALUE>
                <![CDATA[1661869877520]]>
              </VALUE>
            </FILTER>
          </FILTERS>
          <WORKBOOK>
            <WORKSHEET ID="Sheet16618695519065127089092181892688" NAME="Sheet 1" TYPE="SHEET"/>
            <WORKSHEET ID="Sheet16618707220207127049058124394078" NAME="Sheet 2" TYPE="SHEET"/>
          </WORKBOOK>
        </SPECIFIC>
      </IRO>
    </IROS>
  </ACTION>

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"RES": [{"MESSAGE": "Successfully added worksheet: RestApiTest1",
"CODE": 0
},
{"MESSAGE": "Successfully added worksheet: RestApiTest2",
"CODE": 0
}
]
}
}

Get Workbook Listing

This API is used to get Workbook listing along with their folders.

Authorizations:

sessionIdbasicAuth

query Parameters

show	string Enum: "all" "folders" "list" Example: show=all This parameter is used to control the objects returned in the response. the response can have a list of only folders, a list of only entities, or both, based on other filters applied. The default value is 'all' all: Response list contains a combined list of folders and entities. list: Response list shows only the entity list. folders: Response list shows only the folders list.
OWNER	string This parameter filters entities by owner (the user who created that entity) name.
TAGS	string This parameter filters the entities by tags. This filter will only work if the entity has a single tag.
SEARCH_TEXT	string This parameter filters the entities by their names. All entities whose name contains the searched text are included in the result, irrespective of the case format.
MODIFIED_AFTER	string This parameter filters the entities by their last modified timestamp. All the entities modified after the provided timestamp are included in the result.
MODIFIED_BEFORE	string This parameter filters the entities by their last modified timestamp. All the entities modified before the provided timestamp are included in the result.
COUNT	number This parameter sets the number of the records displayed in the response. It is applicable only for show=list or show=folders but not with show=all.
LAST_ENTITY_NAME	string When this parameter is used, the response shows only the entities occurring after the entity name specified in this parameter. The list ignores all the entities before that.
LAST_ENTITY_ID	string When this parameter is used, the response shows only the entities occurring after the entity ID specified in this parameter. The list ignores all the entities before that.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"WORKBOOKS": {"WORKBOOK": [{"ACCESSRIGHTS": 1,
"OWNER": "admin",
"OWNERID": 253292705,
"LAST_MODIFIED_TIMESTAMP": 1666863777804,
"LAST_MODIFIED": "10/27/2022 15:12:57",
"id": "Workbook16370588721112127042076110228564",
"NAME": "123",
"DESC": "description",
"TAGS": "TAG 1"
},
{"ACCESSRIGHTS": 1,
"OWNER": "designer",
"OWNERID": 15850555,
"LAST_MODIFIED_TIMESTAMP": 1648794948699,
"LAST_MODIFIED": "04/01/2022 12:05:48",
"id": "Workbook15873734276967127021058191124393",
"NAME": "20042020",
"DESC": "description",
"TAGS": "TAG 2"
}
]
}
}
}

Get Worksheet Listing

This API is used to get Worksheet listing inside workbook.

Authorizations:

sessionIdbasicAuth

query Parameters

workbookName	string Workbook name for which worksheet listing has to be fecthed
workbookId	string Workbook id for which worksheet listing has to be fecthed
folderName	string Folder Name that contains the workbook. If not sent, then it will search workbook at root Folder
folderId	string Folder id for which worksheet listing has to be fecthed
worksheetType	string Enum: "SHEET" "DASHBOARD" Type of the worksheet for which listing is to be fetched.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"WORKSHEETS": [{"WORKSHEET": {"ACCESSRIGHTS": 1,
"OWNER": "admin",
"OWNERID": "",
"LAST_MODIFIED_TIMESTAMP": 1691150779034,
"LAST_MODIFIED": "08/04/2023 17:36:19",
"id": "Sheet16687679649442127059071182136763",
"VIZ_TYPE": "BAR",
"type": "SHEET",
"NAME": "Sheet 1",
"DESC": "Test description 1",
"TAGS": "TAG 1"
}
},
{"WORKSHEET": {"ACCESSRIGHTS": 1,
"OWNER": "admin",
"OWNERID": "",
"LAST_MODIFIED_TIMESTAMP": 1691395746987,
"LAST_MODIFIED": "08/07/2023 13:39:06",
"id": "Dashboard16893606990655127026012185960065",
"type": "DASHBOARD",
"NAME": "Dashboard 1",
"DESC": "Test description 2",
"TAGS": "TAG 2"
}
}
]
}
}

Schedule emailing of worksheets

This API is used to schedule emailing of worksheets.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

worksheetName	string Name of the worksheet
workbookName	string Name of the workbook
folderName	string Name of the folder
subject	string Subject for the email
message	string Message for the email
recipientUserList	string Users list to whom email needs to be scheduled
recipientGroupList	string Groups list to whom email needs to be scheduled
recipientEmailAddress	string Email ids list to whom email needs to be scheduled
jobType	string Default: "NOW" Enum: "NOW" "ONCE" Type of email {@link Enums.ScheduledJob.JobTypes} NOW: This will immediately start the job ONCE: Job will run at the specified time
onceDateTime	string Date and time if jobType is scheduled as once. Such as, 01/02/2019 14:10
fileFormat	string Enum: "none" "csv" "pdf" "image" Format in which the data is exported & send as an attachment in email. Possible values - none, csv, pdf, image
attachmentParam	object Optional parameters for customizing exported data as per the need. Find different properties for this parameter in the below table. EXPORT_VIEW_TYPE Type of view to be exported Default Value: TABULAR LINE_SEPARATOR Line separator to be used while exporting data to file. Applicable when fileFormat is csv. Default Value: \r\n FIELD_SEPARATOR Field separator for each field. Applicable when fileFormat is csv. Default Value: , (comma) ENCLOSURE Each field will be enclosed by this input. Applicable when fileFormat is csv. Default Value: “ (double qoutes) INCLUDE_HEADER Each field will be enclosed by this input. Applicable when fileFormat is csv. Default Value: true KEEP_MEASURE_FORMATTING Each field will be enclosed by this input. Applicable when fileFormat is csv. Default Value: false THEME_ID Theme id to be applied in exported PDF to make PDF visually similar to UI. Applicable when fileFormat is pdf. Default Value: blank INCLUDE_TABLE_VIEW To include tabular data in exported PDF when visualization is chart. Applicable when fileFormat is pdf. Default Value: false INCLUDE_COMPLETE_DATA To include complete data in exported PDF when visualization is chart. Applicable when fileFormat is pdf. Default Value: false INCLUDE_DB_TITLE Flag to include dashboard title in the exported PDF or image. Applicable for dashboard only. Default Value: false INCLUDE_CARD_INFO Flag to include dashboard data cards info in the exported PDF or image. Applicable for dashboard only. Default Value: false IMAGE_FORMAT Image format for dashboard export. Applicable for dashboard only. Default Value: PNG
attachmentForm	string Default: "zip" Enum: "zip" "unzip" "inline" If there is any attachment, how the attachment gets attachment in email - in zip form, in unzip form or as an inline attachment. Possible values - zip, unzip, inline inline value is applicable for dashboard when file format is image.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Email Sheet successfully.",
"CODE": 0
}

Copy Workbook

This API is used to copy the workbook in the desired destination folder.
Note - User should provide either "sourceWorkbookId" or "sourceWorkbookName" and "sourceFolderName" details.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

sourceWorkbookId	string Id of the workbook for which you want to create a copy. If you do not know the workbook id, use the workbook name and folder name.
sourceWorkbookName	string Name of the workbook for which you want to create a copy.
sourceFolderName	string Folder name of the workbook for which you want to create a copy.
targetWorkbookName required	string Name of the target workbook that you want to create.
targetFolderId	string Target folder id where you want to create the copy.
targetFolderName	string Target folder name where you want to create the copy.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Workbook copied successfully.",
"CODE": 0
}

Update properties of Workbook Deprecated

This API is used to update one or more properties of the workbook. For example DESCRIPTION property, TAGS property etc.
Note - User should provide either "workbookId" or "workbookName" and "folderName" details. Note: This API has been deprecated. Please refer alternate API /workbooks/entityProperties.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

workbookId	string Id of the workbook for which you want to update properties. If you do not know the workbook id, use the workbook name and folder name.
workbookName	string Name of the workbook for which you want to update properties.
folderName	string Folder name of the workbook for which you want to update properties.
propertyJSON required	object JSON containing an array of property name and their values. For e.g. [ { "name": "DESCRIPTION", "value": "description" }, { "name": "TAGS" "value": "tag" } ]

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully updated properties of the workbook.",
"CODE": 0
}

Update properties of Workbook

This API is used to update one or more properties of the workbook. For example DESCRIPTION property, TAGS property etc.
Note - User should provide either "workbookId" or "workbookName" and "folderName" details.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

workbookId	string Id of the workbook for which you want to update properties. If you do not know the workbook id, use the workbook name and folder name.
workbookName	string Name of the workbook for which you want to update properties.
folderName	string Folder name of the workbook for which you want to update properties.
propertyJSON required	object JSON containing an array of property name and their values. For e.g. [ { "name": "DESCRIPTION", "value": "description" }, { "name": "TAGS" "value": "tag" } ]

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully updated properties of the workbook.",
"CODE": 0
}

Update properties of Worksheet Deprecated

This API is used to update one or more properties of the worksheet. For example DESCRIPTION property, TAGS property etc.
Note - User should provide either "worksheetId" or "worksheetName", "workbookName" and "folderName" details. Note: This API has been deprecated. Please refer alternate API /worksheets/entityProperties.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

worksheetId	string Id of the worksheet for which you want to update properties. If you do not know the worksheet id, use the worksheet name, workbook name and folder name or folder id.
worksheetName	string Name of the worksheet which you want to update properties.
workbookName	string Name of the workbook for which you want to update properties of worksheet.
folderId	string Id of the folder for which you want to update properties of worksheet.
folderName	string Name of the folder for which you want to update properties of worksheet.
propertyJSON required	object JSON containing an array of property name and their values. For e.g. [ { "name": "DESCRIPTION", "value": "description" }, { "name": "TAGS" "value": "tag" } ]

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully updated properties of the worksheet.",
"CODE": 0
}

Update properties of Worksheet

This API is used to update one or more properties of the worksheet. For example DESCRIPTION property, TAGS property etc.
Note - User should provide either "worksheetId" or "worksheetName", "workbookName" and "folderName" details.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

worksheetId	string Id of the worksheet for which you want to update properties. If you do not know the worksheet id, use the worksheet name, workbook name and folder name or folder id.
worksheetName	string Name of the worksheet which you want to update properties.
workbookName	string Name of the workbook for which you want to update properties of worksheet.
folderId	string Id of the folder for which you want to update properties of worksheet.
folderName	string Name of the folder for which you want to update properties of worksheet.
propertyJSON required	object JSON containing an array of property name and their values. For e.g. [ { "name": "DESCRIPTION", "value": "description" }, { "name": "TAGS" "value": "tag" } ]

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully updated properties of the worksheet.",
"CODE": 0
}

Rename Worksheet

This API is used to rename the worksheet in the desired destination folder.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

worksheetId	string Id of the worksheet which you want to rename.
worksheetName	string Name of the worksheet which you want to rename.
workbookName	string Name of the workbook in which worksheet to be renamed is present.
folderName	string Folder name of the workbook.
targetName required	string Name to which you want worksheet to be renamed.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Worksheet renamed successfully.",
"CODE": 0
}

Copy Worksheet

This API is used to copy the worksheet in the desired destination folder.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

sourceWorksheetId	string Id of the worksheet which you want to copy.
sourceWorksheetName	string Name of the worksheet which you want to copy.
sourceWorkbookName	string Name of the workbook in which worksheet to be copy is present.
sourceFolderName	string Folder name containing workbook.
copyLinkedSheets	string COPY_ALL, MOVE_ALL or NONE based on desired action for linked sheets.
targetWorkbookName	string Name of the workbook in which worksheet needs to be copied.
targetWorksheetName	string Name with which you want worksheet to be copied.
targetWorkbookId	string Id of the workbook in which worksheet needs to be copied.
targetFolderId	string Id of the folder containing target workbook.
targetFolderName	string Name of the folder containing target workbook.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Worksheet copied successfully.",
"CODE": 0
}

Move Worksheet

This API is used to move the worksheet in the desired destination folder.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

sourceWorksheetId	string Id of the worksheet which you want to move.
sourceWorksheetName	string Name of the worksheet which you want to move.
sourceWorkbookName	string Name of the workbook in which worksheet to be move is present.
sourceFolderName	string Folder name containing workbook.
copyLinkedSheets	string COPY_ALL, MOVE_ALL or NONE based on desired action for linked sheets.
targetWorkbookName	string Name of the workbook in which worksheet needs to be moved.
targetWorkbookId	string Id of the workbook in which worksheet needs to be moved.
targetFolderId	string Id of the folder containing workbook.
targetFolderName	string Name of the folder containing workbook.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Worksheet moved successfully.",
"CODE": 0
}

Add and Update Calculated Measures

This API is used to add/update calculated measures in a workbook. The API will add/update calculated measures at workbook level.

Authorizations:

sessionIdbasicAuth

query Parameters

workbookId	string Id of the workbook object. Either workbookId or a combination of workbookName and folderName is mandatory to get the workbook object.
workbookName	string Name of workbook object.
folderName	string Folder name in which the workbook object is saved.
folderId	string Folder id in which the workbook object is saved.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

measureJSON

object

A JSON string containing the name of the measure as key and another JSON containing the properties of the measure as value.

The input for format type would be a numerical value with mapping as
2-Number
3-Currency
4-Date
5-Time
6- Percentage
7-Scientific
9-Custom
10-Duration

The input for nonEmptyBehaviour should be as follows
BY_EXPRESSION-Expression must evaluate itself to determine whether the calculated measure is empty.
BY_MEASURE-When you specify one or more measures in the list, Kyvos treats the calculated measure as empty if all the specified measures are empty.
BY_MEASURE_THEN_EXPRESSION-Treats the calculated measure as empty if values of all the specified measures are empty or if the calculated value of the expression is empty.

Sample JSON

{
  "measureName1": {
    "expression": "expression1",

    "description": "description1",

    "groupName": "groupName1",

    "groupDescription": "groupDescription1",

    "semanticModelId": "semanticModelId1",

    "semanticModelName": "semanticModelName1",

    "semanticModelFolder": "folderName1",

    "solveOrder": "solveOrder1",

    "formatType": "formatType1",

    "format": "format1",

    "isVisible": "true/false",

    "nonEmptyBehaviour": "nonEmptyBehaviour1",

    "nonEmptyMeasures": "nonEmptyMeasures1"
  },
  "measureName2": {
    "expression": "expression2",

    "description": "description2",

    "groupName": "groupName2",

    "groupDescription": "groupDescription2",

    "semanticModelId": "semanticModelId2",
 
    "semanticModelName": "semanticModelName2",

    "semanticModelFolder": "folderName2",

    "solveOrder": "solveOrder2",

    "formatType": "formatType2",

    "format": "format2",,

    "isVisible": "true/false"

    "nonEmptyBehaviour": "nonEmptyBehaviour2",

    "nonEmptyMeasures": "nonEmptyMeasures2"
  }
}

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully added/replaced calculated measures in workbook",
"CODE": 0
}

Get calculated measures

This API is used to fetch calculated measures from a workbook based on its name.Multiple measures can be fetched in one go based on comma separated measure name.If the comma separated measure name list is empty then all measures will be fetched

Authorizations:

sessionIdbasicAuth

query Parameters

workbookId	string Id of the workbook object. Either workbookId or a combination of workbookName and folderName is mandatory to get the workbook object.
workbookName	string Name of workbook object.
folderName	string Folder name from which you want to get workbook object.
folderId	string Folder id from which you want to get the workbook object.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Request Body schema: application/x-www-form-urlencoded

measureNames

string

Default: ""

Comma separated names of measures which you want to fetch. If this value is not provided then all measures will be fetched.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"MEASURES": {"MEASURE": {"DICTIONARY_TYPE": "INDEX",
"FORMAT": {"USEDEFAULT": 0,
"content": "#,##0.00"
},
"DISPLAY_FOLDER": "",
"MINON_MAXON_DATAFIELD": {"QUERY_NAME": "",
"QUERY_ID": ""
},
"ISVISIBLE": true,
"ISDEFAULT": false,
"DESCRIPTION": "",
"COLOR": "",
"ISADJUSTMENT": false,
"ID": "MEASURE_36408",
"UNIQUENAME": "MEASURE_36408",
"TYPE": "STANDARD",
"IS_ACCESSIBLE": true,
"SUBTYPE": "",
"SOLVE_ORDER": 0,
"UNIT": "",
"SUMMARYFUNCTION": "",
"RESTRICT": false,
"ADJUSTMENT_TYPE": "NEGATIVE",
"NON_EMPTY_MEASURES": "MEASURE_23",
"NAME": "Datediff",
"MATERIALIZE": "",
"DATATYPE": "NUMBER",
"FORMATTYPE": "2",
"DATAFIELD": {"QUERY_NAME": "",
"QUERY_ID": ""
},
"EXPRESSION": {"NON_EMPTY_BEHAVIOR": "BY_MEASURE",
"content": "DateDiff(year,CDATE(Now()),CDATE([Time].[Hierarchy].CurrentMember.Name))"
},
"IS_BOUNDARY_DIST_COUNT": "false"
}
}
}
}

Delete Calculated Measures

This API is used to delete calculated measures in a workbook.

Authorizations:

sessionIdbasicAuth

query Parameters

workbookId	string Id of the workbook object. Either workbookId or a combination of workbookName and folderName is mandatory to get the workbook object.
workbookName	string Name of workbook object.
folderName	string Folder name from which you want to get workbook object.
folderId	string Folder id from which you want to get the workbook object.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Request Body schema: application/x-www-form-urlencoded

measureNames	string Default: "" Comma separated names of measures which you want to delete. Either the measureNames or deleteAll flag should be provided.
deleteAll	boolean Default: false It's an optional parameter, when provided, all the calculated measures will be deleted. When both measureNames and deleteAll are provided, deleteAll flag will take precedence.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully deleted measures",
"CODE": 0
}

Rename Workbook

This API is used to rename the workbook in the desired destination folder.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

workbookId	string Id of the workbook which you want to rename.
workbookName	string Name of the workbook which you want to rename.
folderName	string Folder name of the workbook which you want to rename.
targetName required	string Name to which you want workbook to be renamed.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Workbook renamed successfully.",
"CODE": 0
}

Update Semantic Model of Workbook

This API is used to update semantic model of workbook in the desired destination folder.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

workbookName	string Name of the workbook in which you want to update semantic model.
workbookFolderName	string Name of the folder in which workbook is present. In case of root entity field is not required.
workbookId	string ID of the workbook in which you want to update semantic model.
smodelName	string Name of the semantic model which you want to update on workbook.
smodelFolderName	string Name of the folder in which semantic model is present. In case of root entity field is not required.
smodelId	string ID of the semantic model which you want to update on workbook.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully replaced workbook: Crosstab",
"CODE": 0
}

Get Parameters of Workbook

This API is used to get parameters of workbook.

Authorizations:

sessionIdbasicAuth

query Parameters

workbookId	string ID of the workbook to get parameters from.
workbookName	string Name of the workbook to get parameters from.
folderName	string Name of the folder containing workbook.
folderId	string Id of the folder containing workbook.

header Parameters

Accept	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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.

Responses

Response samples

200

Content type

application/xml

<RESPONSE>
<PARAMETERS>
<PARAMETER>
<![CDATA[Parameter Details]]></PARAMETER>
</PARAMETERS>
</RESPONSE>

Delete Parameters of Workbook

This API is used to delete parameter of workbook.

Authorizations:

sessionIdbasicAuth

query Parameters

workbookId	string ID of the workbook in which parameters are to be deleted.
workbookName	string Name of the workbook in which parameters are to be deleted.
folderName	string Name of the folder containing workbook.
folderId	string Id of the folder containing workbook.

header Parameters

Accept	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

isDeleteAll	string true or false based on if you want to delete all parameters. Default value is false
parameterJSON	string Parameter JSON containing name of Parameters to be deleted. Example: {"parametersName":["Parameter 2", "Parameter 1"]}

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully replaced workbook: CustomMatch",
"CODE": 0
}

Add Parameters in Workbook

This API is used to add parameters in workbook.

Authorizations:

sessionIdbasicAuth

query Parameters

workbookId	string ID of the workbook in which parameters are to be added.
workbookName	string Name of the workbook in which parameters are to be added.
folderName	string Name of the folder containing folder.
folderId	string Id of the folder containing workbook.

header Parameters

Accept	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

parameterJSON

required

string

Sample format for Adding Parameters in workbook. Note: Date format must be as shown in sample. Example: Example:

 [
    {
      "id": "16896857296804127022018133497456",
      "name": "Parameter 9",
      "description": "Number Range Selector",
      "type": "CUSTOM",
      "actualDisplayName": "P9",
      "dataType": "NUMBER",
      "control": "RANGE",
      "defaultValue": 35,
      "minValue": 10,
      "maxValue": 150,
      "step": 5
    },
    {
      "id": "16896856771361127074055183348148",
      "name": "Parameter 8",
      "description": "Number Mult Select List",
      "type": "CUSTOM",
      "actualDisplayName": "P8",
      "dataType": "NUMBER",
      "control": "MULTI_SELECT_LIST",
      "values": [
        {
          "av": "10",
          "dv": "10",
          "isDefault": true
        },
        {
          "av": "11",
          "dv": "11",
          "isDefault": false
        },
        {
          "av": "12",
          "dv": "12",
          "isDefault": false
        }
      ]
    },
    {
      "id": "16896855922077127030016112653113",
      "name": "Parameter 7",
      "description": "Number Single List",
      "type": "CUSTOM",
      "actualDisplayName": "P7",
      "dataType": "NUMBER",
      "control": "SINGLE_SELECT_LIST",
      "values": [
        {
          "av": "10",
          "dv": "10",
          "isDefault": false
        },
        {
          "av": "20",
          "dv": "20",
          "isDefault": false
        },
        {
          "av": "30",
          "dv": "30",
          "isDefault": true
        },
        {
          "av": "40",
          "dv": "40",
          "isDefault": false
        },
        {
          "av": "50",
          "dv": "50",
          "isDefault": false
        }
      ]
    },
    {
      "id": "16896855597769127046030183181497",
      "name": "Parameter 61",
      "description": "Number Text Input",
      "type": "CUSTOM",
      "actualDisplayName": "P6",
      "dataType": "NUMBER",
      "control": "INPUT",
      "defaultValue": 10
    },
    {
      "id": "16896855042717127047047148975704",
      "name": "Parameter 51",
      "description": "Chacrter MultiSelect List",
      "type": "CUSTOM",
      "actualDisplayName": "P5",
      "dataType": "CHAR",
      "control": "MULTI_SELECT_LIST",
      "values": [
        {
          "av": "India",
          "dv": "India",
          "isDefault": true
        },
        {
          "av": "China",
          "dv": "China",
          "isDefault": false
        },
        {
          "av": "Madhya Pradesh",
          "dv": "Madhya Pradesh",
          "isDefault": false
        },
        {
          "av": "Delhi",
          "dv": "Delhi",
          "isDefault": false
        }
      ]
    },
    {
      "id": "16896854266162127026024127293298",
      "name": "Parameter 4",
      "description": "Character Single List",
      "type": "CUSTOM",
      "actualDisplayName": "P4",
      "dataType": "CHAR",
      "control": "SINGLE_SELECT_LIST",
      "values": [
        {
          "av": "India",
          "dv": "India",
          "isDefault": true
        },
        {
          "av": "Afghanistan",
          "dv": "Afghanistan",
          "isDefault": false
        },
        {
          "av": "Argentina",
          "dv": "Argentina",
          "isDefault": false
        }
      ]
    },
    {
      "id": "16896854076950127054059140012314",
      "name": "Parameter 3",
      "description": "Character Text Input",
      "type": "CUSTOM",
      "actualDisplayName": "P3",
      "dataType": "CHAR",
      "control": "INPUT",
      "defaultValue": "India"
    },
    {
      "id": "16896853574144127054087192599493",
      "name": "Parameter 21",
      "description": "Measure Type Parameter",
      "type": "MEASURE",
      "actualDisplayName": "P2",
      "values": [
        {
          "av": "Sum sales",
          "dv": "Sum sales",
          "isDefault": true
        },
        {
          "av": "Profit",
          "dv": "Profit",
          "isDefault": false
        }
      ]
    },
    {
      "id": "16896853260232127038098143361572",
      "name": "Parameter 1",
      "description": "Dimension Type Parameter",
      "type": "DIMENSION",
      "actualDisplayName": "P1",
      "values": [
        {
          "av": "Country",
          "dv": "Country",
          "isDefault": true
        },
        {
          "av": "State",
          "dv": "State",
          "isDefault": false
        },
        {
          "av": "Year",
          "dv": "Year",
          "isDefault": false
        },
        {
          "av": "Quarter",
          "dv": "Quarter",
          "isDefault": false
        }
      ]
    },
    {
      "id": "16897545470184127095092168345147",
      "name": "Parameter 6",
      "description": "",
      "type": "CUSTOM",
      "actualDisplayName": "",
      "dataType": "DATE",
      "control": "MULTI_SELECT_LIST",
      "displayName": "Parameter 6",
      "values": [
        {
          "av": "07/20/2023 00:00:00",
          "dv": "07/20/2023 00:00:00",
          "isDefault": true
        },
        {
          "av": "07/26/2023 00:00:00",
          "dv": "07/26/2023 00:00:00",
          "isDefault": false
        },
        {
          "av": "07/28/2023 00:00:00",
          "dv": "07/28/2023 00:00:00",
          "isDefault": false
        }
      ],
      "format": {
            "av": "MM/DD/YYYY HH:mm:ss"
      }
    },
    {
      "id": "16897545172028127094067157926360",
      "name": "Parameter 5",
      "description": "",
      "type": "CUSTOM",
      "actualDisplayName": "",
      "dataType": "DATE",
      "control": "SINGLE_SELECT_LIST",
      "values": [
        {
          "av": "19 July 2023",
          "dv": "19 July 2023",
          "isDefault": false
        },
        {
          "av": "21 July 2023",
          "dv": "21 July 2023",
          "isDefault": false
        },
        {
          "av": "27 July 2023",
          "dv": "27 July 2023",
          "isDefault": true
        }
      ],
      "format": {
            "av": "DD MMMM YYYY"
      }
    },
    {
      "id": "16897545010740127082022145318323",
      "name": "Parameter 41",
      "description": "",
      "type": "CUSTOM",
      "actualDisplayName": "",
      "dataType": "DATE",
      "control": "INPUT",
      "defaultValue": "07/19/2023 13:48",
      "minValue": "07/17/2023 15:13",
      "maxValue": "07/31/2023 15:13",
      "format": {
            "av": "MM/DD/YYYY HH:mm"
            }
    },
    {
      "id": "16897544615855127079033149826791",
      "name": "Parameter 31",
      "description": "",
      "type": "CUSTOM",
      "actualDisplayName": "",
      "dataType": "DATE",
      "control": "INPUT",
      "defaultValue": "07/17/2023 00:00",
      "maxValue": "07/28/2023 15:13",
      "format": {
            "av":  "MM/DD/YYYY HH:mm"
            }
    },
    {
      "id": "16897544344401127048071127082861",
      "name": "Parameter 2",
      "description": "",
      "type": "CUSTOM",
      "actualDisplayName": "",
      "dataType": "DATE",
      "control": "INPUT",
      "defaultValue": "07/28/2023 01:44:05 PM",
      "minValue": "07/19/2023 12:00:00 AM",
      "format": {
            "av": "MM/DD/YYYY hh:mm:ss a"
      }
    },
    {
      "id": "16897543736078127022058195246555",
      "name": "Parameter 11",
      "description": "",
      "type": "CUSTOM",
      "actualDisplayName": "",
      "dataType": "DATE",
      "control": "INPUT",
      "defaultValue": "20.Jul.2023",
      "format": {
            "av": "DD.MMM.YYYY"
      }
    }
  ]

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully replaced workbook: Crosstab",
"CODE": 0
}

Export Import Utilities

Export Field Lineage Deprecated

This API is used to get field lineage detail for the given cube.

Note: API response downloads a zip file containing a CSV file and a SQL file (in case of SQL-based registered file).

Note: This API has been deprecated. Please refer alternate API /export/smodelDataLineage.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" "application/octet-stream" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request value: 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 schema: application/x-www-form-urlencoded

cubeName	string Cube name for which field lineage detail is requested.
cubeId	string Cube id for which field lineage detail is requested.
folderName	string Folder name of cube for which field lineage detail is requested.
folderId	string Folder id of cube for which field lineage detail is requested.
lineSeparator	string Characters for line separator. for e.g. ‘\r\n’
outputFileName	string Separator value by which folder names are separated.
fieldSeparator	string Delimiter to be used for each field. for e.g. ',' (comma)
enclosedBy	string Characters to be used for enclosing data. for e.g. “ (double quotes)
includeHeader	boolean Default: true Enum: true false Flag to include column headers in CSV file. Default Value: true

Responses

Export Semantic Model Field Lineage

This API is used to get field lineage detail for the given semantic model.

Note: API response downloads a zip file containing a CSV file and a SQL file (in case of SQL-based dataset).

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" "application/octet-stream" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request value: 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 schema: application/x-www-form-urlencoded

smodelName	string Semantic model name for which field lineage detail is requested.
smodelId	string Semantic model id for which field lineage detail is requested.
folderName	string Folder name of semantic model for which field lineage detail is requested.
folderId	string Folder id of semantic model for which field lineage detail is requested.
lineSeparator	string Characters for line separator. for e.g. ‘\r\n’
outputFileName	string Separator value by which folder names are separated.
fieldSeparator	string Delimiter to be used for each field. for e.g. ',' (comma)
enclosedBy	string Characters to be used for enclosing data. for e.g. “ (double quotes)
includeHeader	boolean Default: true Enum: true false Flag to include column headers in CSV file. Default Value: true

Responses

Export Worksheet Data

This API is used to export data of worksheets in PDF or CSV format.

Note: API response downloads a file in CSV or PDF format.

Authorizations:

sessionIdbasicAuth

header Parameters

Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request value: 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 schema: application/x-www-form-urlencoded

sheetId	string Unique sheet id for which the export is required
olapLayoutXML	string XML for olap layout of the sheet
outputFileName	string Custom file name to export the data as that file
lineSeparator	string Line separator to be used while exporting data to file
fieldSeparator	string Delimiter to be used for each field. For e.g. ',' (comma)
enclosedBy	string Characters to be used for enclosing data. For e.g. “ (double quotes)
exportViewType	string Type of view to be exported. For e.g. TABULAR
keepMeasureFormatting	boolean Enum: true false Flag to keep measure formatting in the exported data as well. Default Value: false
includeHeader	boolean Default: true Enum: true false Flag to specify whether to include headers information in exported file. Default Value: true
isZipped	boolean Default: false Enum: true false Flag to specify if the file should be zipped or not. Default Value: false
fileFormat	string Default: "csv" Enum: "csv" "pdf" Format in which the data would be exported. Possible values: csv or pdf Default Value: csv
themeId	string Enum: "duskBlue" "duskGray" Theme id to be applied in exported PDF to make PDF visually similar to UI. Possible values: duskBlue, darkGray etc.
includeTableView	boolean Default: false Enum: true false To include tabular data in exported PDF when visualization is chart. Default Value: false
includeCompleteData	boolean Default: false Enum: true false To include complete data in exported PDF when visualization is chart. Default Value: false

Responses

Execute Query

This API is used to execute SQL query.

Note: API response downloads a file in CSV/ZIP format.

Authorizations:

sessionIdbasicAuth

header Parameters

Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request value: 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 schema: application/x-www-form-urlencoded

queryType required	string Type of query which needs to be executed. Query type can be SQL.
query required	string Query which needs to be executed.
folderName	string Folder name of the semantic model on which query is to be executed.
outputFileName	string Custom file name to export the data as that file. Default file name is
lineSeparator	string Line separator to be used while exporting data to file
fieldSeparator	string Delimiter to be used for each field. For e.g. ',' (comma)
enclosedBy	string Characters to be used for enclosing data. For e.g. “ (double quotes)
includeHeader	boolean Default: true Enum: true false Flag to specify whether to include headers information in exported file. Default Value: true
zipped	boolean Default: false Enum: true false Flag to specify if the file should be zipped or not. Default Value: false
outputFormat required	string Value: "csv" Format in which the data would be exported. Possible values: csv.

Responses

Export Cube Query Details Deprecated

This API is used to get query details for the given cube.

Note: API response downloads a zip file, containing multiple files of query details.

Note: This API has been deprecated. Please refer alternate API /smodels/exportQueries.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeId	string Id of the cube from where you want to export the query details.
cubeName	string Name of the cube from where you want to export the query details.
folderName	string Name of the folder containing the cube from where you want to export the query details. If the cube is present on the root directory, give the folder name as [Root].
includeQueryPatterns	boolean Specify whether to include Query Patterns set on cube in export. Default value: `true`

header Parameters

Accept required	string Example: application/octet-stream Supported response type is application/octet-stream. Possible values:`application/octet-stream`
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Request Body schema: application/x-www-form-urlencoded

queryFilterJson

object

Query filters in string formatted JSON.
Example:

  [

  {
     "fieldName": "QUERY_ELAPSED_TIME",
     "operation": "EQUAL_TO",
     "dataType": "CHAR",
     "firstValue": "15000"
   },
   {
     "fieldName": "USER_NAME",
     "operation": "INLIST",
     "dataType": "CHAR",
     "firstValue": "user1,user2,user3"
   },
   {
     "fieldName": "QUERY_START_TIME",
     "operation": "LAST",
     "dataType": "NUMBER",
     "firstValue": "30",
     "secondValue": "Day"
   },
   {
     "fieldName": "QUERY_START_TIME",
     "operation": "GREATER_THAN",
     "dataType": "NUMBER",
     "firstValue": "1663754280000"
   },
   {
     "fieldName": "QUERY_START_TIME",
     "operation": "BETWEEN",
     "dataType": "NUMBER",
     "firstValue": "1663753250000",
     "secondValue": "1663754280000"
   }
 ]

Responses

Import Cube Query Details Deprecated

This API is used to import query details file for a Cube, which is exported from export query details functionality of cube.

Note: Only standard zip file which is exported from system is supported for import.

Note: This API has been deprecated. Please refer alternate API /smodels/importQueries.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeId	string Id of the cube of which you want to get the query details.
cubeName	string Name of the cube of which you want to get the query details.
folderName	string Name of the folder from which you want to get the cube. if the cube is present on the root directory, give the folder name as [Root]

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Request Body schema: multipart/form-data

file	string <binary> Select the zip file that you downloaded using the Export Query Details utility.

Responses

Import Semantic Model Query Details

This API is used to import query details file for a semantic model, which is exported from export query details functionality of semantic model.

Note: Only standard zip file which is exported from system is supported for import.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model of which you want to get the query details.
smodelName	string Name of the semantic model of which you want to get the query details.
folderName	string Name of the folder from which you want to get the semantic model. If the semantic model is present on the root directory, give the folder name as [Root]

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Request Body schema: multipart/form-data

file	string <binary> Select the zip file that you downloaded using the Export Query Details utility.

Responses

Export Semantic Model Query Details

This API is used to get query details for the given semantic model.

Note: API response downloads a zip file, containing multiple files of query details.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelId	string Id of the semantic model from where you want to export the query details.
smodelName	string Name of the semantic model from where you want to export the query details.
folderName	string Name of the folder containing the semantic model from where you want to export the query details. If the semantic model is present on the root directory, give the folder name as [Root].
includeQueryPatterns	boolean Specify whether to include Query Patterns set on semantic model in export. Default value: `true`

header Parameters

Accept required	string Example: application/octet-stream Supported response type is application/octet-stream. Possible values:`application/octet-stream`
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Request Body schema: application/x-www-form-urlencoded

queryFilterJson

object

Query filters in string formatted JSON.
Example:

  [

  {
     "fieldName": "QUERY_ELAPSED_TIME",
     "operation": "EQUAL_TO",
     "dataType": "CHAR",
     "firstValue": "15000"
   },
   {
     "fieldName": "USER_NAME",
     "operation": "INLIST",
     "dataType": "CHAR",
     "firstValue": "user1,user2,user3"
   },
   {
     "fieldName": "QUERY_START_TIME",
     "operation": "LAST",
     "dataType": "NUMBER",
     "firstValue": "30",
     "secondValue": "Day"
   },
   {
     "fieldName": "QUERY_START_TIME",
     "operation": "GREATER_THAN",
     "dataType": "NUMBER",
     "firstValue": "1663754280000"
   },
   {
     "fieldName": "QUERY_START_TIME",
     "operation": "BETWEEN",
     "dataType": "NUMBER",
     "firstValue": "1663753250000",
     "secondValue": "1663754280000"
   }
 ]

Responses

Export CAB

This API is used to export entities from Kyvos in CAB format.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept	string Example: application/xml Supported response type is application/xml. Possible values:`application/xml`
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Request Body schema: application/x-www-form-urlencoded

cabJSON

object

Entities detail in string formatted JSON.
Example:

  {
      "author": "",
      "smodels": {
        "advancedProp": true,
        "dataSecurity": true,
        "cachePopulationRules": true,
        "aggregates": true,
        "queryPatterns": true,
        "folders": [{
            "name": "Kyvos_DataAccuracyCubes",
            "override": "true",
            "entities": [{
                "name": "ACC_FF_PCHCR_Cal",
                "override": "true"
              },
              {
                "id": "16812853509888127046061146941756"
              },
              {
                "name": "BellC_PCH"
              },
              {
                "name": "Dell"
              }
            ],
            "type": "folder"
          },
          {
            "id": "folder_16716053495841127029047165313949",
            "entities": [{
              "id": "16906934882707127020029190399009"
            }],
            "type": "folder"
          }
        ],
        "entities": [{
          "id": "16566667071849127059097165347310"
        }]
      },
      "description": "",
      "drds": {
        "exportShortcuts": false,
        "folders": [{
          "id": "folder_15821204825224127094072117712024",
          "entities": [{
            "id": "16681095259487127086052146325492"
          }],
          "type": "folder"
        }],
        "entities": [{
          "id": "DRD_14399711893762127072090178966938"
        }]
      },
      "fileName": "APICAB",
      "groups": [{
          "name": "Adadmin"
        }
      ],
      "ignoreErrors": true,
      "importUnderlyingDatasourceForAll": null,
      "isExportAll": false,
      "isSelectAllUsers": false,
      "datasets": {
        "advancedProp": true,
        "folders": [{
          "name": "Access",
          "entities": [{
              "name": "RestName"
            },
            {
              "id": "RF_8F42FCEA-F907-3FEA-6678-319E171E71A8"
            }
          ],
          "type": "folder"
        }],
        "entities": []
      },
      "roles": [{
        "name": "Administrator"
      }],
      "users": [{
        "name": "$004800-8N1HLI1LAKJN"
      }],
      "version": "",
      "workbook": {
        "exportShortcuts": true,
        "folders": [{
            "id": "folder_16491419457997127016099193197617",
            "entities": [{
                "id": "Workbook16684272493842127045054147978133"
              },
              {
                "id": "Workbook16681723535856127017060146617969"
              }
            ],
            "type": "folder"
          },
          {
            "id": "folder_16565759123152127022016178781873",
            "entities": [{
              "id": "16544921810464127051060123765202"
            }],
            "type": "folder"
          }
        ],
        "entities": []
    }
  }

Responses

Import CAB

This API is used to import CAB on Kyvos.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Request Body schema: multipart/form-data

cabFile

string <binary>

Select the cab file that you want to import.

Responses

Properties

Get Advanced Properties

This API is used to get Advanced Properties XML with respect to the entity.

Authorizations:

sessionIdbasicAuth

query Parameters

entityId	string Id of the entity. Either entityId or entity Name is mandatory to get the entity object.
entityName	string Name of the Entity
folderName	string Folder name from which you want to get entity Object
folderId	string Folder Id from which you want to get entity Object
entityType	string Enum: "CUBE" "FILE" "DATASET" Example: entityType=CUBE Type Of entity you want to get properties for (CUBE/FILE/DATASET)
addResponseTag	string Enum: true false Example: addResponseTag=true Flag whether to include </ RESPONSE > tag or not. Default Value: True

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/xml

<ENTITIES>
    <ENTITY ID="14785863496990127073035173987473" SUB_TYPE="TRANSFORMATION" TYPE="QUERY">
        <ENTITY_PROPS_VALUES>
            <PROPERTY>
                <NAME>
                    <![CDATA[spark.kryoserializer.buffer.max]]>
                </NAME>
                <VALUE>
                    <![CDATA[64m]]>
                </VALUE>
                <MODE>
                    <![CDATA[MANUAL]]>
                </MODE>
            </PROPERTY>
            <PROPERTY>
                <NAME>
                    <![CDATA[kyvos.build.execution.engine]]>
                </NAME>
                <VALUE>
                    <![CDATA[mr]]>
                </VALUE>
                <MODE>
                    <![CDATA[MANUAL]]>
                </MODE>
            </PROPERTY>
        </ENTITY_PROPS_VALUES>
    </ENTITY>
</ENTITIES>

Save Advanced Properties

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

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

propertiesXML

required

object

Xml containing Entity and properties detail.

For e.g.

  <ENTITIES>
  <ENTITY ID="14785863496990127073035173987473" SUB_TYPE="TRANSFORMATION" TYPE="QUERY">
      <ENTITY_PROPS_VALUES>
          <PROPERTY>
              <NAME>
                  <![CDATA[spark.kryoserializer.buffer.max]]>
              </NAME>
              <VALUE>
                  <![CDATA[64m]]>
              </VALUE>
              <MODE>
                  <![CDATA[MANUAL]]>
              </MODE>
          </PROPERTY>
          <PROPERTY>
              <NAME>
                  <![CDATA[kyvos.build.execution.engine]]>
              </NAME>
              <VALUE>
                  <![CDATA[mr]]>
              </VALUE>
              <MODE>
                  <![CDATA[MANUAL]]>
              </MODE>
          </PROPERTY>
      </ENTITY_PROPS_VALUES>
  </ENTITY>
</ENTITIES>

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Entity properties added successfully.",
"CODE": 0
}

Security

Get Data Security Rule Deprecated

This API is used to get data security rule by name.

Note: This API has been deprecated. Please refer alternate API /smodels/dataSecurityRule/{ruleName}.

Authorizations:

sessionIdbasicAuth

path Parameters

ruleName

required

string

Get details by rule name

query Parameters

cubeName	string Name of the cube of which you want to get the Rules
folderName	string Name of the folder of which you want to get the Rules
addResponseTag	string Default: true Enum: true false Flag whether to wrap response in <RESPONSE> tag or not.

header Parameters

Accept	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"RULE": {"GLOBAL_TYPE": 0,
"ID": "RULE_16545849893267127075068144821158",
"DESC": "",
"NAME": "rulename",
"COLUMN_LEVEL": {"FIELDS": {"FIELD": {"RESTRICT": "DATA_AND_METADATA",
"ID": "MEASURE_159",
"TYPE": "MEASURE",
"NAME": "Measure_3"
}
}
}
}
}
}

Delete Data Security Rule Deprecated

This API to delete data security rule from an existing cube.

Note: This API has been deprecated. Please refer alternate API /smodels/dataSecurityRule/{ruleName}.

Authorizations:

sessionIdbasicAuth

path Parameters

ruleName

required

string

Name of the Data security rule that needs to be deleted.

query Parameters

cubeName required	string Name of a cube from which you want the data security rule to be deleted.
folderName required	string Name of the folder in which cube is present from which you want the data security rule to be deleted.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Data security rule deleted successfully.",
"CODE": 0
}

Get Data Security Rules Mapping Deprecated

This API is used to get the data security rules mapping.

Note: This API has been deprecated. Please refer alternate API /smodels/getDataSecurityRuleMapping.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeName	string Name of the cube of which you want to get the Rules
folderName	string Name of the folder of which you want to get the Rules

header Parameters

Accept	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"RULES_MAPPINGS": {"RULES_MAPPING": {"ID": "RULES_MAPPING_16545851751209127018017155190905",
"RULES": {"RULE": {"ID": "RULE_16545849893267127075068144821158",
"NAME": "rulename"
}
},
"APP_DETAILS": {"APP_DETAIL": {"ID": 41113809,
"TYPE": "GROUP",
"NAME": "ADSyncOperators"
}
}
}
}
}
}

Assign Data Security Rules Deprecated

Provide support of assigning multiple data security rules.
A new form parameter is added in this API which is named ruleMappingJSON.

Note: This API has been deprecated. Please refer alternate API /smodels/assignSecurityRule.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

cubeName	string Name of the cube of which you want to get the object
folderName	string Folder name of the cube of which you want to get the object
ruleMappingJSON	object ruleMappingJSON should be a valid JSON array having objects with cube name,group name,and rule name For e.g. [ { "userNames": "user1, user2", "groupNames": "group 1, group 2", "ruleNames": "Allow All Columns, Allow All Rows" }, { "userNames": "user1, user2=3", "groupNames": "group 2, group 3", "ruleNames": "Allow All Rows, massoperation_rule3" } ]

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Data security rule assigned successfully. one or more invalid mappings are ignored.",
"CODE": 0,
"INVALID_RULES_MAPPINGS": {"RULES_MAPPING": [{"groupNames": "group 1, group 2",
"invalidUserNames": "user1,user2",
"userNames": "user1, user2",
"ruleNames": "Allow All Columns, Allow All Rows",
"invalidGroupNames": "group 2"
},
{"groupNames": "group 2, group 3",
"InvalidruleNames": "massoperation_rule3",
"invalidUserNames": "user1,user2=3",
"userNames": "user1, user2=3",
"ruleNames": "Allow All Rows, massoperation_rule3",
"invalidGroupNames": "group 2,group 3"
}
]
}
}

Get All Data Security Rules Deprecated

This API is used to get all data security rules applied on a cube.

Note: This API has been deprecated. Please refer alternate API /smodels/dataSecurityRule.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeName	string Name of the cube of which you want to get the Rules
folderName	string Folder’s name that contains the given cube object.
addResponseTag	string Default: true Enum: true false Flag whether to wrap response in <RESPONSE> tag or not.

header Parameters

Accept	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"RULES": {"RULE": [{"GLOBAL_TYPE": 0,
"ID": 16738467645501587000,
"DESC": "",
"NAME": "cls_n",
"COLUMN_LEVEL": {"FIELDS": {"FIELD": {"RESTRICT": "DATA_AND_METADATA",
"ID": "DIM_175!!!H_270!!!DIMENSION_LEVEL_648",
"TYPE": "LEVEL",
"NAME": "Country"
}
}
}
},
{"GLOBAL_TYPE": 0,
"ID": 16738467645539897000,
"ROW_LEVEL": {"FILTERS": {"FILTER": {"RELATION": "AND",
"SECOND_VALUE": "",
"FIRST_VALUE_LEVEL_INDEX": "''",
"FIRST_VALUE": "'Liabilities and Owners Equity'",
"DELIMITER": "^`~",
"IS_MEMBER_VALUE": true,
"FIELD_TYPE": "DIMENSION",
"DATATYPE": "CHAR",
"FILTERTYPE": "ADVANCE",
"SUSPEND": false,
"OPERATION": "INLIST",
"START_ENCLOSURE": "",
"FIRST_DISPLAY_VALUE": "Liabilities and Owners Equity",
"FIELD_DISPLAY_NAME": "Account",
"FIELD_NAME": "DIM_815!!!H_1647!!!DIMENSION_LEVEL_4904",
"ID": "f1",
"SECOND_DISPLAY_VALUE": "",
"VALUE_TYPE": "predefined",
"END_ENCLOSURE": ""
}
}
},
"DESC": "",
"NAME": "Issue RLS"
}
]
}
}
}

Create Data Security Rules Deprecated

Used for creating and updating data security rules (Method = PUT for update POST for create). User can apply any of the following data security types through this API:

DATA_AND_METADATA: Restricts complete column with it's metadata.
DATA: Only restricts data of a column.
MASK_DATA: Masks values in a particular column.

Masking value should be of same data type as of the column. For example, numeric data should be masked with a number, a date should be masked with a date, and for string data type value can be either string or a regular expression.

Note: This API has been deprecated. Please refer alternate API /smodels/dataSecurityRule.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

bulk

boolean

Enum: true false

This is an optional parameter required in case of mass operation only, provide bulk=true to perform a mass operation for creating or updating rules.

ruleJSON

object

Users can set restrictions on column fields by setting restriction property in objects of the columnLevelRule JSON array. Possible values for restriction

DATA_AND_METADATA
DATA
MASK_DATA

In case if the restriction property is not provided, by default DATA is considered. For e.g.

{
"cubeName": "Subscription Analysis_50M",
"folderName": "Test",
"dataSecurityRules": [
{
"ruleName": "Rule1",
"description": "description1",
"columnLevelRule": [
{
"restriction": "DATA_AND_METADATA",
"fieldType": "ATTRIBUTE",
"fieldName": "playingtime",
"dimensionName": "Shows"
}
]
},
{
"ruleName": "Rule2",
"description": "description2",
"rowLevelRule": [
{
"dimensionName": "Shows",
"fieldName": "playingtime",
"operator": "EQUAL_TO",
"value": "1",
"secondValue": ""
}
],
"columnLevelRule": [
{
"fieldName": "playingtime",
"fieldType": "ATTRIBUTE",
"dimensionName": "Shows",
"restriction": "DATA_AND_METADATA"
},
{
"fieldName": "Country Name",
"dimensionName": "Subscription",
"fieldType": "ATTRIBUTE",
"restriction": "MASK_DATA",
"maskingInfo": {
"value": "",
"type": "FIX"
}
},
{
"fieldName": "User Id",
"dimensionName": "User",
"fieldType": "ATTRIBUTE",
"restriction": "MASK_DATA",
"maskingInfo": {
"value": "",
"type": "REGEX",
"regex": "\d"
}
}
]
}
]
}

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"RES": [{"MESSAGE": "Successfully added  the rule: Rule1",
"CODE": 0
},
{"MESSAGE": "Successfully added the rule: Rule2",
"CODE": 0
}
]
}
}

Revoke Data Security Rules Deprecated

This API to revoke Security Rules from an existing cube. properties.

Note: This API has been deprecated. Please refer alternate API /smodels/revokeSecurityRule.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

ruleNames required	string Name of the Data security rule that needs to be deleted
cubeName required	string Name of a cube from which you want the data security rule to be deleted.
groupNames	string Name of groups from which security rules needs to be removed
userNames	string Name of user from which security rules needs to be removed
folderName required	string Name of the folder in which cube is present from which you want the data security rule to be deleted.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Data security rule revoked successfully.",
"CODE": 0
}

Save Data Security Rules Deprecated

This API to add/update Data Security Rules for the cube. As this API performs bulk operation, you must have privileges to import and export objects to use this API.

Note: This API has been deprecated. Please refer alternate API /smodels/saveDataSecurityRules.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

rulesXML	object XML of the Rules to be saved. For e.g. <RULES> <RULE ID="15968064668354516337" GLOBAL_TYPE="0"> <NAME> <![CDATA[Rule1]]> </NAME> <DESC> <![CDATA[desc]]> </DESC> <ROW_LEVEL> <FILTERS> <FILTER DATATYPE="CHAR" FIELD_NAME="DIM_18!!!DIMENSION_HIERARCHY_22!!!DIMENSION_LEVEL_39" FIELD_TYPE="DIMENSION" FILTERTYPE="ADVANCE" ID="f1" IS_MEMBER_VALUE="true" OPERATION="INLIST" RELATION="AND" SUSPEND="false" VALUE_TYPE="predefined"> <START_ENCLOSURE/> <DELIMITER> <![CDATA[^`~]]> </DELIMITER> <FIRST_VALUE> <![CDATA['India']]> </FIRST_VALUE> <FIRST_DISPLAY_VALUE> <![CDATA[India]]> </FIRST_DISPLAY_VALUE> <SECOND_VALUE/> <SECOND_DISPLAY_VALUE/> <FIELD_DISPLAY_NAME> <![CDATA[Country]]> </FIELD_DISPLAY_NAME> <END_ENCLOSURE/> </FILTER> </FILTERS> </ROW_LEVEL> <COLUMN_LEVEL> <FIELDS> <FIELD ID="MEASURE_1956" TYPE="MEASURE"> <NAME> <![CDATA[Measure]]> </NAME> </FIELD> <FIELD ID="DIM_281!!!DIMENSION_ATTRIBUTE_568" RESTRICT="MASK_DATA" TYPE="ATTRIBUTE"> <NAME> <![CDATA[Country Name]]> </NAME> <MASKING_INFO> <MASK_VALUE TYPE="REGEX"> <VALUE> <![CDATA[*]]> </VALUE> <REGEX> <![CDATA[\d]]> </REGEX> </MASK_VALUE> </MASKING_INFO> </FIELD> </FIELDS> </COLUMN_LEVEL> </RULE> <RULE ID="23468064667354516231" GLOBAL_TYPE="0"> <NAME> <![CDATA[Rule2]]> </NAME> <DESC> <![CDATA[desc]]> </DESC> <COLUMN_LEVEL> <FIELDS> <FIELD ID="MEASURE_1956" TYPE="MEASURE"> <NAME> <![CDATA[Measure]]> </NAME> </FIELD> </FIELDS> </COLUMN_LEVEL> </RULE> </RULES>
cubeName	string Name of the cube Rules are saving for
cubeId	string ID of the cube for which you want to save rules. If you do not know the cubeId, use the cubeName and folderName/folderId.
folderId	string Folder ID from to which the Cube Object belongs.
folderName	string Folder name to which the Cube Object belongs.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"RES": [{"MESSAGE": "Successfully added rule: Rule 1",
"CODE": 0
},
{"MESSAGE": "Successfully added rule: Rule 2",
"CODE": 0
}
]
}
}

Save Data Security Rules Mapping Deprecated

This API to update the Data Security Rules mapping for a cube.

Note: This API has been deprecated. Please refer alternate API /smodels/saveDataSecurityRulesMapping.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

rulesMappingXML	object XML of the Rules to be saved. For e.g. <RULES_MAPPINGS> <RULES_MAPPING ID="RULES_MAPPING_16037828307185127065047188048156"> <APP_DETAILS> <APP_DETAIL ID="1170732" TYPE="GROUP"/> </APP_DETAILS> <RULES> <RULE ID="14664020714885446520"/> </RULES> </RULES_MAPPING> </RULES_MAPPINGS>
cubeName	string Name of the cube for which you are saving Rules.
cubeId	string ID of the cube for which you are saving Rules.
folderId	string Folder ID from to which the Cube Object belongs.
folderName	string Folder name to which the Cube Object belongs.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Data security rule assigned successfully.",
"CODE": 0
}

Get All Data Security Rules

This API is used to get all data security rules applied on a semantic model.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelName	string Name of the semantic model of which you want to get the Rules
folderName	string Name of the folder of semantic model of which you want to get the rules. If semantic model is present in root directory then provide [Root] as its value. If no value is provided then semantic model will be searched in root directory.
addResponseTag	string Default: true Enum: true false Flag whether to wrap response in <RESPONSE> tag or not.

header Parameters

Accept	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"RULES": {"RULE": [{"GLOBAL_TYPE": 0,
"ID": 16738467645501587000,
"DESC": "",
"NAME": "cls_n",
"COLUMN_LEVEL": {"FIELDS": {"FIELD": {"RESTRICT": "DATA_AND_METADATA",
"ID": "DIM_175!!!H_270!!!DIMENSION_LEVEL_648",
"TYPE": "LEVEL",
"NAME": "Country"
}
}
}
},
{"GLOBAL_TYPE": 0,
"ID": 16738467645539897000,
"ROW_LEVEL": {"FILTERS": {"FILTER": {"RELATION": "AND",
"SECOND_VALUE": "",
"FIRST_VALUE_LEVEL_INDEX": "''",
"FIRST_VALUE": "'Liabilities and Owners Equity'",
"DELIMITER": "^`~",
"IS_MEMBER_VALUE": true,
"FIELD_TYPE": "DIMENSION",
"DATATYPE": "CHAR",
"FILTERTYPE": "ADVANCE",
"SUSPEND": false,
"OPERATION": "INLIST",
"START_ENCLOSURE": "",
"FIRST_DISPLAY_VALUE": "Liabilities and Owners Equity",
"FIELD_DISPLAY_NAME": "Account",
"FIELD_NAME": "DIM_815!!!H_1647!!!DIMENSION_LEVEL_4904",
"ID": "f1",
"SECOND_DISPLAY_VALUE": "",
"VALUE_TYPE": "predefined",
"END_ENCLOSURE": ""
}
}
},
"DESC": "",
"NAME": "Issue RLS"
}
]
}
}
}

Create Data Security Rules

Used for creating and updating data security rules (Method = PUT for update POST for create). User can apply any of the following data security types through this API:

DATA_AND_METADATA: Restricts complete column with it's metadata.
DATA: Only restricts data of a column.
MASK_DATA: Masks values in a particular column.

Masking value should be of same data type as of the column. For example, numeric data should be masked with a number, a date should be masked with a date, and for string data type value can be either string or a regular expression.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

bulk

boolean

Enum: true false

This is an optional parameter required in case of mass operation only, provide bulk=true to perform a mass operation for creating or updating rules.

ruleJSON

object

Users can set restrictions on column fields by setting restriction property in objects of the columnLevelRule JSON array. Possible values for restriction

DATA_AND_METADATA
DATA
MASK_DATA

In case if the restriction property is not provided, by default DATA is considered. For e.g.

{
"cubeName": "Subscription Analysis_50M",
"folderName": "Test",
"dataSecurityRules": [
{
"ruleName": "Rule1",
"description": "description1",
"columnLevelRule": [
{
"restriction": "DATA_AND_METADATA",
"fieldType": "ATTRIBUTE",
"fieldName": "playingtime",
"dimensionName": "Shows"
}
]
},
{
"ruleName": "Rule2",
"description": "description2",
"rowLevelRule": [
{
"dimensionName": "Shows",
"fieldName": "playingtime",
"operator": "EQUAL_TO",
"value": "1",
"secondValue": "",
"isAppliedOnDisplayField": false
}
],
"columnLevelRule": [
{
"fieldName": "playingtime",
"fieldType": "ATTRIBUTE",
"dimensionName": "Shows",
"restriction": "DATA_AND_METADATA"
},
{
"fieldName": "Country Name",
"dimensionName": "Subscription",
"fieldType": "ATTRIBUTE",
"restriction": "MASK_DATA",
"maskingInfo": {
"value": "",
"type": "FIX"
}
},
{
"fieldName": "User Id",
"dimensionName": "User",
"fieldType": "ATTRIBUTE",
"restriction": "MASK_DATA",
"maskingInfo": {
"value": "",
"type": "REGEX",
"regex": "\d"
}
}
]
}
]
}

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"RES": [{"MESSAGE": "Successfully added  the rule: Rule1",
"CODE": 0
},
{"MESSAGE": "Successfully added the rule: Rule2",
"CODE": 0
}
]
}
}

Get Data Security Rule

This API is used to get data security rule by name.

Authorizations:

sessionIdbasicAuth

path Parameters

ruleName

required

string

Name of data security rule to be fetched

query Parameters

smodelName	string Name of the semantic model of which you want to get the rule.
folderName	string Name of the folder of semantic model of which you want to get the rule. If semantic model is present in root directory then provide [Root] as its value. If no value is provided then semantic model will be searched in root directory.
addResponseTag	string Default: true Enum: true false Flag whether to wrap response in <RESPONSE> tag or not.

header Parameters

Accept	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"RULE": {"GLOBAL_TYPE": 0,
"ID": "RULE_16545849893267127075068144821158",
"DESC": "",
"NAME": "rulename",
"COLUMN_LEVEL": {"FIELDS": {"FIELD": {"RESTRICT": "DATA_AND_METADATA",
"ID": "MEASURE_159",
"TYPE": "MEASURE",
"NAME": "Measure_3"
}
}
}
}
}
}

Delete Data Security Rule

This API is used to delete data security rule from an existing semantic model.

Authorizations:

sessionIdbasicAuth

path Parameters

ruleName

required

string

Name of the Data security rule that needs to be deleted.

query Parameters

smodelName required	string Name of the semantic model from which you want the data security rule to be deleted.
folderName required	string Name of the folder of semantic model of which you want to delete the rule. If semantic model is present in root directory then provide [Root] as its value. If no value is provided then semantic model will be searched in root directory.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Data security rule deleted successfully.",
"CODE": 0
}

Get Data Security Rules Mapping

This API is used to get the data security rules mapping.

Authorizations:

sessionIdbasicAuth

query Parameters

smodelName	string Name of the semantic model of which you want to get the Rules
folderName	string Name of the folder of which you want to get the Rules
smodelId	string Id of the semantic model of which you want to get the Rules. If Id is not available then provide smodelName and folderName/folderId.
folderId	string Id of the folder of semantic model of which you want to get the Rules.
addResponseTag	string Default: true whether to add response tag in returned xml or not. Default is true
addRuleName	string Default: true whether to add rule name in returned xml or not. Default is true

header Parameters

Accept	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"RULES_MAPPINGS": {"RULES_MAPPING": {"ID": "RULES_MAPPING_16545851751209127018017155190905",
"RULES": {"RULE": {"ID": "RULE_16545849893267127075068144821158",
"NAME": "rulename"
}
},
"APP_DETAILS": {"APP_DETAIL": {"ID": 41113809,
"TYPE": "GROUP",
"NAME": "ADSyncOperators"
}
}
}
}
}
}

Save Data Security Rules

This API to add/update Data Security Rules for a semantic model. As this API performs bulk operation, you must have privileges to import and export objects to use this API.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

rulesXML	object XML of the Rules to be saved. For e.g. <RULES> <RULE ID="15968064668354516337" GLOBAL_TYPE="0"> <NAME> <![CDATA[Rule1]]> </NAME> <DESC> <![CDATA[desc]]> </DESC> <ROW_LEVEL> <FILTERS> <FILTER DATATYPE="CHAR" FIELD_NAME="DIM_18!!!DIMENSION_HIERARCHY_22!!!DIMENSION_LEVEL_39" FIELD_TYPE="DIMENSION" FILTERTYPE="ADVANCE" ID="f1" IS_MEMBER_VALUE="true" OPERATION="INLIST" RELATION="AND" SUSPEND="false" VALUE_TYPE="predefined"> <START_ENCLOSURE/> <DELIMITER> <![CDATA[^`~]]> </DELIMITER> <FIRST_VALUE> <![CDATA['India']]> </FIRST_VALUE> <FIRST_DISPLAY_VALUE> <![CDATA[India]]> </FIRST_DISPLAY_VALUE> <SECOND_VALUE/> <SECOND_DISPLAY_VALUE/> <FIELD_DISPLAY_NAME> <![CDATA[Country]]> </FIELD_DISPLAY_NAME> <END_ENCLOSURE/> </FILTER> </FILTERS> </ROW_LEVEL> <COLUMN_LEVEL> <FIELDS> <FIELD ID="MEASURE_1956" TYPE="MEASURE"> <NAME> <![CDATA[Measure]]> </NAME> </FIELD> <FIELD ID="DIM_281!!!DIMENSION_ATTRIBUTE_568" RESTRICT="MASK_DATA" TYPE="ATTRIBUTE"> <NAME> <![CDATA[Country Name]]> </NAME> <MASKING_INFO> <MASK_VALUE TYPE="REGEX"> <VALUE> <![CDATA[*]]> </VALUE> <REGEX> <![CDATA[\d]]> </REGEX> </MASK_VALUE> </MASKING_INFO> </FIELD> </FIELDS> </COLUMN_LEVEL> </RULE> <RULE ID="23468064667354516231" GLOBAL_TYPE="0"> <NAME> <![CDATA[Rule2]]> </NAME> <DESC> <![CDATA[desc]]> </DESC> <COLUMN_LEVEL> <FIELDS> <FIELD ID="MEASURE_1956" TYPE="MEASURE"> <NAME> <![CDATA[Measure]]> </NAME> </FIELD> </FIELDS> </COLUMN_LEVEL> </RULE> </RULES>
smodelName	string Name of the semantic model to which rules are to be saved.
smodelId	string ID of the semantic model for which you want to save rules. If you do not know the smodelId, use the smodelName and folderName/folderId.
folderId	string Folder ID from to which the Semantic Model Object belongs.
folderName	string Folder name to which the Semantic Model Object belongs.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"RES": [{"MESSAGE": "Successfully added rule: Rule 1",
"CODE": 0
},
{"MESSAGE": "Successfully added rule: Rule 2",
"CODE": 0
}
]
}
}

Save Data Security Rules Mapping

This API is used to update the Data Security Rules mapping for a semantic model.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

rulesMappingXML	object XML of the Rules to be saved. For e.g. <RULES_MAPPINGS> <RULES_MAPPING ID="RULES_MAPPING_16037828307185127065047188048156"> <APP_DETAILS> <APP_DETAIL ID="1170732" TYPE="GROUP"/> </APP_DETAILS> <RULES> <RULE ID="14664020714885446520"/> </RULES> </RULES_MAPPING> </RULES_MAPPINGS>
smodelName	string Name of the semantic model for which you are saving Rules.
smodelId	string ID of the semantic model for which you are saving Rules.
folderId	string Folder ID to which the Semantic Model Object belongs.
folderName	string Folder name to which the Semantic Model Object belongs.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Data security rule assigned successfully.",
"CODE": 0
}

Revoke Data Security Rules

This API to revoke Security Rules from an existing semantic model.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

ruleNames required	string Name of the Data security rule that needs to be deleted
smodelName required	string Name of the semantic model from which you want the data security rule to be deleted.
groupNames	string Name of groups from which security rules needs to be removed
userNames	string Name of user from which security rules needs to be removed
folderName required	string Name of the folder of semantic model. If semantic model is present in root directory then provide [Root] as its value. If no value is provided then semantic model will be searched in root directory.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Data security rule revoked successfully.",
"CODE": 0
}

Assign Data Security Rules

Provide support of assigning multiple data security rules.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept	string Value: "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

smodelName	string Name of the semantic model of which you want to get the object
folderName	string Name of the folder of semantic model. If semantic model is present in root directory then provide [Root] as its value. If no value is provided then semantic model will be searched in root directory.
ruleMappingJSON	object ruleMappingJSON should be a valid JSON array having objects with user names, group names, and rule names For e.g. [ { "userNames": "user1, user2", "groupNames": "group 1, group 2", "ruleNames": "Allow All Columns, Allow All Rows" }, { "userNames": "user1, user2=3", "groupNames": "group 2, group 3", "ruleNames": "Allow All Rows, massoperation_rule3" } ]

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Data security rule assigned successfully. One or more invalid mappings are ignored.",
"CODE": 0,
"INVALID_RULES_MAPPINGS": {"RULES_MAPPING": [{"groupNames": "group 1, group 2",
"invalidUserNames": "user1,user2",
"userNames": "user1, user2",
"ruleNames": "Allow All Columns, Allow All Rows",
"invalidGroupNames": "group 2"
},
{"groupNames": "group 2, group 3",
"InvalidruleNames": "massoperation_rule3",
"invalidUserNames": "user1,user2=3",
"userNames": "user1, user2=3",
"ruleNames": "Allow All Rows, massoperation_rule3",
"invalidGroupNames": "group 2,group 3"
}
]
}
}

Share

Get Entity Access Rights

This API is used to get the entity access rights.

Authorizations:

sessionIdbasicAuth

query Parameters

entityId required	string Example: entityId=CUBE_982567132462786289289 Id of entity. In case of two different workbooks in the same folder containing worksheets with same name, entityId is a mandatory parameter to get access rights.
entityName	string Example: entityName=testtt Name of entity
entityType required	string Enum: "RDATASET" "DATASET" "RELATIONSHIP" "SMODEL" "WORKBOOK" "WORKSHEET" "CONNECTION" Example: entityType=CUBE Type of entity of which you want to get the access rights. Possible values: RDATASET, DATASET, RELATIONSHIP, SMODEL, CONNECTION, WORKSHEET and WORKBOOK. Note: FILE and CUBE have been deprecated. Use SMODEL in place of CUBE and RDATASET in place of FILE.
folderName	string Example: folderName=akg Name of a folder from which you want to get entity. if the entity is present on the root directory, give folder name as [Root].
folderId	string Example: folderId=akg Id of folder from which you want to get entity. This is an optional parameter.

header Parameters

Accept required	string Example: application/json Type of the response either JSON or XML.(Application/XML or Application/JSON)
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"ACCESSRIGHTS": {"GROUPS": [{"GRANT": "Read Only",
"ID": "12339",
"NAME": "Enterprise Admins"
},
{"GRANT": "Read Only",
"ID": "226622736",
"NAME": "Adadmin"
}
],
"USERS": [{"GRANT": "Read And Write",
"ID": "16431206097023127027099196486501",
"NAME": "CustomAdmin"
}
]
}
}

Get Folder Access Rights

This API is used to get a folder access rights.

Authorizations:

sessionIdbasicAuth

query Parameters

folderName required	string
folderType required	string Enum: "RDATASET" "DATASET" "RELATIONSHIP" "SMODEL" "WORKBOOK" "WORKSHEET" Example: folderType=FILE Type of entity of folder of which you want to get the access rights. Possible values: RDATASET, DATASET, RELATIONSHIP, SMODEL, WORKSHEET and WORKBOOK. Note: FILE and CUBE have been deprecated. Use SMODEL in place of CUBE and RDATASET in place of FILE.

header Parameters

Accept required	string Example: application/json Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"ACCESSRIGHTS": {"GROUPS": [{"GRANT": "Read Only",
"ID": "12339",
"NAME": "Enterprise Admins"
},
{"GRANT": "Read Only",
"ID": "226622736",
"NAME": "Adadmin"
}
],
"USERS": [{"GRANT": "Read And Write",
"ID": "16431206097023127027099196486501",
"NAME": "CustomAdmin"
}
]
}
}

Share Entity

This API is used to share an entity with a particular User/Group.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

entityName	string Name of the entity to be shared
entityFolderName	string Folder Name that contains the entity. If not sent, then it will search entity at root Folder
entityType required	string Enum: "RDATASET" "RELATIONSHIP" "DATASET" "SMODEL" "WORKBOOK" "WORKSHEET" "CONNECTION" Type of the entity to be shared. Possible values: RDATASET, RELATIONSHIP, DATASET, SMODEL, WORKBOOK, CONNECTION, and WORKSHEET. Note: FILE and CUBE have been deprecated. Use SMODEL in place of CUBE and RDATASET in place of FILE.
shareAppType required	string Enum: "USER" "GROUP" App type to which entity is to be shared. Possible values: USER and GROUP
shareAppName required	string App name to which entity must be shared. Either User or Group name
grant required	string Enum: "READ_ONLY" "READ_WRITE" "DENY" Grant to which entity must be shared.Possible values: READ_ONLY, READ_WRITE and DENY
workbookName	string Name of the workboo contains worksheet.Required for entity type WORKSHEET
shareUnderlyingSourceEntities	boolean Whether to share the access for the underlying entities. Default value is true.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Entity shared successfully.",
"CODE": 0
}

Share Folder

This API is used to share a folder with a particular User/Group.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

folderName required	string Name of the folder to be shared
folderType required	string Enum: "RDATASET" "RELATIONSHIP" "DATASET" "SMODEL" "WORKBOOK" "WORKSHEET" Type of entity of the folder to be shared. Possible values: RDATASET, RELATIONSHIP, DATASET, SMODEL, WORKBOOK, and WORKSHEET. Note: FILE and CUBE have been deprecated. Use SMODEL in place of CUBE and RDATASET in place of FILE.
shareAppType required	string Enum: "USER" "GROUP" App type to which entity is to be shared. Possible values: USER and GROUP
shareAppName required	string App name to which entity must be shared. Either User or Group name
grant required	string Enum: "READ_ONLY" "READ_WRITE" "DENY" Grant to which entity must be shared.Possible values: READ_ONLY, READ_WRITE and DENY

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Folder shared successfully.",
"CODE": 0
}

Update Access Rights on Entity

This API is used to update the Access rights of the entity already shared.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

entityName	string Name of the entity to be shared
entityFolderName	string Folder Name that contains the entity. If not sent, then it will search entity at root Folder
entityType required	string Enum: "RDATASET" "RELATIONSHIP" "DATASET" "SMODEL" "WORKBOOK" "WORKSHEET" "CONNECTION" Type of the entity of which access rights are to be updated. Possible values: RDATASET, RELATIONSHIP, DATASET, SMODEL, WORKBOOK, CONNECTION, and WORKSHEET. Note: FILE and CUBE have been deprecated. Use SMODEL in place of CUBE and RDATASET in place of FILE.
shareAppType required	string Enum: "USER" "GROUP" App type to which entity is to be shared. Possible values: USER and GROUP
shareAppName required	string App name to which entity must be shared. Either User or Group name
grant required	string Enum: "READ_ONLY" "READ_WRITE" "DENY" Grant to which entity must be shared.Possible values: READ_ONLY, READ_WRITE and DENY
workbookName	string Name of the workboo contains worksheet.Required for entity type WORKSHEET
shareUnderlyingSourceEntities	boolean Whether to share the access for the underlying entities. Default value is true.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Entity access rights updated successfully.",
"CODE": 0
}

Update Access Rights on Folder

This API is used to update the Access right of a folder already shared.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

folderName required	string Name of the folder to be shared
folderType required	string Enum: "RDATASET" "RELATIONSHIP" "DATASET" "SMODEL" "WORKBOOK" "WORKSHEET" Type of entity of the folder whose access rights are to be updated. Possible values: RDATASET, RELATIONSHIP, DATASET, SMODEL, WORKBOOK, and WORKSHEET. Note: FILE and CUBE have been deprecated. Use SMODEL in place of CUBE and RDATASET in place of FILE.
shareAppType required	string Enum: "USER" "GROUP" App type to which entity is to be shared. Possible values: USER and GROUP
shareAppName required	string App name to which entity must be shared. Either User or Group name
grant required	string Enum: "READ_ONLY" "READ_WRITE" "DENY" Grant to which entity must be shared.Possible values: READ_ONLY, READ_WRITE and DENY

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Folder access rights updated successfully.",
"CODE": 0
}

Delete Entity Access Rights

This API is used to delete the Access rights of an entity already shared.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

entityName required	string Name of the entity to be shared
entityFolderName	string Folder Name that contains the entity. If not sent, then it will search entity at root Folder
entityType required	string Enum: "RDATASET" "RELATIONSHIP" "DATASET" "SMODEL" "WORKBOOK" "WORKSHEET" "CONNECTION" Type of the entity of which access rights are to be deleted. Possible values: RDATASET, RELATIONSHIP, DATASET, SMODEL, WORKBOOK, CONNECTION and WORKSHEET. Note: FILE and CUBE have been deprecated. Use SMODEL in place of CUBE and RDATASET in place of FILE.
shareAppType required	string Enum: "USER" "GROUP" App type to which entity is to be shared. Possible values: USER and GROUP
shareAppName required	string App name to which entity must be shared. Either User or Group name

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Entity access rights deleted successfully.",
"CODE": 0
}

Delete Folder Access Rights

This API is used to delete the Access right of a folder already shared.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

folderName required	string Name of the folder for which access right has to be deleted
folderType required	string Enum: "RDATASET" "RELATIONSHIP" "DATASET" "SMODEL" "WORKBOOK" "WORKSHEET" Type of entity of the folder of which access rights are to be deleted. Possible values: RDATASET, RELATIONSHIP, DATASET, SMODEL, WORKBOOK, and WORKSHEET. Note: FILE and CUBE have been deprecated. Use SMODEL in place of CUBE and RDATASET in place of FILE.
shareAppType required	string Enum: "USER" "GROUP" App type to which entity is to be shared. Possible values: USER and GROUP
shareAppName required	string App name to which entity must be shared. Either User or Group name

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Folder access rights deleted successfully.",
"CODE": 0
}

Folders

Create a folder

This API is used to Add a folder for an entity. It is applicable for all entities cubes, files, relationships, and datasets.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

folderName required	string Name of the folder to be created.
folderType required	string Enum: "RDATASET" "RELATIONSHIP" "SMODEL" "WORKBOOK" Type of entity for which the folder is to be created. Possible values: RDATASET, RELATIONSHIP, SMODEL, and WORKBOOK. Note: FILE and CUBE have been deprecated. Use SMODEL in place of CUBE and RDATASET in place of FILE.
folderId	string An id that will be assigned to the folder being created. if not provided, Kyvos will generate an unique id for it.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"FOLDER": {"PRIVILEGE": "",
"USER_ID": "",
"ID": "folder_8DCBD479-2A98-3795-19E0-F91599B875E84",
"ENTITY_TYPE": "ANALYTICAL",
"DESC": "",
"ENTITY_SUB_TYPE": "CUBE",
"NAME": "Test Folder"
}
}
}

Update a folder

This API is used to update an existing folder for an entity. It is applicable for all entities cubes, files, relationships, and datasets.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

folderName	string Current name of the folder, Please provide one of folderId and folderName.
folderId	string Id of the folder, Please provide one of folderId and folderName.
updatedName required	string A new name which the folder will be renamed to.
folderType required	string Enum: "RDATASET" "RELATIONSHIP" "SMODEL" "WORKBOOK" Type of entity for which the folder is to be updated. Possible values: RDATASET, RELATIONSHIP, SMODEL, and WORKBOOK. Note: FILE and CUBE have been deprecated. Use SMODEL in place of CUBE and RDATASET in place of FILE.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully replaced folder: New Folder1",
"CODE": 0
}

Delete a folder

This API is used to delete an existing folder for an entity. It is applicable for all entities cubes, files, relationships, and datasets.

Authorizations:

sessionIdbasicAuth

query Parameters

folderId	string Id of the folder, Please provide one of folderId and folderName.
folderName	string Name of the folder, Please provide one of folderId and folderName.
folderType required	string Enum: "RDATASET" "RELATIONSHIP" "SMODEL" "WORKBOOK" Type of entity for which the folder is to be deleted. Possible values: RDATASET, RELATIONSHIP, SMODEL, and WORKBOOK. Note: FILE and CUBE have been deprecated. Use SMODEL in place of CUBE and RDATASET in place of FILE.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully deleted folder",
"CODE": 0
}

Add/Update Folder List

This API is used to Add or Update the the folder list for an entity. It is applicable for all entities cubes, files, relationships, and datasets. As this API performs bulk operation, you must have privileges to import and export objects to use this API.

Authorizations:

sessionIdbasicAuth

query Parameters

entityType

string

Enum: "SMODEL" "RDATASET" "RELATIONSHIP" "WORKBOOK"

Type of entity for which the folder list is to be saved. Possible values: RDATASET, RELATIONSHIP, SMODEL and WORKBOOK.

  Note: FILE and CUBE have been deprecated. Use SMODEL in place of CUBE and RDATASET in place of FILE.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

folderListXML

required

object

XML of the folder list to be saved.

For e.g.

  <FOLDERS>

    <FOLDER ACCESSRIGHTS="1" ENTITY_SUB_TYPE="REGISTERED" ENTITY_TYPE="QUERY" GRANT_TYPE="USER" ID="folder_15435753989522127038096194931438" REPOSIT_DATE="03/30/2020 19:06:45" USER_ID="Admin" USER_NAME="admin">
         <NAME>
             <! [CDATA[Folder 1]]>
         </NAME>
         <DESC>
             <! [CDATA[File folder note]]>
         </DESC>
     </FOLDER>
     <FOLDER ACCESSRIGHTS="1" ENTITY_SUB_TYPE="REGISTERED" ENTITY_TYPE="QUERY" GRANT_TYPE="USER" ID="folder_15434785321737127073078196887453" REPOSIT_DATE="11/29/2018 13:32:13" USER_ID="Admin" USER_NAME="admin">
         <NAME>
             <![CDATA[Folder 2]]>
         </NAME>
         <DESC/>
     </FOLDER>
     <FOLDER ACCESSRIGHTS="1" ENTITY_SUB_TYPE="REGISTERED" ENTITY_TYPE="QUERY" GRANT_TYPE="USER" ID="folder_15312191694704127099055187967882" REPOSIT_DATE="07/10/2018 16:33:06" USER_ID="Admin" USER_NAME="admin">
         <NAME>
             <![CDATA[Folder 3]]>
         </NAME>
         <DESC/>
     </FOLDER>
 </FOLDERS>

Responses

Response samples

200

Content type

application/json

[{"entityId": "folder_15435753989522127038096194931438",
"statusCode": "0",
"message": "Successfully replaced folder: Test Folder 1",
"extMessage": ""
},
{"entityId": "folder_15434785321737127073078196887453",
"statusCode": "0",
"message": "Successfully replaced folder:  ",
"extMessage": ""
},
{"entityId": "folder_15312191694704127099055187967882",
"statusCode": "0",
"message": "Successfully replaced folder: Test Folder 2",
"extMessage": ""
}
]

Related Entities

Get Related Entities

This API is used to get related entities.

Here, type and subType can be:

For registered file:

type: QUERY, subType: REGISTERED

type: QUERY, subType: TRANSFORMATION

For relationships :

type: DRD_OBJECT subType: empty

For worksheet:

type: WORKSHEET subType: SHEET

For Cube:

type: ANALYTICAL subType: CUBE

In case of Worksheet, the folderName must be same as the Workbook Name.

Authorizations:

sessionIdbasicAuth

query Parameters

id	string Id of the cube object. Either cubeId or cubeName is mandatory to get the cube object
name	string Name of the cube object.
folderName	string Name of the cube of which you want to get the object
type	string Enum: "QUERY" "DRD_OBJECT" "Worksheet" "Analytical" Type of entity, like ANALYTICAL, DRD_OBJECT, QUERY, WORKSHEET, etc.
subType	string Enum: "REGISTERED" "TRANSFORMATION" "SHEET" "SMODEL" Sub type of the entity like SMODEL, REGISTER, SHEET etc. Note: SubType CUBE has been deprecated. Use SMODEL in place of it.

header Parameters

Accept required	string Value: "application/json" Example: application/json Supported response types are JSON. Possible values: application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"Sheet16413947251594127074039123683763": {"workbookName": "Chart Colors Amchart 5 Testing",
"owner": "user 1",
"lastModifiedDate": "01/05/2022 20:28:45",
"ownerAppId": "253292788",
"folderOwnerAppId": "",
"name": "Crosstab",
"subType": "SHEET",
"accessRights": 1,
"folderName": "",
"type": "WORKSHEET",
"workbookId": "16413947250001127027024185439525",
"folderId": ""
},
"Sheet16584096381966127095055172885199": {"workbookName": "Chart Colors2 copy 1",
"owner": "user 2",
"lastModifiedDate": "07/21/2022 18:50:38",
"ownerAppId": "203488099",
"folderOwnerAppId": "203488099",
"name": "Crosstab copy 1",
"subType": "SHEET",
"accessRights": 1,
"folderName": "test-folder",
"type": "WORKSHEET",
"workbookId": "16584096377215127085071150584743",
"folderId": "folder_16584095984545127059098172219291"
}
}

Cluster Operations

Build Cluster

This API is used to create/terminate/sync the build cluster.

CREATE: This operation name is used to create a new Build Cluster.

TERMINATE: This operation name is used to terminate the Build Cluster, before executing the operation please check if any build is going on or scheduled within the inactive time interval if the request is successful and Build Cluster creation failed, if the request fails.

SYNC: This operation name is to sync the Build Cluster.

Authorizations:

sessionIdbasicAuth

query Parameters

clusterType	string Default: "BUILD" Value: "BUILD" Type of cluster. Default Value: BUILD
action	string Enum: "CREATE" "TERMINATE" "SYNC" Name of the operation

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

dataJSON

object

Data JSON

Responses

Cluster Scaling

Get load based elasticity rules

This API is used to get the load based elasticity rules.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Example: application/json Supported response types are JSON. Possible values: application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RULES": [{"STATUS": "ENABLED",
"UNIT": "MINUTE",
"RULE_ID": "2097805",
"RULE_TYPE": "SCALE_UP",
"QUERY_COUNT": "1",
"EVENT_TYPE": "QUERIES_FIRED",
"COMPONENTS": "QE",
"TARGET_STATE": "100",
"DURATION": "35",
"GROUP": "SCALE_UP_GROUP",
"ALLOW_STATUS_CHANGE": "YES"
},
{"STATUS": "ENABLED",
"UNIT": "MINUTE",
"RULE_ID": "8402535",
"RULE_TYPE": "START_UP",
"QUERY_COUNT": "0",
"EVENT_TYPE": "QUERIES_FIRED",
"COMPONENTS": "QE",
"TARGET_STATE": "100",
"DURATION": "0",
"GROUP": "SCALE_UP_GROUP",
"ALLOW_STATUS_CHANGE": "NO"
},
{"STATUS": "ENABLED",
"UNIT": "MINUTE",
"RULE_ID": "2097804",
"RULE_TYPE": "SCALE_DOWN",
"QUERY_COUNT": "0",
"EVENT_TYPE": "NO_QUERIES_FIRED",
"COMPONENTS": "QE",
"TARGET_STATE": "100",
"DURATION": "30",
"GROUP": "SCALE_DOWN_GROUP",
"ALLOW_STATUS_CHANGE": "YES"
},
{"STATUS": "ENABLED",
"UNIT": "MINUTE",
"RULE_ID": "8402534",
"RULE_TYPE": "SHUT_DOWN",
"QUERY_COUNT": "0",
"EVENT_TYPE": "NO_QUERIES_FIRED",
"COMPONENTS": "BI,QE",
"TARGET_STATE": "0",
"DURATION": "60",
"GROUP": "SCALE_DOWN_GROUP",
"ALLOW_STATUS_CHANGE": "YES"
}
]
}

Get cluster capacity steps details

This API is used to get cluster capacity details having configured capacities and it's values

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Example: application/json Supported response types are JSON. Possible values: application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"steps": [{"name": "Zero",
"runCapacity": "0",
"value": "0"
},
{"name": "Low",
"runCapacity": "25",
"value": "25"
},
{"name": "Moderate",
"runCapacity": "50",
"value": "50"
},
{"name": "Full",
"runCapacity": "100",
"value": "100"
}
]
}

Save load based elasticity rules

This API is used to save load based elasticity rules.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Example: application/json Supported response types are JSON. Possible values: application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: application/x-www-form-urlencoded

Request Body schema: application/x-www-form-urlencoded

loadBasedRules

object

This parameter contains load based rules in JSON format (array having rules object)

To get keys of the rules object, use can use GET load based rules API.

For target state (TARGET_STATE), user can use GET cluster capacity steps details API and use values in rules object.

Note: All keys are mandatory in rules object.

Default values are mentioned in example:

  [
    {
      "STATUS": "ENABLED",
      "UNIT": "MINUTE",
      "RULE_ID": "2097805",
      "RULE_TYPE": "SCALE_UP",
      "QUERY_COUNT": "1",
      "EVENT_TYPE": "QUERIES_FIRED",
      "COMPONENTS": "QE",
      "TARGET_STATE": "100",
      "DURATION": "35",
      "GROUP": "SCALE_UP_GROUP",
      "ALLOW_STATUS_CHANGE": "YES"
    },
    {
      "STATUS": "ENABLED",
      "UNIT": "MINUTE",
      "RULE_ID": "8402535",
      "RULE_TYPE": "START_UP",
      "QUERY_COUNT": "0",
      "EVENT_TYPE": "QUERIES_FIRED",
      "COMPONENTS": "QE",
      "TARGET_STATE": "100",
      "DURATION": "0",
      "GROUP": "SCALE_UP_GROUP",
      "ALLOW_STATUS_CHANGE": "NO"
    },
    {
      "STATUS": "ENABLED",
      "UNIT": "MINUTE",
      "RULE_ID": "2097804",
      "RULE_TYPE": "SCALE_DOWN",
      "QUERY_COUNT": "0",
      "EVENT_TYPE": "NO_QUERIES_FIRED",
      "COMPONENTS": "QE",
      "TARGET_STATE": "100",
      "DURATION": "30",
      "GROUP": "SCALE_DOWN_GROUP",
      "ALLOW_STATUS_CHANGE": "YES"
    },
    {
      "STATUS": "ENABLED",
      "UNIT": "MINUTE",
      "RULE_ID": "8402534",
      "RULE_TYPE": "SHUT_DOWN",
      "QUERY_COUNT": "0",
      "EVENT_TYPE": "NO_QUERIES_FIRED",
      "COMPONENTS": "BI,QE",
      "TARGET_STATE": "0",
      "DURATION": "60",
      "GROUP": "SCALE_DOWN_GROUP",
      "ALLOW_STATUS_CHANGE": "YES"
    }
  ]

Responses

Response samples

200

Content type

application/json

[{"RULE_ID": "8402534",
"successMsg": "Rule updated successfully"
},
{"RULE_ID": "2097804",
"successMsg": "Rule updated successfully"
},
{"RULE_ID": "2097805",
"successMsg": "Rule updated successfully"
},
{"RULE_ID": "8402535",
"successMsg": "Rule updated successfully"
}
]

Get time based elasticity rules

This API is used to get the time based elasticity rules.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/XML" "application/JSON" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/xml

<RESPONSE>
  <SCHEDULEINFOS>
    <SCHEDULEINFO>
      <BATCH BATCHID="16768864007797127028043178859785" BATCHNAME="16768864007797127028043178859785" TYPE="STATIC" BATCHRUNTYPE="SCHD" ISPUBLIC="FALSE" ISSHARED="FALSE" USERID="16672118701580127035049187434540" ORGID="" ENTITYID="" ENTITYTYPE="" ENTITY_SUB_TYPE="">
        <COMMON>
          <SYSPARAMS>
            <PARAM NAME="BUILD_TYPE">
              <PARAMVALUE>
                <![CDATA[CLUSTER_SCALING]]>
              </PARAMVALUE>
            </PARAM>
            <PARAM NAME="BUILD_PROP_ID">
              <PARAMVALUE>
              <![CDATA[16768863980877127060098145491271]]>
              </PARAMVALUE>
            </PARAM>
            <PARAM NAME="BUILD_SOURCE_DATASETS">
              <PARAMVALUE>
                <![CDATA[IFNEEDED]]>
              </PARAMVALUE>
            </PARAM>
            <PARAM NAME="TITLE">
              <PARAMVALUE>
                <![CDATA[Run at full capacity]]>
              </PARAMVALUE>
              </PARAM>
            <PARAM NAME="QE_CAPACITY">
              <PARAMVALUE>
                <![CDATA[100]]>
              </PARAMVALUE>
            </PARAM>
            <PARAM NAME="CLUSTER_MODE">
              <PARAMVALUE>
                <![CDATA[RUNNING]]>
              </PARAMVALUE>
            </PARAM>
            <PARAM NAME="AUTO_SLEEP">
              <PARAMVALUE>
                <![CDATA[NO]]>
              </PARAMVALUE>
            </PARAM>
            <PARAM NAME="AUTO_SLEEP_TIME">
              <PARAMVALUE><![CDATA[0]]></PARAMVALUE>
            </PARAM>
          </SYSPARAMS>
          <USERPARAMS>
          </USERPARAMS>
        </COMMON>
      </BATCH>
      <SCHEDULEDJOB JOBTYPE="RECUR" JOBID="16768863980877127060098145491271" ISPUBLIC="false" ENTITYID="" ENTITYNAME="" ENTITYTYPE="" ENTITY_SUB_TYPE="" ISSHARED="false" USERID="16672118701580127035049187434540" ORGID="" BATCHID="16768864007797127028043178859785" NAME="16768864007797127028043178859785">
          <ONCE DATE="" TIME="" END_DATE="" END_TIME="" TIMEZONE=""/>
          <RECUR SCHEDULEID="16768864007790127031022119932140"/>
          <RETRY SHOULDRETRY="FALSE"/>
          <CONDITIONAL_DELETION DELETE_ON_COMPLETION="true"></CONDITIONAL_DELETION>
          <REPLACE_PARTITION REPLACE="false" EXCLUDE_CURRENT="true"/>
      </SCHEDULEDJOB>
      <SCHEDULE FREQUENCYTYPE="WEEKLY" STARTDATE="02/20/2023" ENDDATE="" TIMEZONE="GMT+00:00" ISPUBLIC="FALSE" ISSHARED="FALSE" USERID="16672118701580127035049187434540" ORGID="" SCHEDULEID="16768864007790127031022119932140" NAME="16768864007790127031022119932140" STARTTIME="04:30" ENDTIME="06:30">
          <WEEKLY WEEKLYEVERY="1" WEEKLYDAYS="0"  WEEKGROUPID="89b4b3e9-3e24-4216-aede-c98c296c86a3_GROUPID" WEEKGROUP="WEEKEND" />
          <TIME TYPE="ONCE">
              <ONCE ONCETIME="04:30"/>
          </TIME>
      </SCHEDULE>
    </SCHEDULEINFO>
  </SCHEDULEINFOS>
</RESPONSE>

Add time based elasticity rule

This API is used to add a new time based elasticity rule.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: application/x-www-form-urlencoded

Request Body schema: application/x-www-form-urlencoded

ruleXML

required

object

XML of a schedule object. This XML can be generated with the help of com.kyvos.commons.entity.reportobjects.ScheduleInfo Class.
For e.g.

 <SCHEDULEINFO>
                       <BATCH BATCHID="16768864007797127028043178859785" BATCHNAME="16768864007797127028043178859785" TYPE="STATIC" BATCHRUNTYPE="SCHD" ISPUBLIC="FALSE" ISSHARED="FALSE" USERID="16672118701580127035049187434540" ORGID="" ENTITYID="" ENTITYTYPE="" ENTITY_SUB_TYPE="">
                           <COMMON>
                             <SYSPARAMS>
                               <PARAM NAME="BUILD_TYPE">
                                 <PARAMVALUE>
                                   <![CDATA[CLUSTER_SCALING]]>
                                 </PARAMVALUE>
                               </PARAM>
                               <PARAM NAME="BUILD_PROP_ID">
                                 <PARAMVALUE><![CDATA[16768863980877127060098145491271]]>
                                 </PARAMVALUE>
                               </PARAM>
                               <PARAM NAME="BUILD_SOURCE_DATASETS">
                                 <PARAMVALUE>
                                   <![CDATA[IFNEEDED]]>
                                 </PARAMVALUE>
                               </PARAM>
                               <PARAM NAME="TITLE">
                                 <PARAMVALUE>
                                   <![CDATA[Run at full capacity]]>
                                 </PARAMVALUE>
                               </PARAM>
                               <PARAM NAME="QE_CAPACITY">
                                 <PARAMVALUE>
                                   <![CDATA[100]]>
                                 </PARAMVALUE>
                               </PARAM>
                               <PARAM NAME="CLUSTER_MODE">
                                   <PARAMVALUE>
                                       <![CDATA[RUNNING]]>
                                   </PARAMVALUE>
                               </PARAM>
                               <PARAM NAME="AUTO_SLEEP">
                                   <PARAMVALUE>
                                       <![CDATA[NO]]>
                                   </PARAMVALUE>
                               </PARAM>
                               <PARAM NAME="AUTO_SLEEP_TIME">
                                   <PARAMVALUE>
                                       <![CDATA[0]]>
                                   </PARAMVALUE>
                               </PARAM>
                             </SYSPARAMS>
                             <USERPARAMS>
                             </USERPARAMS>
                           </COMMON>
                       </BATCH>
                       <SCHEDULEDJOB JOBTYPE="RECUR" JOBID="16768863980877127060098145491271" ISPUBLIC="false" ENTITYID="" ENTITYNAME="" ENTITYTYPE="" ENTITY_SUB_TYPE="" ISSHARED="false" USERID="16672118701580127035049187434540" ORGID="" BATCHID="16768864007797127028043178859785" NAME="16768864007797127028043178859785">
                           <ONCE DATE="" TIME="" END_DATE="" END_TIME="" TIMEZONE=""/>
                           <RECUR SCHEDULEID="16768864007790127031022119932140"/>
                           <RETRY SHOULDRETRY="FALSE"/>
                           <CONDITIONAL_DELETION DELETE_ON_COMPLETION="true"></CONDITIONAL_DELETION>
                           <REPLACE_PARTITION REPLACE="false" EXCLUDE_CURRENT="true"/>
                       </SCHEDULEDJOB>
                       <SCHEDULE FREQUENCYTYPE="WEEKLY" STARTDATE="02/20/2023" ENDDATE="" TIMEZONE="GMT+00:00" ISPUBLIC="FALSE" ISSHARED="FALSE" USERID="16672118701580127035049187434540" ORGID="" SCHEDULEID="16768864007790127031022119932140" NAME="16768864007790127031022119932140" STARTTIME="04:30" ENDTIME="06:30">
                           <WEEKLY WEEKLYEVERY="1" WEEKLYDAYS="0"  WEEKGROUPID="89b4b3e9-3e24-4216-aede-c98c296c86a3_GROUPID" WEEKGROUP="WEEKEND" />
                           <TIME TYPE="ONCE">
                               <ONCE ONCETIME="04:30"/>
                           </TIME>
                       </SCHEDULE>
                     </SCHEDULEINFO>

Responses

Response samples

200

Content type

application/json

{"CODE": "0",
"MESSAGE": "Successfully added schedule"
}

Add time based elasticity rule for current time

This API is used to add a new time based elasticity rule applicable to the current time.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: application/x-www-form-urlencoded

Request Body schema: application/x-www-form-urlencoded

clusterMode required	string Enum: "RUNNING" "SUSPENDED" This is to provide the desired state of the cluster when the schedule is executed. if clusterMode is RUNNING, then the cluster will keep on running with BI servers and the specified capacity of query servers but when cluster mode is SUSPENDED, then no BI or Query server will be running.
qeCapacity required	number This parameter is used to provide the % of Query server capacity. its maximum value is 100.
endDateTime required	string This is to provide the end date and time for the schedule, it should be in MM/dd/yyyy HH:mm format. and its value must be 1 hour after the current time as a schedule can not be of less than 100 hour.
title	string This is to provide the title of the schedule. if not provided then system will use some default value for it.

Responses

Response samples

200

Content type

application/json

{"CODE": "0",
"MESSAGE": "Successfully added schedule"
}

Update time based elasticity rule

This API is used to update an existing time based elasticity rule.

Authorizations:

sessionIdbasicAuth

path Parameters

jobId

required

string

Value of JOBID attribute of SCHEDULEDJOB XML element.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: application/x-www-form-urlencoded

Request Body schema: application/x-www-form-urlencoded

ruleXML

required

object

XML of a schedule object. This XML can be generated with the help of com.kyvos.commons.entity.reportobjects.ScheduleInfo Class.
For e.g.

 <SCHEDULEINFO>
                       <BATCH BATCHID="16768864007797127028043178859785" BATCHNAME="16768864007797127028043178859785" TYPE="STATIC" BATCHRUNTYPE="SCHD" ISPUBLIC="FALSE" ISSHARED="FALSE" USERID="16672118701580127035049187434540" ORGID="" ENTITYID="" ENTITYTYPE="" ENTITY_SUB_TYPE="">
                           <COMMON>
                             <SYSPARAMS>
                               <PARAM NAME="BUILD_TYPE">
                                 <PARAMVALUE>
                                   <![CDATA[CLUSTER_SCALING]]>
                                 </PARAMVALUE>
                               </PARAM>
                               <PARAM NAME="BUILD_PROP_ID">
                                 <PARAMVALUE><![CDATA[16768863980877127060098145491271]]>
                                 </PARAMVALUE>
                               </PARAM>
                               <PARAM NAME="BUILD_SOURCE_DATASETS">
                                 <PARAMVALUE>
                                   <![CDATA[IFNEEDED]]>
                                 </PARAMVALUE>
                               </PARAM>
                               <PARAM NAME="TITLE">
                                 <PARAMVALUE>
                                   <![CDATA[Run at full capacity]]>
                                 </PARAMVALUE>
                               </PARAM>
                               <PARAM NAME="QE_CAPACITY">
                                 <PARAMVALUE>
                                   <![CDATA[100]]>
                                 </PARAMVALUE>
                               </PARAM>
                               <PARAM NAME="CLUSTER_MODE">
                                   <PARAMVALUE>
                                       <![CDATA[RUNNING]]>
                                   </PARAMVALUE>
                               </PARAM>
                               <PARAM NAME="AUTO_SLEEP">
                                   <PARAMVALUE>
                                       <![CDATA[NO]]>
                                   </PARAMVALUE>
                               </PARAM>
                               <PARAM NAME="AUTO_SLEEP_TIME">
                                   <PARAMVALUE>
                                       <![CDATA[0]]>
                                   </PARAMVALUE>
                               </PARAM>
                             </SYSPARAMS>
                             <USERPARAMS>
                             </USERPARAMS>
                           </COMMON>
                       </BATCH>
                       <SCHEDULEDJOB JOBTYPE="RECUR" JOBID="16768863980877127060098145491271" ISPUBLIC="false" ENTITYID="" ENTITYNAME="" ENTITYTYPE="" ENTITY_SUB_TYPE="" ISSHARED="false" USERID="16672118701580127035049187434540" ORGID="" BATCHID="16768864007797127028043178859785" NAME="16768864007797127028043178859785">
                           <ONCE DATE="" TIME="" END_DATE="" END_TIME="" TIMEZONE=""/>
                           <RECUR SCHEDULEID="16768864007790127031022119932140"/>
                           <RETRY SHOULDRETRY="FALSE"/>
                           <CONDITIONAL_DELETION DELETE_ON_COMPLETION="true"></CONDITIONAL_DELETION>
                           <REPLACE_PARTITION REPLACE="false" EXCLUDE_CURRENT="true"/>
                       </SCHEDULEDJOB>
                       <SCHEDULE FREQUENCYTYPE="WEEKLY" STARTDATE="02/20/2023" ENDDATE="" TIMEZONE="GMT+00:00" ISPUBLIC="FALSE" ISSHARED="FALSE" USERID="16672118701580127035049187434540" ORGID="" SCHEDULEID="16768864007790127031022119932140" NAME="16768864007790127031022119932140" STARTTIME="04:30" ENDTIME="06:30">
                           <WEEKLY WEEKLYEVERY="1" WEEKLYDAYS="0"  WEEKGROUPID="89b4b3e9-3e24-4216-aede-c98c296c86a3_GROUPID" WEEKGROUP="WEEKEND" />
                           <TIME TYPE="ONCE">
                               <ONCE ONCETIME="04:30"/>
                           </TIME>
                       </SCHEDULE>
                     </SCHEDULEINFO>

Responses

Response samples

200

Content type

application/json

{"CODE": "0",
"MESSAGE": "Successfully updated schedule"
}

Delete a time based elasticity rule

This API is used to delete a time based elasticity rule.

Authorizations:

sessionIdbasicAuth

path Parameters

jobId

required

string

Value of JOBID attribute of SCHEDULEDJOB XML element.

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"CODE": "0",
"MESSAGE": "Successfully deleted schedule"
}

Delete all time based elasticity rules

This API is used to delete all time based elasticity rules.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Enum: "application/xml" "application/json" Example: application/xml Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

[{"CODE": "0",
"MESSAGE": "Successfully deleted schedule"
},
{"CODE": "0",
"MESSAGE": "Successfully deleted schedule"
}
]

Get cluster scaling related default settings

This API is used to get the default settings related to the cluster scaling schedules.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/json" Example: application/json Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"GROUPS": {"WEEKDAYS": {"DAYS": [2,
3,
4,
5,
6
],
"TYPE": "WEEK",
"GROUPID": "3fcdab9b-b9ba-47f7-86ae-8db50797460c_GROUPID"
},
"WEEKEND": {"DAYS": [1,
7
],
"TYPE": "WEEK",
"GROUPID": "e6395711-5b18-4bf2-a3b5-a8d8ad095faf_GROUPID"
}
},
"CONFIGURATION": {"STATUS": "RUNNING",
"ELASTICITY_BY": "TIME",
"TIMEFORMAT": 24,
"TIMEZONE": "GMT+00:00",
"MAX_QE": 6,
"QE_CAPACITY": 100
}
}

Save cluster scaling related default settings

This API is used to save the default settings related to the cluster scaling schedules.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/json" Example: application/json Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: application/x-www-form-urlencoded

Request Body schema: application/x-www-form-urlencoded

clusterSettings

required

object

Clsuter scaling default setting JSON similar to the one that returned by the getDefaultSettings API
For e.g.

 {
     "GROUPS": { 
         "WEEKDAYS": { 
             "DAYS": [2, 3, 4, 5, 6 ], 
             "TYPE": "WEEK", 
             "GROUPID": "3fcdab9b-b9ba-47f7-86ae-8db50797460c_GROUPID" 
         }, 
         "WEEKEND": { 
             "DAYS": [ 1, 7 ], 
             "TYPE": "WEEK", 
             "GROUPID": "e6395711-5b18-4bf2-a3b5-a8d8ad095faf_GROUPID"
         } 
     }, 
     "CONFIGURATION": { 
         "STATUS": "RUNNING",
         "ELASTICITY_BY": "TIME",
         "TIMEFORMAT": 24,
         "TIMEZONE": "GMT+00:00",
         "MAX_QE": 6,
         "QE_CAPACITY": 100
     }
 }

Responses

Response samples

200

Content type

application/json

{"CODE": "0",
"MESSAGE": "Cluster default settings saved successfully."
}

Registered Files

Get Registered Files Deprecated

This API is used to fetch the list of folders or the list of files.

Note: This API has been deprecated. Please refer alternate API /rdatasets.

Authorizations:

sessionIdbasicAuth

query Parameters

show	string Enum: "all" "folders" "list" Example: show=all This parameter is used to control the objects returned in the response. the response can have a list of only folders, a list of only entities, or both, based on other filters applied. The default value is 'all' all: Response list contains a combined list of folders and entities. list: Response list shows only the entity list. folders: Response list shows only the folders list.
OWNER	string This parameter filters entities by owner (the user who created that entity) name.
TAGS	string This parameter filters the entities by tags.
SEARCH_TEXT	string This parameter filters the entities by their names. All entities whose name contains the searched text are included in the result, irrespective of the case format.
MODIFIED_AFTER	string This parameter filters the entities by their last modified timestamp. All the entities modified after the provided timestamp are included in the result.
MODIFIED_BEFORE	string This parameter filters the entities by their last modified timestamp. All the entities modified before the provided timestamp are included in the result.
COUNT	number This parameter sets the number of the records displayed in the response. It is applicable only for show=list or show=folders but not with show=all.
LAST_ENTITY_NAME	string When this parameter is used, the response shows only the entities occurring after the entity name specified in this parameter. The list ignores all the entities before that.
LAST_ENTITY_ID	string When this parameter is used, the response shows only the entities occurring after the entity ID specified in this parameter. The list ignores all the entities before that.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"REGISTERED_FILES": {"REGISTERED_FILE": [{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594134652,
"LAST_MODIFIED": "11/16/2022 15:52:14",
"id": "15330142847572127083069172553064",
"NAME": "Action"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594134837,
"LAST_MODIFIED": "11/16/2022 15:52:14",
"id": "15330144283295127073098167664670",
"NAME": "ActionSource"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594135042,
"LAST_MODIFIED": "11/16/2022 15:52:15",
"id": "15330140041630127043070144312748",
"NAME": "History_audit_log"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594135175,
"LAST_MODIFIED": "11/16/2022 15:52:15",
"id": "15337218288972127087010144746596",
"NAME": "Querying file"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594135292,
"LAST_MODIFIED": "11/16/2022 15:52:15",
"id": "15330152151294127095012168885668",
"NAME": "SourceType"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594135400,
"LAST_MODIFIED": "11/16/2022 15:52:15",
"id": "15330152764897127073059118152259",
"NAME": "Status"
}
]
}
}
}

Create Registered File Deprecated

This API is used to create a new Registered File Object.

Note: This API has been deprecated. Please refer alternate API /rdatasets.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

registerFileXML

required

object

XML of a RegisterFile Object. This xml can be generated with the help of com.kyvos.client.reportobjects.wrappers.RegisteredFile class.
For e.g.

 <IRO ID="16612546785471127089091117761211" NAME="Untitled File 1" TYPE="QUERY" SUBTYPE="REGISTERED" FOLDER_ID="folder_16282337673341127087061149752657" ISPUBLIC="true" FOLDER_NAME="1JPMC_DRR">
      <COMMON>
        <DESC>
          <![CDATA[]]>
        </DESC>
      </COMMON>
      <SPECIFIC>
        <FILTERS>
          <FILTER NAME="COPY_ACCESS_RIGHTS" OPERATOR="=">
            <VALUE>
              <![CDATA[1]]>
            </VALUE>
          </FILTER>
          <FILTER NAME="SRC_ENTITY_ID" OPERATOR="=">
            <VALUE>
              <![CDATA[]]>
            </VALUE>
          </FILTER>
        </FILTERS>
        <QO CACHED="true" CONN_NAME="DefaultHadoopCluster01" ROLE="DIMENSION" CONN_TYPE="HADOOP_CLUSTER">
          <TRANSFORMATION>
            <LAYOUT HSCROLLVALUE="0" VSCROLLVALUE="0" STEPS_PANEL_WIDTH="" TRANSFORMATION_PANEL_HEIGHT="" SELECTED_STEP_ID=""/>
            <STEPS>
              <STEP ID="16612546785471127089091117761273" NAME="Fetch" TYPE="FETCH" LEFT="0" TOP="0">
                <INPUT_STEPS>
                <OUTPUT_STEPS>
                <STEP_INFO>
                  <FETCH_INFO>
                    <FETCH CONN_NAME="DefaultHadoopCluster01" CONN_TYPE="PARENT" LOOKUP_ENABLED="false" IS_SORTED="false" SOURCE="SEQ" INPUT_TYPE="">
                      <SPARK_JDBC_DATA_PARTITION_COLUMN>
                        <COLUMN_NAME>
                          <![CDATA[]]>
                        </COLUMN_NAME>
                        <TABLE_NAME>
                          <![CDATA[]]>
                        </TABLE_NAME>
                        <METADATA_MODE>
                          <![CDATA[DEFAULT]]>
                        </METADATA_MODE>
                        <NUMBER_OF_PARTITIONS>
                          <![CDATA[]]>
                        </NUMBER_OF_PARTITIONS>
                        <MIN_VALUE>
                          <![CDATA[]]>
                        </MIN_VALUE>
                        <MAX_VALUE>
                          <![CDATA[]]>
                        </MAX_VALUE>
                        <NUMBER_OF_RECORDS>
                          <![CDATA[]]>
                        </NUMBER_OF_RECORDS>
                      </SPARK_JDBC_DATA_PARTITION_COLUMN>
                      <SEQSOURCE>
                        <PATH>
                          <![CDATA[ranger/audit/hdfs/hdfs/20210716/hdfs_ranger_audit_intelli-i0051.kyvostest.com.log]]>
                        </PATH>
                        <FILE_TYPE>
                          <![CDATA[SEQ]]>
                        </FILE_TYPE>
                        <ENTITY_TYPE>
                          <![CDATA[FILE]]>
                        </ENTITY_TYPE>
                        <RECORD_SEPARATOR>
                          <![CDATA[]]>
                        </RECORD_SEPARATOR>
                        <SEPARATOR>
                          <![CDATA[SOH]]>
                        </SEPARATOR>
                        <ENCLOSURE>
                          <![CDATA["]]>
                        </ENCLOSURE>
                        <ESCAPECHAR>
                          <![CDATA[]]>
                        </ESCAPECHAR>
                        <HEADER>
                          <![CDATA[false]]>
                        </HEADER>
                        <IGNORE_EMPTY_ROWS>
                          <![CDATA[true]]>
                        </IGNORE_EMPTY_ROWS>
                        <ENCODING>
                          <![CDATA[ASCII]]>
                        </ENCODING>
                        <COMPRESSION>
                          <![CDATA[NONE]]>
                        </COMPRESSION>
                        <REQUEST_METHOD>
                          <![CDATA[GET]]>
                        </REQUEST_METHOD>
                        <KEY_AS_COLUMN>
                          <![CDATA[true]]>
                        </KEY_AS_COLUMN>
                        <NAME_AS_COLUMN>
                          <![CDATA[false]]>
                        </NAME_AS_COLUMN>
                        <SKIP_LINES TOP = "0" BOTTOM = "0" />
                        <DATE_FORMAT>
                          <![CDATA[null]]>
                        </DATE_FORMAT>
                      </SEQSOURCE>
                    </FETCH>
                    <COLUMNS></COLUMNS>
                  </FETCH_INFO>
                </STEP_INFO>
              </STEP>
            </STEPS>
          </TRANSFORMATION>
        </QO>
      </SPECIFIC>
    </IRO>

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully added register file: Untitled File 1",
"CODE": 0
}

Get Registered Files From Folder Deprecated

This API is needed to get a Registered File listing from a specific folder.

Note: This API has been deprecated. Please refer alternate API /rdatasets/folder/{folderNameOrId}.

Authorizations:

sessionIdbasicAuth

path Parameters

folderNameOrId

required

string

Name or Id of a folder from which you want to get a list of Registered files. Firstly, parameter folderNameOrId will be treated as Id. In case no Registered File is found with that Id, then it will search for a Registered File by taking nameOrId as Name

query Parameters

OWNER	string This parameter filters entities by owner (the user who created that entity) name.
TAGS	string This parameter filters the entities by tags.
SEARCH_TEXT	string This parameter filters the entities by their names. All entities whose name contains the searched text are included in the result, irrespective of the case format.
MODIFIED_AFTER	string This parameter filters the entities by their last modified timestamp. All the entities modified after the provided timestamp are included in the result.
MODIFIED_BEFORE	string This parameter filters the entities by their last modified timestamp. All the entities modified before the provided timestamp are included in the result.
COUNT	number This parameter sets the number of the records displayed in the response.
LAST_ENTITY_NAME	string When this parameter is used, the response shows only the entities occurring after the entity name specified in this parameter. The list ignores all the entities before that.
LAST_ENTITY_ID	string When this parameter is used, the response shows only the entities occurring after the entity ID specified in this parameter. The list ignores all the entities before that.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"REGISTERED_FILES": {"REGISTERED_FILE": [{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594134652,
"LAST_MODIFIED": "11/16/2022 15:52:14",
"id": "15330142847572127083069172553064",
"NAME": "Action"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594134837,
"LAST_MODIFIED": "11/16/2022 15:52:14",
"id": "15330144283295127073098167664670",
"NAME": "ActionSource"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594135042,
"LAST_MODIFIED": "11/16/2022 15:52:15",
"id": "15330140041630127043070144312748",
"NAME": "History_audit_log"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594135175,
"LAST_MODIFIED": "11/16/2022 15:52:15",
"id": "15337218288972127087010144746596",
"NAME": "Querying file"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594135292,
"LAST_MODIFIED": "11/16/2022 15:52:15",
"id": "15330152151294127095012168885668",
"NAME": "SourceType"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594135400,
"LAST_MODIFIED": "11/16/2022 15:52:15",
"id": "15330152764897127073059118152259",
"NAME": "Status"
}
]
}
}
}

Get Registered File Deprecated

This API is used to get a Registered File Object.

Note: This API has been deprecated. Please refer alternate API /rdatasets/{nameOrId}.

Authorizations:

sessionIdbasicAuth

path Parameters

nameOrId

required

string

Name or Id of Registered File. Firstly, parameter nameOrId will be treated as Id. In case no Registered File is found with that Id, then it will search for a Registered File by taking nameOrId as Name. In case of nameOrId as Name, folderNameOrId is used

query Parameters

folderNameOrId

string

Name or Id of a folder from which you want to get Registered file. First, parameter folderNameOrId will be treated as Id. In case no folder is found with that Id, then it will search for a folder by taking folderNameOrId as Name

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"IRO": {"SUBTYPE": "REGISTERED",
"CATEGORY_ID": "folder_16282337673341127087061149752657",
"ACCESSRIGHTS": 1,
"FOLDER_ID": "folder_16282337673341127087061149752657",
"NAME": "Bu_D1",
"FOLDER_NAME": "1JPMC_DRR",
"OWNERAPPID": "15825358151067127060075128810359",
"SPECIFIC": {"QO": {"ROLE": "DIMENSION",
"TRANSFORMATION": {"LAYOUT": {"VSCROLLVALUE": 0,
"STEPS_PANEL_WIDTH": "",
"HSCROLLVALUE": 0,
"SELECTED_STEP_ID": "",
"TRANSFORMATION_PANEL_HEIGHT": ""
},
"STEPS": {"STEP": {"STEP_INFO": {"FETCH_INFO": {"FETCH": {"SOURCE_SUB_TYPE": "",
"CONN_TYPE": "PARENT",
"LOOKUP_ENABLED": false,
"IS_SORTED": false,
"INCREMENTAL_IDENTIFIER": {"COLUMN_NAME": ""
},
"SOURCE": "HCATALOG",
"CONN_NAME": "",
"INPUT_TYPE": "SQL",
"SPARK_JDBC_DATA_PARTITION_COLUMN": {"TABLE_NAME": "",
"NUMBER_OF_PARTITIONS": "",
"NUMBER_OF_RECORDS": "",
"COLUMN_NAME": "",
"METADATA_MODE": "DEFAULT",
"MAX_VALUE": "",
"MIN_VALUE": ""
},
"SQL_SOURCE": {"SQL": "SELECT\nD.BU_entityI,\nD.BUSINESS_UNIT_ID,\nD.NM_LONG,\nD.BU_DISPLAYNAME,\nCASE WHEN D.BU_entityID = D.PARENTID THEN D.HIERARCHY_ID ELSE D.PARENTID END AS PARENTID,\nD.HIERARCHY_ID,\nD.HIERARCHY_NM\nFROM jpmcbu.bu_pch D\nWHERE D.HIERARCHY_ID in ('5','13','16')\n\nUNION\n\nSELECT\nA.HIERARCHY_ID AS BU_entityID,\n\"\" AS BUSINESS_UNIT_ID,\nA.HIERARCHY_NM AS NM_LONG,\nA.HIERARCHY_NM AS BU_DISPLAYNAME,\nA.HIERARCHY_ID AS PARENTID,\nA.HIERARCHY_ID,\nA.HIERARCHY_NM\n\nFROM (\nSELECT DISTINCT D.HIERARCHY_ID,D.HIERARCHY_NM\nFROM jpmcbu.bu_pch D\nWHERE D.HIERARCHY_ID in ('5','13','16')\n) A"
}
},
"COLUMNS": {"COLUMN": [{"UPDATED_NAME": "BU_entityID",
"DATABASE_TIMEZONE": "",
"PIGDATATYPE": 1,
"HIDDEN": false,
"FIELDDATAFORMATTYPE": "1",
"PRECISION": "",
"NAME": "BU_entityID",
"ROLE": "",
"FIELDFORMAT": {"USEDEFAULT": "",
"content": 0
},
"DATATYPENAME": "CHAR",
"LOCALE": "",
"ORIGINAL_NAME": "BU_entityID",
"FULLY_QUALIFIED_NAME": "",
"ORIGINAL_QUALIFIED_NAME": "",
"SORT_ORDER": "",
"DATASUBTYPENAME": "",
"SCALE": "",
"ORIGINAL_DATATYPENAME": 12,
"SORT_TYPE": ""
},
{"UPDATED_NAME": "BUSINESS_UNIT_ID",
"DATABASE_TIMEZONE": "",
"PIGDATATYPE": 1,
"HIDDEN": false,
"FIELDDATAFORMATTYPE": "1",
"PRECISION": "",
"NAME": "BUSINESS_UNIT_ID",
"ROLE": "",
"FIELDFORMAT": {"USEDEFAULT": "",
"content": 0
},
"DATATYPENAME": "CHAR",
"LOCALE": "",
"ORIGINAL_NAME": "BUSINESS_UNIT_ID",
"FULLY_QUALIFIED_NAME": "",
"ORIGINAL_QUALIFIED_NAME": "",
"SORT_ORDER": "",
"DATASUBTYPENAME": "",
"SCALE": "",
"ORIGINAL_DATATYPENAME": 12,
"SORT_TYPE": ""
},
{"UPDATED_NAME": "NM_LONG",
"DATABASE_TIMEZONE": "",
"PIGDATATYPE": 1,
"HIDDEN": false,
"FIELDDATAFORMATTYPE": "1",
"PRECISION": "",
"NAME": "NM_LONG",
"ROLE": "",
"FIELDFORMAT": {"USEDEFAULT": "",
"content": 0
},
"DATATYPENAME": "CHAR",
"LOCALE": "",
"ORIGINAL_NAME": "NM_LONG",
"FULLY_QUALIFIED_NAME": "",
"ORIGINAL_QUALIFIED_NAME": "",
"SORT_ORDER": "",
"DATASUBTYPENAME": "",
"SCALE": "",
"ORIGINAL_DATATYPENAME": 12,
"SORT_TYPE": ""
},
{"UPDATED_NAME": "BU_DISPLAYNAME",
"DATABASE_TIMEZONE": "",
"PIGDATATYPE": 1,
"HIDDEN": false,
"FIELDDATAFORMATTYPE": "1",
"PRECISION": "",
"NAME": "BU_DISPLAYNAME",
"ROLE": "",
"FIELDFORMAT": {"USEDEFAULT": "",
"content": 0
},
"DATATYPENAME": "CHAR",
"LOCALE": "",
"ORIGINAL_NAME": "BU_DISPLAYNAME",
"FULLY_QUALIFIED_NAME": "",
"ORIGINAL_QUALIFIED_NAME": "",
"SORT_ORDER": "",
"DATASUBTYPENAME": "",
"SCALE": "",
"ORIGINAL_DATATYPENAME": 12,
"SORT_TYPE": ""
},
{"UPDATED_NAME": "PARENTID",
"DATABASE_TIMEZONE": "",
"PIGDATATYPE": 1,
"HIDDEN": false,
"FIELDDATAFORMATTYPE": "1",
"PRECISION": "",
"NAME": "PARENTID",
"ROLE": "",
"FIELDFORMAT": {"USEDEFAULT": "",
"content": 0
},
"DATATYPENAME": "CHAR",
"LOCALE": "",
"ORIGINAL_NAME": "PARENTID",
"FULLY_QUALIFIED_NAME": "",
"ORIGINAL_QUALIFIED_NAME": "",
"SORT_ORDER": "",
"DATASUBTYPENAME": "",
"SCALE": "",
"ORIGINAL_DATATYPENAME": 12,
"SORT_TYPE": ""
},
{"UPDATED_NAME": "HIERARCHY_ID",
"DATABASE_TIMEZONE": "",
"PIGDATATYPE": -5,
"HIDDEN": false,
"FIELDDATAFORMATTYPE": "2",
"PRECISION": "",
"NAME": "HIERARCHY_ID",
"ROLE": "",
"FIELDFORMAT": {"USEDEFAULT": "",
"content": 0
},
"DATATYPENAME": "NUMBER",
"LOCALE": "",
"ORIGINAL_NAME": "HIERARCHY_ID",
"FULLY_QUALIFIED_NAME": "",
"ORIGINAL_QUALIFIED_NAME": "",
"SORT_ORDER": "",
"DATASUBTYPENAME": "long",
"SCALE": "",
"ORIGINAL_DATATYPENAME": 12,
"SORT_TYPE": ""
},
{"UPDATED_NAME": "HIERARCHY_NM",
"DATABASE_TIMEZONE": "",
"PIGDATATYPE": 1,
"HIDDEN": false,
"FIELDDATAFORMATTYPE": "1",
"PRECISION": "",
"NAME": "HIERARCHY_NM",
"ROLE": "",
"FIELDFORMAT": {"USEDEFAULT": "",
"content": 0
},
"DATATYPENAME": "CHAR",
"LOCALE": "",
"ORIGINAL_NAME": "HIERARCHY_NM",
"FULLY_QUALIFIED_NAME": "",
"ORIGINAL_QUALIFIED_NAME": "",
"SORT_ORDER": "",
"DATASUBTYPENAME": "",
"SCALE": "",
"ORIGINAL_DATATYPENAME": 12,
"SORT_TYPE": ""
}
]
}
}
},
"LEFT": 0,
"TOP": 0,
"OUTPUT_STEPS": "",
"ID": "16315295695318981713",
"INPUT_STEPS": "",
"TYPE": "FETCH",
"NAME": "Fetch"
}
}
},
"CONN_TYPE": "DEFAULT",
"CACHED": true,
"CONN_NAME": "DefaultHadoopCluster01"
}
},
"REPOSITDATE": "06/08/2022 12:27:29",
"ISPUBLIC": true,
"COMMON": {"DESC": ""
},
"LINKED_ENTITY_ID": "",
"ID": "16315295692604127043024119188204",
"OWNERAPPNAME": "-",
"TYPE": "QUERY"
}
}

Update Registered File Deprecated

This API is used to update an existing Registered File.

Note: This API has been deprecated. Please refer alternate API /rdatasets/{nameOrId}.

Authorizations:

sessionIdbasicAuth

path Parameters

nameOrId

required

string

Name or Id of Registered File. Firstly, parameter nameOrId will be treated as Id. In case no Registered File is found with that Id, then it will search for a Registered File by taking nameOrId as Name. In case of nameOrId as Name, folderNameOrId is used

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

registerFileXML

required

string

XML of a RegisterFile Object. This xml can be generated with the help of com.kyvos.client.reportobjects.wrappers.RegisteredFile class.
For e.g.

 <IRO ID="16612546785471127089091117761211" NAME="Untitled File 1" TYPE="QUERY" SUBTYPE="REGISTERED" FOLDER_ID="folder_16282337673341127087061149752657" ISPUBLIC="true" FOLDER_NAME="1JPMC_DRR">
      <COMMON>
        <DESC>
          <![CDATA[]]>
        </DESC>
      </COMMON>
      <SPECIFIC>
        <FILTERS>
          <FILTER NAME="COPY_ACCESS_RIGHTS" OPERATOR="=">
            <VALUE>
              <![CDATA[1]]>
            </VALUE>
          </FILTER>
          <FILTER NAME="SRC_ENTITY_ID" OPERATOR="=">
            <VALUE>
              <![CDATA[]]>
            </VALUE>
          </FILTER>
        </FILTERS>
        <QO CACHED="true" CONN_NAME="DefaultHadoopCluster01" ROLE="DIMENSION" CONN_TYPE="HADOOP_CLUSTER">
          <TRANSFORMATION>
            <LAYOUT HSCROLLVALUE="0" VSCROLLVALUE="0" STEPS_PANEL_WIDTH="" TRANSFORMATION_PANEL_HEIGHT="" SELECTED_STEP_ID=""/>
            <STEPS>
              <STEP ID="16612546785471127089091117761273" NAME="Fetch" TYPE="FETCH" LEFT="0" TOP="0">
                <INPUT_STEPS>
                <OUTPUT_STEPS>
                <STEP_INFO>
                  <FETCH_INFO>
                    <FETCH CONN_NAME="DefaultHadoopCluster01" CONN_TYPE="PARENT" LOOKUP_ENABLED="false" IS_SORTED="false" SOURCE="SEQ" INPUT_TYPE="">
                      <SPARK_JDBC_DATA_PARTITION_COLUMN>
                        <COLUMN_NAME>
                          <![CDATA[]]>
                        </COLUMN_NAME>
                        <TABLE_NAME>
                          <![CDATA[]]>
                        </TABLE_NAME>
                        <METADATA_MODE>
                          <![CDATA[DEFAULT]]>
                        </METADATA_MODE>
                        <NUMBER_OF_PARTITIONS>
                          <![CDATA[]]>
                        </NUMBER_OF_PARTITIONS>
                        <MIN_VALUE>
                          <![CDATA[]]>
                        </MIN_VALUE>
                        <MAX_VALUE>
                          <![CDATA[]]>
                        </MAX_VALUE>
                        <NUMBER_OF_RECORDS>
                          <![CDATA[]]>
                        </NUMBER_OF_RECORDS>
                      </SPARK_JDBC_DATA_PARTITION_COLUMN>
                      <SEQSOURCE>
                        <PATH>
                          <![CDATA[ranger/audit/hdfs/hdfs/20210716/hdfs_ranger_audit_intelli-i0051.kyvostest.com.log]]>
                        </PATH>
                        <FILE_TYPE>
                          <![CDATA[SEQ]]>
                        </FILE_TYPE>
                        <ENTITY_TYPE>
                          <![CDATA[FILE]]>
                        </ENTITY_TYPE>
                        <RECORD_SEPARATOR>
                          <![CDATA[]]>
                        </RECORD_SEPARATOR>
                        <SEPARATOR>
                          <![CDATA[SOH]]>
                        </SEPARATOR>
                        <ENCLOSURE>
                          <![CDATA["]]>
                        </ENCLOSURE>
                        <ESCAPECHAR>
                          <![CDATA[]]>
                        </ESCAPECHAR>
                        <HEADER>
                          <![CDATA[false]]>
                        </HEADER>
                        <IGNORE_EMPTY_ROWS>
                          <![CDATA[true]]>
                        </IGNORE_EMPTY_ROWS>
                        <ENCODING>
                          <![CDATA[ASCII]]>
                        </ENCODING>
                        <COMPRESSION>
                          <![CDATA[NONE]]>
                        </COMPRESSION>
                        <REQUEST_METHOD>
                          <![CDATA[GET]]>
                        </REQUEST_METHOD>
                        <KEY_AS_COLUMN>
                          <![CDATA[true]]>
                        </KEY_AS_COLUMN>
                        <NAME_AS_COLUMN>
                          <![CDATA[false]]>
                        </NAME_AS_COLUMN>
                        <SKIP_LINES TOP = "0" BOTTOM = "0" />
                        <DATE_FORMAT>
                          <![CDATA[null]]>
                        </DATE_FORMAT>
                      </SEQSOURCE>
                    </FETCH>
                    <COLUMNS></COLUMNS>
                  </FETCH_INFO>
                </STEP_INFO>
              </STEP>
            </STEPS>
          </TRANSFORMATION>
        </QO>
      </SPECIFIC>
    </IRO>

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully updated register file: Untitled File 1",
"CODE": 0
}

Delete Registered File Deprecated

This API is used to delete an existing Registered File.

Note: This API has been deprecated. Please refer alternate API /rdatasets/{nameOrId}.

Authorizations:

sessionIdbasicAuth

path Parameters

nameOrId

required

string

Name or Id of RegisterFile Object. The response will contain RegisterFile’s XML. Firstly, parameter nameOrId will be treated as Id. In case no Registered File is found with that Id, then it will search for a Registered File by taking nameOrId as Name. In case of nameOrId as Name, folderNameOrId is used

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.
folderName	string Name of a folder from which you want to get a Registered file.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully deleted register file: RestApiTest",
"CODE": 0
}

Create Fetch Step Deprecated

This API is used to create a Fetch step for Registered File.

Note: This API has been deprecated. Please refer alternate API /rdatasets/createFetchStep.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

Note: Use either csvResultsetXML or registerFileXML. If both are provided, registerFileXML will be used as csvResultsetXML is deprecated and not required.

csvResultsetXML

string

Deprecated

XML of a FetchStep Object. This XML can be generated with the help of com.kyvos.commons.entity.reportobjects.datasource.CSVSource class.

registerFileXML

string

XML of a RegisterFile Object. This xml can be generated with the help of com.kyvos.client.reportobjects.wrappers.RegisteredFile class.
For e.g.

 <IRO ID="16612546785471127089091117761211" NAME="Untitled File 1" TYPE="QUERY" SUBTYPE="REGISTERED" FOLDER_ID="folder_16282337673341127087061149752657" ISPUBLIC="true" FOLDER_NAME="1JPMC_DRR">
      <COMMON>
        <DESC>
          <![CDATA[]]>
        </DESC>
      </COMMON>
      <SPECIFIC>
        <FILTERS>
          <FILTER NAME="COPY_ACCESS_RIGHTS" OPERATOR="=">
            <VALUE>
              <![CDATA[1]]>
            </VALUE>
          </FILTER>
          <FILTER NAME="SRC_ENTITY_ID" OPERATOR="=">
            <VALUE>
              <![CDATA[]]>
            </VALUE>
          </FILTER>
        </FILTERS>
        <QO CACHED="true" CONN_NAME="DefaultHadoopCluster01" ROLE="DIMENSION" CONN_TYPE="HADOOP_CLUSTER">
          <TRANSFORMATION>
            <LAYOUT HSCROLLVALUE="0" VSCROLLVALUE="0" STEPS_PANEL_WIDTH="" TRANSFORMATION_PANEL_HEIGHT="" SELECTED_STEP_ID=""/>
            <STEPS>
              <STEP ID="16612546785471127089091117761273" NAME="Fetch" TYPE="FETCH" LEFT="0" TOP="0">
                <INPUT_STEPS>
                <OUTPUT_STEPS>
                <STEP_INFO>
                  <FETCH_INFO>
                    <FETCH CONN_NAME="DefaultHadoopCluster01" CONN_TYPE="PARENT" LOOKUP_ENABLED="false" IS_SORTED="false" SOURCE="SEQ" INPUT_TYPE="">
                      <SPARK_JDBC_DATA_PARTITION_COLUMN>
                        <COLUMN_NAME>
                          <![CDATA[]]>
                        </COLUMN_NAME>
                        <TABLE_NAME>
                          <![CDATA[]]>
                        </TABLE_NAME>
                        <METADATA_MODE>
                          <![CDATA[DEFAULT]]>
                        </METADATA_MODE>
                        <NUMBER_OF_PARTITIONS>
                          <![CDATA[]]>
                        </NUMBER_OF_PARTITIONS>
                        <MIN_VALUE>
                          <![CDATA[]]>
                        </MIN_VALUE>
                        <MAX_VALUE>
                          <![CDATA[]]>
                        </MAX_VALUE>
                        <NUMBER_OF_RECORDS>
                          <![CDATA[]]>
                        </NUMBER_OF_RECORDS>
                      </SPARK_JDBC_DATA_PARTITION_COLUMN>
                      <SEQSOURCE>
                        <PATH>
                          <![CDATA[ranger/audit/hdfs/hdfs/20210716/hdfs_ranger_audit_intelli-i0051.kyvostest.com.log]]>
                        </PATH>
                        <FILE_TYPE>
                          <![CDATA[SEQ]]>
                        </FILE_TYPE>
                        <ENTITY_TYPE>
                          <![CDATA[FILE]]>
                        </ENTITY_TYPE>
                        <RECORD_SEPARATOR>
                          <![CDATA[]]>
                        </RECORD_SEPARATOR>
                        <SEPARATOR>
                          <![CDATA[SOH]]>
                        </SEPARATOR>
                        <ENCLOSURE>
                          <![CDATA["]]>
                        </ENCLOSURE>
                        <ESCAPECHAR>
                          <![CDATA[]]>
                        </ESCAPECHAR>
                        <HEADER>
                          <![CDATA[false]]>
                        </HEADER>
                        <IGNORE_EMPTY_ROWS>
                          <![CDATA[true]]>
                        </IGNORE_EMPTY_ROWS>
                        <ENCODING>
                          <![CDATA[ASCII]]>
                        </ENCODING>
                        <COMPRESSION>
                          <![CDATA[NONE]]>
                        </COMPRESSION>
                        <REQUEST_METHOD>
                          <![CDATA[GET]]>
                        </REQUEST_METHOD>
                        <KEY_AS_COLUMN>
                          <![CDATA[true]]>
                        </KEY_AS_COLUMN>
                        <NAME_AS_COLUMN>
                          <![CDATA[false]]>
                        </NAME_AS_COLUMN>
                        <SKIP_LINES TOP = "0" BOTTOM = "0" />
                        <DATE_FORMAT>
                          <![CDATA[null]]>
                        </DATE_FORMAT>
                      </SEQSOURCE>
                    </FETCH>
                    <COLUMNS></COLUMNS>
                  </FETCH_INFO>
                </STEP_INFO>
              </STEP>
            </STEPS>
          </TRANSFORMATION>
        </QO>
      </SPECIFIC>
    </IRO>

Responses

Response samples

200

Content type

application/json

{"FETCH_INFO": {"FETCH": {"SOURCE_SUB_TYPE": "",
"CONN_TYPE": "PARENT",
"LOOKUP_ENABLED": false,
"IS_SORTED": false,
"SOURCE": "",
"CONN_NAME": "",
"SPARK_JDBC_DATA_PARTITION_COLUMN": {"TABLE_NAME": "",
"NUMBER_OF_PARTITIONS": "",
"NUMBER_OF_RECORDS": "",
"COLUMN_NAME": "",
"METADATA_MODE": "DEFAULT",
"MAX_VALUE": "",
"MIN_VALUE": ""
}
},
"COLUMNS": ""
}
}

Save Registered File Deprecated

This API is used to add/update file entity with given entity XML. As this API performs bulk operation, you must have privileges to import and export objects to use this API.

Note: This API has been deprecated. Please refer alternate API /rdatasets/saveDataset.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

fileXML

required

object

XML of a RegisterFile Object. This xml can be generated with the help of com.kyvos.client.reportobjects.wrappers.RegisteredFile class.
For e.g.

 <IROS><IRO ID="16612546785471127089091117761211" NAME="Untitled File 1" TYPE="QUERY" SUBTYPE="REGISTERED" FOLDER_ID="folder_16282337673341127087061149752657" ISPUBLIC="true" FOLDER_NAME="1JPMC_DRR">
      <COMMON>
        <DESC>
          <![CDATA[]]>
        </DESC>
      </COMMON>
      <SPECIFIC>
        <FILTERS>
          <FILTER NAME="COPY_ACCESS_RIGHTS" OPERATOR="=">
            <VALUE>
              <![CDATA[1]]>
            </VALUE>
          </FILTER>
          <FILTER NAME="SRC_ENTITY_ID" OPERATOR="=">
            <VALUE>
              <![CDATA[]]>
            </VALUE>
          </FILTER>
        </FILTERS>
        <QO CACHED="true" CONN_NAME="DefaultHadoopCluster01" ROLE="DIMENSION" CONN_TYPE="HADOOP_CLUSTER">
          <TRANSFORMATION>
            <LAYOUT HSCROLLVALUE="0" VSCROLLVALUE="0" STEPS_PANEL_WIDTH="" TRANSFORMATION_PANEL_HEIGHT="" SELECTED_STEP_ID=""/>
            <STEPS>
              <STEP ID="16612546785471127089091117761273" NAME="Fetch" TYPE="FETCH" LEFT="0" TOP="0">
                <INPUT_STEPS>
                <OUTPUT_STEPS>
                <STEP_INFO>
                  <FETCH_INFO>
                    <FETCH CONN_NAME="DefaultHadoopCluster01" CONN_TYPE="PARENT" LOOKUP_ENABLED="false" IS_SORTED="false" SOURCE="SEQ" INPUT_TYPE="">
                      <SPARK_JDBC_DATA_PARTITION_COLUMN>
                        <COLUMN_NAME>
                          <![CDATA[]]>
                        </COLUMN_NAME>
                        <TABLE_NAME>
                          <![CDATA[]]>
                        </TABLE_NAME>
                        <METADATA_MODE>
                          <![CDATA[DEFAULT]]>
                        </METADATA_MODE>
                        <NUMBER_OF_PARTITIONS>
                          <![CDATA[]]>
                        </NUMBER_OF_PARTITIONS>
                        <MIN_VALUE>
                          <![CDATA[]]>
                        </MIN_VALUE>
                        <MAX_VALUE>
                          <![CDATA[]]>
                        </MAX_VALUE>
                        <NUMBER_OF_RECORDS>
                          <![CDATA[]]>
                        </NUMBER_OF_RECORDS>
                      </SPARK_JDBC_DATA_PARTITION_COLUMN>
                      <SEQSOURCE>
                        <PATH>
                          <![CDATA[ranger/audit/hdfs/hdfs/20210716/hdfs_ranger_audit_intelli-i0051.kyvostest.com.log]]>
                        </PATH>
                        <FILE_TYPE>
                          <![CDATA[SEQ]]>
                        </FILE_TYPE>
                        <ENTITY_TYPE>
                          <![CDATA[FILE]]>
                        </ENTITY_TYPE>
                        <RECORD_SEPARATOR>
                          <![CDATA[]]>
                        </RECORD_SEPARATOR>
                        <SEPARATOR>
                          <![CDATA[SOH]]>
                        </SEPARATOR>
                        <ENCLOSURE>
                          <![CDATA["]]>
                        </ENCLOSURE>
                        <ESCAPECHAR>
                          <![CDATA[]]>
                        </ESCAPECHAR>
                        <HEADER>
                          <![CDATA[false]]>
                        </HEADER>
                        <IGNORE_EMPTY_ROWS>
                          <![CDATA[true]]>
                        </IGNORE_EMPTY_ROWS>
                        <ENCODING>
                          <![CDATA[ASCII]]>
                        </ENCODING>
                        <COMPRESSION>
                          <![CDATA[NONE]]>
                        </COMPRESSION>
                        <REQUEST_METHOD>
                          <![CDATA[GET]]>
                        </REQUEST_METHOD>
                        <KEY_AS_COLUMN>
                          <![CDATA[true]]>
                        </KEY_AS_COLUMN>
                        <NAME_AS_COLUMN>
                          <![CDATA[false]]>
                        </NAME_AS_COLUMN>
                        <SKIP_LINES TOP = "0" BOTTOM = "0" />
                        <DATE_FORMAT>
                          <![CDATA[null]]>
                        </DATE_FORMAT>
                      </SEQSOURCE>
                    </FETCH>
                    <COLUMNS></COLUMNS>
                  </FETCH_INFO>
                </STEP_INFO>
              </STEP>
            </STEPS>
          </TRANSFORMATION>
        </QO>
      </SPECIFIC>
    </IRO>
  </IROS>

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"RES": [{"MESSAGE": "Successfully added register file: RestFile1",
"CODE": 0
},
{"MESSAGE": "Successfully added register file: RestFile2",
"CODE": 0
}
]
}
}

Get File Advanced Properties Deprecated

This API is used to get Registered File Advanced Properties.

Note: This API has been deprecated. Please refer alternate API /rdatasets/properties.

Authorizations:

sessionIdbasicAuth

query Parameters

folderId required	string Id of the folder from which you want to get registered file.
folderName	string Name of a folder from which you want to get Registered File. If the field is present on the root directory, give folder name as [Root].
fileId required	string Id of registered file.
fileName	string Name of the registered file.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"PROPERTIES": ""
}
}

Update properties of Register File Deprecated

This API is used to update one or more properties of the register file. For example DESCRIPTION property, TAGS property etc.
Note - User should provide either "registerFileId" or "registerFileName" and "folderName" details.

Note: This API has been deprecated. Please refer alternate API /rdatasets/entityProperties.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

registerFileId	string Id of the register file for which you want to update properties. If you do not know the register file id, use the register file name and folder name.
registerFileName	string Name of the register file for which you want to update properties.
folderName	string Folder name of the register file for which you want to update properties.
propertyJSON required	object JSON containing an array of property name and their values. For e.g. [ { "name": "DESCRIPTION", "value": "description" }, { "name": "TAGS" "value": "tag" } ]

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully updated properties of the register file.",
"CODE": 0
}

Get File Job Execution Status Deprecated

This API is used to get job execution status for the register file.

Note: This API has been deprecated. Please refer alternate API /rdatasets/jobExecutionStatus.

Authorizations:

sessionIdbasicAuth

query Parameters

folderId	string Id of the folder from which you want to get registered file.
folderName	string Name of a folder from which you want to get Registered File. If the field is present on the root directory, give folder name as [Root].
fileId required	string Id of registered file.
fileName	string Name of the registered file.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"DATA": {"INQUEUEJOBS": "",
"JOBEXECUTIONSTATUS": {"UPCOMINGJOBS": "",
"HISTORY": {"HISTORYITEM": {"HISTORY_ID": "7897EF85-9600-9943-2FA5-A3E2D9EB058C",
"IS_IDEAL_BUILD": false,
"STATUS": "SUCCESSFUL",
"FREQUENCY_TYPE": "ONCE",
"SCHEDULED_TIME": "05/04/2022 11:39:10",
"RUNTIME": "05/04/2022 11:40:12",
"BUILD_TYPE": "DATA_PROFILE",
"USER_NAME": "RestAPIUser 2"
}
}
}
}
}

Get File Last Job Summary Deprecated

This API is used to get the last job summary of the registered file.

Note: This API has been deprecated. Please refer alternate API /rdatasets/lastJobSummary.

Authorizations:

sessionIdbasicAuth

query Parameters

folderId	string Id of the folder from which you want to get registered file.
folderName	string Name of a folder from which you want to get Registered File. If the field is present on the root directory, give folder name as [Root].
fileId required	string Id of registered file.
fileName	string Name of the registered file.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"ALL_BUILD_STATUS": {"BUILD_STATUS": {"BUILD_NO": 1,
"HISTORY_ID": "7897EF85-9600-9943-2FA5-A3E2D9EB058C",
"STATUS": "COMPLETED",
"BUILD_TYPE": "DATA_PROFILE",
"CURRENT_BUILD_STATUS": {"COMPLETED": {"SIZE": "0.00 B",
"TIMESTAMP": "05/04/2022 11:40:12",
"SECTIONS": {"SECTION": {"MESSAGES": {"MESSAGE": {"TYPE": "INFO",
"content": "Record Count: <B>Not able to fetch record count for ORC/Parquet</B>"
}
},
"TYPE": "DETAILS"
}
},
"TOTAL_TIME": 0,
"ELAPSED_TIME": 0,
"RECORD_COUNT": "Not able to fetch record count for ORC/Parquet"
}
},
"SUB_TYPE": "REGISTERED",
"TYPE": "QUERY",
"INSTANCE_ID": 0
}
}
}

Execute Data Profile Job on Registered File Deprecated

This API is used to execute data profile job on Registered File.

Note: This API has been deprecated. Please refer alternate API /rdatasets/dataProfile.

Authorizations:

sessionIdbasicAuth

query Parameters

folderId required	string Id of the folder from which you want to get registered file.
folderName	string Name of a folder from which you want to get Registered File. If the field is present on the root directory, give folder name as [Root].
fileId required	string Id of registered file.
fileName	string Name of the registered file.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

runType	string Default: "NOW" Enum: "NOW" "ONCE" Job frequency to run (NOW/ONCE) Default Value: NOW Now: This will immediately start the job Once: Job will run at the specified time
onceDateTime	string Date time in format (09/20/2014 17:25) Required when runType is ONCE
userParams	string The parameters info which is to be used in file data profiling. Value in JSON should be passed. Example: [ { "name": "parameterName", "value": "parameterValue" } ]
buildConnectionName	string Name of build Connection
dataProfileJson	object Data profile settings in string formatted JSON object. { "samplingOptions": "SAMPLE/ALL", "fieldsGroup": "COMPLETE/CUSTOM", "fields": [ { "fieldId": "id of element", "displayName": "name of element" } ] }

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Data profile job added successfully.",
"CODE": 0
}

Update Parameters in Registered File Deprecated

This API is used to update parameters in Registered File.

Note: This API has been deprecated. Please refer alternate API /rdatasets/addUpdateUserParams.

Authorizations:

sessionIdbasicAuth

query Parameters

folderId required	string Id of the folder from which you want to get registered file.
folderName	string Name of a folder from which you want to get Registered File. If the field is present on the root directory, give folder name as [Root].
fileId required	string Id of registered file.
fileName	string Name of the registered file.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

userParameters required	string Parameters information that needs to be updated in the file Object. Value should be passed in JSON format. Example: [ { "name": "Parameter 1", "value": "value 1" }, { "name": "Parameter 2", "value": "value 2" } ]
action	string To replace/merge parameters info in the file Object.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully replaced register file: Bu_D1",
"CODE": 0
}

Update Filter Deprecated

This API is used to update the filter values for RF's filter step.

Note: This API has been deprecated. Please refer alternate API /rdatasets/updateFilter.

Authorizations:

sessionIdbasicAuth

query Parameters

folderId	string Id of the folder from which you want to get registered file.
folderName	string Name of a folder from which you want to get Registered File. If the field is present on the root directory, give folder name as [Root].
fileId	string Id of registered file.
fileName	string Name of the registered file.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

columnName	string Pass the column on which filter to apply
value	string Pass the value of the column
secondValue	string This is optional parameter which required in special case like between, in function

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully replaced register file: RestApiTest",
"CODE": 0
}

Copy Register File Deprecated

This API is used to copy the register in the desired destination folder.
Note - User should provide either "sourceRegisterFileId" or "sourceRegisterFileName" and "sourceFolderName" details.

Note: This API has been deprecated. Please refer alternate API /rdatasets/copy.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

sourceRegisterFileId	string Id of the register file for which you want to create a copy. If you do not know the register file id, use the register file name and folder name.
sourceRegisterFileName	string Name of the register file for which you want to create a copy.
sourceFolderName	string Folder name of the register file for which you want to create a copy.
targetRegisterFileName required	string Name of the target register file that you want to create.
targetFolderId	string Target folder id where you want to create the copy.
targetFolderName	string Target folder name where you want to create the copy.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Register file copied successfully.",
"CODE": 0
}

Validate Registered File Deprecated

This API is used to validate registered file design.

Note: This API has been deprecated. Please refer alternate API /rdatasets/validae.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

fileId	string Id of the RegisteredFile which you wants to get validated. If you do not know fileId, use fileName and folderName.
fileName	string Name of the file which you wants to get validated.
folderName	string Name of the folder from which you want to validate file.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "File validated successfully",
"CODE": 200,
"VALIDATION_STATUS": "VALID"
}

Cubes

Get Cubes Deprecated

This API is used to get a list of the cubes along with the corresponding folders.

Note: This API has been deprecated. Please refer alternate API /smodels.

Authorizations:

sessionIdbasicAuth

query Parameters

fetchBuildStatus	string Enum: true false Example: fetchBuildStatus=false
show	string Enum: "all" "folders" "list" Example: show=all This parameter is used to control the objects returned in the response. the response can have a list of only folders, a list of only entities, or both, based on other filters applied. The default value is 'all' all: Response list contains a combined list of folders and entities. list: Response list shows only the entity list. folders: Response list shows only the folders list.
OWNER	string This parameter filters entities by owner (the user who created that entity) name.
TAGS	string This parameter filters the entities by tags.
SEARCH_TEXT	string This parameter filters the entities by their names. All entities whose name contains the searched text are included in the result, irrespective of the case format.
MODIFIED_AFTER	string This parameter filters the entities by their last modified timestamp. All the entities modified after the provided timestamp are included in the result.
MODIFIED_BEFORE	string This parameter filters the entities by their last modified timestamp. All the entities modified before the provided timestamp are included in the result.
COUNT	number This parameter sets the number of the records displayed in the response. It is applicable only for show=list or show=folders but not with show=all.
LAST_ENTITY_NAME	string When this parameter is used, the response shows only the entities occurring after the entity name specified in this parameter. The list ignores all the entities before that.
LAST_ENTITY_ID	string When this parameter is used, the response shows only the entities occurring after the entity ID specified in this parameter. The list ignores all the entities before that.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"CUBES": {"CUBE": [{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594136670,
"LAST_MODIFIED": "11/16/2022 15:52:16",
"id": "15336348064443127075025127247531",
"NAME": "History Audit cube"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594136964,
"LAST_MODIFIED": "11/16/2022 15:52:16",
"id": "CUBE_OBJECT_15337271008344127081028174162622",
"NAME": "Querying Audit"
},
{"ACCESSRIGHTS": 1,
"OWNER": "anshul.sharma",
"OWNERID": 253292788,
"LAST_MODIFIED_TIMESTAMP": 1669563712115,
"LAST_MODIFIED": "11/27/2022 21:11:52",
"id": "CUBE_OBJECT_16695639511453127095042179066816",
"NAME": "Untitled Cube"
}
]
}
}
}

Create Cube Deprecated

This API is used to create a new Cube Object.

Note: This API has been deprecated. Please refer alternate API /smodels.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

cubeXML

required

object

XML of a cube object. This XML can be generated with the help of com.kyvos.commons.entity.reportobjects.CubeObject class.
For e.g.

  <IRO ID="15452933458461127071083153170947" NAME="Historical Field Details" TYPE="ANALYTICAL" SUBTYPE="CUBE" FOLDER_ID="folder_15396014106428127088047133277741" FOLDER_NAME="Query Analyzer" ISPUBLIC="">
  <COMMON>
    <DESC>
      <![CDATA[]]>
    </DESC>
    <COMPATIBILITY_VERSION>
      <![CDATA[1]]>
    </COMPATIBILITY_VERSION>
  </COMMON>
  <SPECIFIC>
    <ATTRS>
      <ATTR NAME="CUBEUNIQUENAME">
        <VALUE>
          <![CDATA[15452933458461127071083153170947]]>
        </VALUE>
      </ATTR>
    </ATTRS>
    <CUBEOBJECT>
      <LAYOUT_PROPERTY>
        <PANEL_DETAILS>
          <![CDATA[{"filters":{"style":{"height":-5},"id":"filters"},"properties":{"style":{"height":94},"id":"properties"},"sourceFields":{"id":"sourceFields","style":{"height":89}}}]]>
        </PANEL_DETAILS>
        <COLUMN_DETAILS>
          <![CDATA[[{"style":{},"panels":["sourceFields"]},{"index":0,"style":{"width":293.326},"panels":[]},{"index":1,"style":{}}]]]>
        </COLUMN_DETAILS>
      </LAYOUT_PROPERTY>
      <SLIDING_WINDOWS>
      <AGGREGATION_STRATEGY TYPE="CONFIGURATION_DRIVEN" >
        <CONFIGURATION_DRIVEN>
          <ENTITY_PROPS_VALUES>
            <PROPERTY>
              <NAME>
                <![CDATA[kyvos.build.precompute.level.threshold]]>
              </NAME>
              <VALUE>
                <![CDATA[]]>
              </VALUE>
              <MODE>
                <![CDATA[DEFAULT]]>
              </MODE>
            </PROPERTY>
            <PROPERTY>
              <NAME>
                <![CDATA[kyvos.build.dimensions.materialize]]>
              </NAME>
              <VALUE>
                <![CDATA[]]>
              </VALUE>
              <MODE>
                <![CDATA[DEFAULT]]>
              </MODE>
            </PROPERTY>
            <PROPERTY>
              <NAME>
                <![CDATA[kyvos.build.precompute.degree]]>
              </NAME>
              <VALUE>
                <![CDATA[]]>
              </VALUE>
              <MODE>
                <![CDATA[DEFAULT]]>
              </MODE>
            </PROPERTY>
            <PROPERTY>
              <NAME>
                <![CDATA[kyvos.build.precompute.hierarchy.levels]]>
              </NAME>
              <VALUE>
                <![CDATA[]]>
              </VALUE>
              <MODE>
                <![CDATA[DEFAULT]]>
              </MODE>
            </PROPERTY>
          </ENTITY_PROPS_VALUES>
        </CONFIGURATION_DRIVEN>
      </AGGREGATION_STRATEGY>
      <DIMENSIONS>
        <DIMENSION ID="Dim_Measures" RESTRICT="false" RESTRICTVALUES="false">
          <NAME>
            <![CDATA[Measures]]>
          </NAME>
          <UNIQUENAME>
            <![CDATA[Measures]]>
          </UNIQUENAME>
          <TYPE>
            <![CDATA[MEASURE]]>
          </TYPE>
          <DEFAULTHIERARCHYUNIQUENAME>
            <![CDATA[Measures]]>
          </DEFAULTHIERARCHYUNIQUENAME>
          <HIERARCHIES>
            <HIERARCHY HASALL="false">
              <UNIQUENAME>
                <![CDATA[Measures]]>
              </UNIQUENAME>
              <ALLMEMBERUNIQUENAME />/n
              <LEVELS>
                <LEVEL DATATYPE="Regular">
                  <UNIQUENAME>
                    <![CDATA[MeasuresLevel]]>
                  </UNIQUENAME>
                  <DATAFIELD />
                  <PROPERTIES />
                </LEVEL>
              </LEVELS>
            </HIERARCHY>
          </HIERARCHIES>
          <ATTRS>
            <ATTR DATATYPE="">
              <UNIQUENAME>
                <![CDATA[Attribute]]>
              </UNIQUENAME>
              <NAME>
                <![CDATA[Attribute]]>
              </NAME>
              <DATAFIELD />
            </ATTR>
          </ATTRS>
        </DIMENSION>
      </DIMENSIONS>
      <MEASURE_GROUPS>
        <MEASURE_GROUP NAME="Measure Group" ISVISIBLE="true" MATERIALIZE="">
          <DESCRIPTION>
            <![CDATA[]]>
          </DESCRIPTION>
          <MEASURE_ID>
            <![CDATA[MEASURE_34820]]>
          </MEASURE_ID>
        </MEASURE_GROUP>
      </MEASURE_GROUPS>
      <MEASURES>
        <MEASURE ID="MEASURE_34820" DATATYPE="NUMBER" ISDEFAULT="true" ISVISIBLE="true" SOLVE_ORDER="0" DISPLAY_FOLDER="" MATERIALIZE="">
          <UNIQUENAME>
            <![CDATA[MEASURE_34820]]>
          </UNIQUENAME>
          <NAME>
            <![CDATA[Query Count]]>
          </NAME>
          <FORMAT USEDEFAULT="0">
            <![CDATA[#,##0]]>
          </FORMAT>
          <FORMATTYPE>
            <![CDATA[2]]>
          </FORMATTYPE>
          <UNIT>
            <![CDATA[]]>
          </UNIT>
          <DATAFIELD QUERY_NAME="field_details" QUERY_ID="15451326173844127065091156882788_0">
            <![CDATA[field_used_count]]>
          </DATAFIELD>
          <EXPRESSION NON_EMPTY_BEHAVIOR="BY_MEASURE">
            <![CDATA[]]>
          </EXPRESSION>
          <DESCRIPTION>
            <![CDATA[]]>
          </DESCRIPTION>
          <SUMMARYFUNCTION>
            <![CDATA[0]]>
          </SUMMARYFUNCTION>
        </MEASURE>
      </MEASURES>
    </CUBEOBJECT>
  </SPECIFIC>
</IRO>

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully added cube object: RestApiTest",
"CODE": 0
}

Get Cubes From Folder Deprecated

This API is used to get Cube listing from a specific folder.

Note: This API has been deprecated. Please refer alternate API /smodels/folder/{folderNameOrId}.

Authorizations:

sessionIdbasicAuth

path Parameters

folderNameOrId

required

string

Name or Id of a folder from which you want to get a list of Cube Objects. Firstly, parameter folderNameOrId will be treated as Id. In case no CubeObject is found with that Id, then it will search for a CubeObject by taking folderNameOrId as Name

query Parameters

fetchJobStatus	string Default: false Enum: true false Example: fetchJobStatus=false Include status of last job
OWNER	string This parameter filters entities by owner (the user who created that entity) name.
TAGS	string This parameter filters the entities by tags.
SEARCH_TEXT	string This parameter filters the entities by their names. All entities whose name contains the searched text are included in the result, irrespective of the case format.
MODIFIED_AFTER	string This parameter filters the entities by their last modified timestamp. All the entities modified after the provided timestamp are included in the result.
MODIFIED_BEFORE	string This parameter filters the entities by their last modified timestamp. All the entities modified before the provided timestamp are included in the result.
COUNT	number This parameter sets the number of the records displayed in the response.
LAST_ENTITY_NAME	string When this parameter is used, the response shows only the entities occurring after the entity name specified in this parameter. The list ignores all the entities before that.
LAST_ENTITY_ID	string When this parameter is used, the response shows only the entities occurring after the entity ID specified in this parameter. The list ignores all the entities before that.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"CUBES": {"CUBE": [{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594136670,
"LAST_MODIFIED": "11/16/2022 15:52:16",
"id": "15336348064443127075025127247531",
"NAME": "History Audit cube"
},
{"ACCESSRIGHTS": 1,
"OWNER": "Admin",
"OWNERID": "Admin",
"LAST_MODIFIED_TIMESTAMP": 1668594136964,
"LAST_MODIFIED": "11/16/2022 15:52:16",
"id": "CUBE_OBJECT_15337271008344127081028174162622",
"NAME": "Querying Audit"
},
{"ACCESSRIGHTS": 1,
"OWNER": "anshul.sharma",
"OWNERID": 253292788,
"LAST_MODIFIED_TIMESTAMP": 1669563712115,
"LAST_MODIFIED": "11/27/2022 21:11:52",
"id": "CUBE_OBJECT_16695639511453127095042179066816",
"NAME": "Untitled Cube"
}
]
}
}
}

Get Cube Deprecated

This API is used to get Cube Object.

Note: This API has been deprecated. Please refer alternate API /smodels/smodel.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeId	string Id of the cube of which you want to get the object.If you do not know the cubeId, use the cubeName and folderName/folderId.
cubeName	string Name of the cube of which you want to get the object
folderId	string Folder id of the cube of which you want to get the object
folderName	string Folder name of the cube of which you want to get the object
addResponseTag	string Name of the cube of which you want to get the object

header Parameters

Accept	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/xml

<RESPONSE>
  <IRO ID="38C64DDA-4117-BB6F-A257-628777431843" NAME="Charter_Recommend_1" TYPE="ANALYTICAL" SUBTYPE="CUBE" CATEGORY_ID="" FOLDER_NAME="" FOLDER_ID=""  ACCESSRIGHTS="1" OWNERAPPID="Admin" OWNERAPPNAME="Admin" REPOSITDATE="06/06/2022 13:18:18" LINKED_ENTITY_ID="" ISPUBLIC="true">
    <COMMON>
      <DESC><![CDATA[]]></DESC>
      <COMPATIBILITY_VERSION><![CDATA[2]]></COMPATIBILITY_VERSION>
    </COMMON>
    <SPECIFIC>
      <ATTRS>
        <ATTR NAME="CUBEUNIQUENAME">
          <VALUE><![CDATA[]]></VALUE>
        </ATTR>
        <ATTR NAME="CONNECTION_NAME">
          <VALUE><![CDATA[]]></VALUE>
        </ATTR>
        <ATTR NAME="ISBOUND">
          <VALUE><![CDATA[false]]></VALUE>
        </ATTR>
        <ATTR NAME="RAW_DATA_QUERYING">
          <VALUE><![CDATA[0]]></VALUE>
        </ATTR>
        <ATTR NAME="DRD_ID">
          <VALUE><![CDATA[16540883111223127054086148794694]]></VALUE>
        </ATTR>
        <ATTR NAME="DRD_NAME">
          <VALUE><![CDATA[Charter1]]></VALUE>
        </ATTR>
        <ATTR NAME="CO_TYPE">
          <VALUE><![CDATA[INTERNAL]]></VALUE>
        </ATTR>
      </ATTRS>
      <COMMON>
        <DESC><![CDATA[]]></DESC>
        <COMPATIBILITY_VERSION><![CDATA[2]]></COMPATIBILITY_VERSION>
      </COMMON>
      <CUBEOBJECT VIEW_TYPE="">
        <LAYOUT_PROPERTY>
          <COLUMN_DETAILS><![CDATA[[{"panels":[],"style":{}},{"panels":[],"style":{}}]]]></COLUMN_DETAILS>
          <PANEL_DETAILS><![CDATA[{"sourceFields":{"style":{},"id":"sourceFields"},"filters":{"style":{},"id":"filters"},"properties":{"style":{},"id":"properties"}}]]></PANEL_DETAILS>
        </LAYOUT_PROPERTY>
        <SLIDING_WINDOWS>
        </SLIDING_WINDOWS>
        <AGGREGATION_STRATEGY TYPE="CONFIGURATION_DRIVEN">
          <CONFIGURATION_DRIVEN>
            <ENTITY_PROPS_VALUES>
              <PROPERTY>
                <NAME><![CDATA[kyvos.build.precompute.level.threshold]]></NAME>
                <VALUE><![CDATA[]]></VALUE>
                <MODE><![CDATA[DEFAULT]]></MODE>
              </PROPERTY>
              <PROPERTY>
                <NAME><![CDATA[kyvos.build.dimensions.materialize]]></NAME>
                <VALUE><![CDATA[]]></VALUE>
                <MODE><![CDATA[DEFAULT]]></MODE>
              </PROPERTY>
              <PROPERTY>
                <NAME><![CDATA[kyvos.build.precompute.degree]]></NAME>
                <VALUE><![CDATA[]]></VALUE>
                <MODE><![CDATA[DEFAULT]]></MODE>
              </PROPERTY>
              <PROPERTY>
                <NAME><![CDATA[kyvos.build.precompute.hierarchy.levels]]></NAME>
                <VALUE><![CDATA[]]></VALUE>
                <MODE><![CDATA[DEFAULT]]></MODE>
              </PROPERTY>
            </ENTITY_PROPS_VALUES>
          </CONFIGURATION_DRIVEN>
        </AGGREGATION_STRATEGY>
        <DIMENSIONS>
          <DIMENSION ID="Dim_Measures" DIM_TO_FACT_MAPPING="ONE_TO_MANY" RESTRICT="false" RESTRICTVALUES="false" IS_ACCESSIBLE="true" ISVISIBLE="true" MATERIALIZE="" CUBE_VIEW_TYPE="">
            <INCREMENTAL_UPDATE_PROPERTIES PROCESSING_MODE="1">
            </INCREMENTAL_UPDATE_PROPERTIES>
            <UNIQUENAME><![CDATA[Measures]]></UNIQUENAME>
            <NAME><![CDATA[Measures]]></NAME>
            <TYPE><![CDATA[MEASURE]]></TYPE>
            <PREDEF_TIME_HIERARCHY><![CDATA[]]></PREDEF_TIME_HIERARCHY>
            <DATAFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DATAFIELD>
            <DEFAULTHIERARCHYUNIQUENAME><![CDATA[Measures]]></DEFAULTHIERARCHYUNIQUENAME>
            <DESCRIPTION><![CDATA[]]></DESCRIPTION>
            <DATASOURCES>
            </DATASOURCES>
            <HIERARCHIES>
              <HIERARCHY HASALL="false" ISVISIBLE="true" ISDEFAULT="false" IS_CUSTOMCALENDAR="false" HAS_ALTERNATE_PATH="false" HAS_PARENTCHILD_RELATION="false" PC_LEVEL_COUNT="-1" IS_ACCESSIBLE="true" CUBE_VIEW_TYPE="" MATERIALIZE="">
                <UNIQUENAME><![CDATA[Measures]]></UNIQUENAME>
                <NAME><![CDATA[]]></NAME>
                <DEFAULTMEMBERUNIQUENAME><![CDATA[]]></DEFAULTMEMBERUNIQUENAME>
                <ALLMEMBERUNIQUENAME><![CDATA[]]></ALLMEMBERUNIQUENAME>
                <PREDEF_TIME_HIERARCHY><![CDATA[]]></PREDEF_TIME_HIERARCHY>
                <DATAFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DATAFIELD>
                <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                <LEVELS>
                  <LEVEL DATATYPE="Regular"  ISALL="false" SHOW_VALUES="0" MAPTYPE ="" IS_ACCESSIBLE="true" ISVISIBLE="true" IS_DELETED="false" HIDE_MEMBER="0" MATERIALIZE="">
                    <UNIQUENAME><![CDATA[MeasuresLevel]]></UNIQUENAME>
                    <NAME><![CDATA[]]></NAME>
                    <MEMBER_PROPERTIES>
                    </MEMBER_PROPERTIES>
                    <FULLY_QUALIFIED_NAME><![CDATA[]]></FULLY_QUALIFIED_NAME>
                    <DATEDATATYPE><![CDATA[]]></DATEDATATYPE>
                    <FIELDDATATYPE><![CDATA[]]></FIELDDATATYPE>
                    <SUBDATATYPE><![CDATA[]]></SUBDATATYPE>
                    <DISPLAYFIELDDATATYPE><![CDATA[]]></DISPLAYFIELDDATATYPE>
                    <GEOROLE><![CDATA[]]></GEOROLE>
                    <MAPLEVEL><![CDATA[]]></MAPLEVEL>
                    <DATAFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DATAFIELD>
                    <PARENTFIELD QUERY_NAME="" QUERY_ID="" DATA_TYPE=""><![CDATA[]]></PARENTFIELD>
                    <DISPLAYFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DISPLAYFIELD>
                    <HASTIMEINDATEFORMAT><![CDATA[false]]></HASTIMEINDATEFORMAT>
                    <DATEFORMAT><![CDATA[]]></DATEFORMAT>
                    <FORMATTYPE><![CDATA[]]></FORMATTYPE>
                    <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                    <PROPERTIES>
                    </PROPERTIES>
                  </LEVEL>
                </LEVELS>
              </HIERARCHY>
            </HIERARCHIES>
            <ATTRS>
              <ATTR DATATYPE="" IS_ACCESSIBLE="true" ISVISIBLE="true" IS_DELETED="false" DISPLAY_FOLDER="" MATERIALIZE="">
                <UNIQUENAME><![CDATA[Attribute]]></UNIQUENAME>
                <NAME><![CDATA[Attribute]]></NAME>
                <TYPE><![CDATA[]]></TYPE>
                <DATAFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DATAFIELD>
                <DISPLAYFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DISPLAYFIELD>
                <GEOROLE><![CDATA[]]></GEOROLE>
                <MAPLEVEL><![CDATA[]]></MAPLEVEL>
                <HASTIMEINDATEFORMAT><![CDATA[false]]></HASTIMEINDATEFORMAT>
                <DATEDATATYPE><![CDATA[]]></DATEDATATYPE>
                <FIELDDATATYPE><![CDATA[]]></FIELDDATATYPE>
                <SUBDATATYPE><![CDATA[]]></SUBDATATYPE>
                <DISPLAYFIELDDATATYPE><![CDATA[]]></DISPLAYFIELDDATATYPE>
                <DATEFORMAT><![CDATA[]]></DATEFORMAT>
                <FORMATTYPE><![CDATA[]]></FORMATTYPE>
                <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                <MEMBER_PROPERTIES>
                </MEMBER_PROPERTIES>
              </ATTR>
            </ATTRS>
            <CALC_MEMBERS>
            </CALC_MEMBERS>
            <SCD TYPE="2">
            </SCD>
          </DIMENSION>
          <DIMENSION ID="DIM_12" DIM_TO_FACT_MAPPING="ONE_TO_MANY" RESTRICT="false" RESTRICTVALUES="false" IS_ACCESSIBLE="true" ISVISIBLE="true" MATERIALIZE="" CUBE_VIEW_TYPE="">
            <INCREMENTAL_UPDATE_PROPERTIES PROCESSING_MODE="1">
            </INCREMENTAL_UPDATE_PROPERTIES>
            <UNIQUENAME><![CDATA[DIM_12]]></UNIQUENAME>
            <NAME><![CDATA[Dimension]]></NAME>
            <TYPE><![CDATA[Time]]></TYPE>
            <PREDEF_TIME_HIERARCHY><![CDATA[Y-M-D]]></PREDEF_TIME_HIERARCHY>
            <DATAFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DATAFIELD>
            <DEFAULTHIERARCHYUNIQUENAME><![CDATA[H_11]]></DEFAULTHIERARCHYUNIQUENAME>
            <DESCRIPTION><![CDATA[]]></DESCRIPTION>
            <DATASOURCES>
              <DATASOURCE ID="16540882697562127036042153362366_0" TYPE="REFERENCED">
              </DATASOURCE>
            </DATASOURCES>
            <HIERARCHIES>
              <HIERARCHY HASALL="false" ISVISIBLE="true" ISDEFAULT="false" IS_CUSTOMCALENDAR="false" HAS_ALTERNATE_PATH="false" HAS_PARENTCHILD_RELATION="false" PC_LEVEL_COUNT="-1" IS_ACCESSIBLE="true" CUBE_VIEW_TYPE="" MATERIALIZE="">
                <UNIQUENAME><![CDATA[H_11]]></UNIQUENAME>
                <NAME><![CDATA[H_Dimension]]></NAME>
                <DEFAULTMEMBERUNIQUENAME><![CDATA[]]></DEFAULTMEMBERUNIQUENAME>
                <ALLMEMBERUNIQUENAME><![CDATA[]]></ALLMEMBERUNIQUENAME>
                <PREDEF_TIME_HIERARCHY><![CDATA[Y-M-D]]></PREDEF_TIME_HIERARCHY>
                <DATAFIELD QUERY_NAME="Charter1" QUERY_ID="16540882697562127036042153362366_0"><![CDATA[saledate]]></DATAFIELD>
                <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                <LEVELS>
                  <LEVEL DATATYPE=""  ISALL="true" SHOW_VALUES="0" MAPTYPE ="" IS_ACCESSIBLE="true" ISVISIBLE="true" IS_DELETED="false" HIDE_MEMBER="0" MATERIALIZE="">
                    <UNIQUENAME><![CDATA[DIMENSION_LEVEL_920477996]]></UNIQUENAME>
                    <NAME><![CDATA[Hierarchy.ALL]]></NAME>
                    <MEMBER_PROPERTIES>
                    </MEMBER_PROPERTIES>
                    <FULLY_QUALIFIED_NAME><![CDATA[]]></FULLY_QUALIFIED_NAME>
                    <DATEDATATYPE><![CDATA[]]></DATEDATATYPE>
                    <FIELDDATATYPE><![CDATA[]]></FIELDDATATYPE>
                    <SUBDATATYPE><![CDATA[]]></SUBDATATYPE>
                    <DISPLAYFIELDDATATYPE><![CDATA[]]></DISPLAYFIELDDATATYPE>
                    <GEOROLE><![CDATA[]]></GEOROLE>
                    <MAPLEVEL><![CDATA[]]></MAPLEVEL>
                    <DATAFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DATAFIELD>
                    <PARENTFIELD QUERY_NAME="" QUERY_ID="" DATA_TYPE=""><![CDATA[]]></PARENTFIELD>
                    <DISPLAYFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DISPLAYFIELD>
                    <HASTIMEINDATEFORMAT><![CDATA[false]]></HASTIMEINDATEFORMAT>
                    <DATEFORMAT><![CDATA[]]></DATEFORMAT>
                    <FORMATTYPE><![CDATA[]]></FORMATTYPE>
                    <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                    <PROPERTIES>
                    </PROPERTIES>
                  </LEVEL>
                  <LEVEL DATATYPE="DATE"  ISALL="false" SHOW_VALUES="0" MAPTYPE ="" IS_ACCESSIBLE="true" ISVISIBLE="true" IS_DELETED="false" HIDE_MEMBER="0" MATERIALIZE="">
                    <UNIQUENAME><![CDATA[DIMENSION_LEVEL_17]]></UNIQUENAME>
                    <NAME><![CDATA[Year]]></NAME>
                    <MEMBER_PROPERTIES>
                    </MEMBER_PROPERTIES>
                    <FULLY_QUALIFIED_NAME><![CDATA[]]></FULLY_QUALIFIED_NAME>
                    <DATEDATATYPE><![CDATA[Year]]></DATEDATATYPE>
                    <FIELDDATATYPE><![CDATA[]]></FIELDDATATYPE>
                    <SUBDATATYPE><![CDATA[]]></SUBDATATYPE>
                    <DISPLAYFIELDDATATYPE><![CDATA[]]></DISPLAYFIELDDATATYPE>
                    <GEOROLE><![CDATA[]]></GEOROLE>
                    <MAPLEVEL><![CDATA[]]></MAPLEVEL>
                    <DATAFIELD QUERY_NAME="Charter1" QUERY_ID="16540882697562127036042153362366_0"><![CDATA[saledate]]></DATAFIELD>
                    <PARENTFIELD QUERY_NAME="" QUERY_ID="" DATA_TYPE=""><![CDATA[]]></PARENTFIELD>
                    <DISPLAYFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DISPLAYFIELD>
                    <HASTIMEINDATEFORMAT><![CDATA[false]]></HASTIMEINDATEFORMAT>
                    <DATEFORMAT><![CDATA[]]></DATEFORMAT>
                    <FORMATTYPE><![CDATA[]]></FORMATTYPE>
                    <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                    <PROPERTIES>
                    </PROPERTIES>
                  </LEVEL>
                  <LEVEL DATATYPE="DATE"  ISALL="false" SHOW_VALUES="0" MAPTYPE ="" IS_ACCESSIBLE="true" ISVISIBLE="true" IS_DELETED="false" HIDE_MEMBER="0" MATERIALIZE="">
                    <UNIQUENAME><![CDATA[DIMENSION_LEVEL_18]]></UNIQUENAME>
                    <NAME><![CDATA[Month]]></NAME>
                    <MEMBER_PROPERTIES>
                    </MEMBER_PROPERTIES>
                    <FULLY_QUALIFIED_NAME><![CDATA[]]></FULLY_QUALIFIED_NAME>
                    <DATEDATATYPE><![CDATA[Month]]></DATEDATATYPE>
                    <FIELDDATATYPE><![CDATA[]]></FIELDDATATYPE>
                    <SUBDATATYPE><![CDATA[]]></SUBDATATYPE>
                    <DISPLAYFIELDDATATYPE><![CDATA[]]></DISPLAYFIELDDATATYPE>
                    <GEOROLE><![CDATA[]]></GEOROLE>
                    <MAPLEVEL><![CDATA[]]></MAPLEVEL>
                    <DATAFIELD QUERY_NAME="Charter1" QUERY_ID="16540882697562127036042153362366_0"><![CDATA[saledate]]></DATAFIELD>
                    <PARENTFIELD QUERY_NAME="" QUERY_ID="" DATA_TYPE=""><![CDATA[]]></PARENTFIELD>
                    <DISPLAYFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DISPLAYFIELD>
                    <HASTIMEINDATEFORMAT><![CDATA[false]]></HASTIMEINDATEFORMAT>
                    <DATEFORMAT><![CDATA[]]></DATEFORMAT>
                    <FORMATTYPE><![CDATA[]]></FORMATTYPE>
                    <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                    <PROPERTIES>
                    </PROPERTIES>
                  </LEVEL>
                  <LEVEL DATATYPE="DATE"  ISALL="false" SHOW_VALUES="0" MAPTYPE ="" IS_ACCESSIBLE="true" ISVISIBLE="true" IS_DELETED="false" HIDE_MEMBER="0" MATERIALIZE="">
                    <UNIQUENAME><![CDATA[DIMENSION_LEVEL_19]]></UNIQUENAME>
                    <NAME><![CDATA[Day]]></NAME>
                    <MEMBER_PROPERTIES>
                    </MEMBER_PROPERTIES>
                    <FULLY_QUALIFIED_NAME><![CDATA[]]></FULLY_QUALIFIED_NAME>
                    <DATEDATATYPE><![CDATA[Day]]></DATEDATATYPE>
                    <FIELDDATATYPE><![CDATA[]]></FIELDDATATYPE>
                    <SUBDATATYPE><![CDATA[]]></SUBDATATYPE>
                    <DISPLAYFIELDDATATYPE><![CDATA[]]></DISPLAYFIELDDATATYPE>
                    <GEOROLE><![CDATA[]]></GEOROLE>
                    <MAPLEVEL><![CDATA[]]></MAPLEVEL>
                    <DATAFIELD QUERY_NAME="Charter1" QUERY_ID="16540882697562127036042153362366_0"><![CDATA[saledate]]></DATAFIELD>
                    <PARENTFIELD QUERY_NAME="" QUERY_ID="" DATA_TYPE=""><![CDATA[]]></PARENTFIELD>
                    <DISPLAYFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DISPLAYFIELD>
                    <HASTIMEINDATEFORMAT><![CDATA[false]]></HASTIMEINDATEFORMAT>
                    <DATEFORMAT><![CDATA[]]></DATEFORMAT>
                    <FORMATTYPE><![CDATA[]]></FORMATTYPE>
                    <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                    <PROPERTIES>
                    </PROPERTIES>
                  </LEVEL>
                </LEVELS>
              </HIERARCHY>
            </HIERARCHIES>
            <ATTRS>
            </ATTRS>
            <CALC_MEMBERS>
            </CALC_MEMBERS>
            <SCD TYPE="2">
            </SCD>
          </DIMENSION>
          <DIMENSION ID="DIM_13" DIM_TO_FACT_MAPPING="ONE_TO_MANY" RESTRICT="false" RESTRICTVALUES="false" IS_ACCESSIBLE="true" ISVISIBLE="true" MATERIALIZE="" CUBE_VIEW_TYPE="">
            <INCREMENTAL_UPDATE_PROPERTIES PROCESSING_MODE="1">
            </INCREMENTAL_UPDATE_PROPERTIES>
            <UNIQUENAME><![CDATA[DIM_13]]></UNIQUENAME>
            <NAME><![CDATA[Dimension_1]]></NAME>
            <TYPE><![CDATA[Regular]]></TYPE>
            <PREDEF_TIME_HIERARCHY><![CDATA[]]></PREDEF_TIME_HIERARCHY>
            <DATAFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DATAFIELD>
            <DEFAULTHIERARCHYUNIQUENAME><![CDATA[H_12]]></DEFAULTHIERARCHYUNIQUENAME>
            <DESCRIPTION><![CDATA[]]></DESCRIPTION>
            <DATASOURCES>
              <DATASOURCE ID="16540882697562127036042153362366_0" TYPE="REFERENCED">
              </DATASOURCE>
            </DATASOURCES>
            <HIERARCHIES>
              <HIERARCHY HASALL="false" ISVISIBLE="true" ISDEFAULT="false" IS_CUSTOMCALENDAR="false" HAS_ALTERNATE_PATH="false" HAS_PARENTCHILD_RELATION="false" PC_LEVEL_COUNT="-1" IS_ACCESSIBLE="true" CUBE_VIEW_TYPE="" MATERIALIZE="">
                <UNIQUENAME><![CDATA[H_12]]></UNIQUENAME>
                <NAME><![CDATA[H_Dimension_1]]></NAME>
                <DEFAULTMEMBERUNIQUENAME><![CDATA[]]></DEFAULTMEMBERUNIQUENAME>
                <ALLMEMBERUNIQUENAME><![CDATA[]]></ALLMEMBERUNIQUENAME>
                <PREDEF_TIME_HIERARCHY><![CDATA[]]></PREDEF_TIME_HIERARCHY>
                <DATAFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DATAFIELD>
                <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                <LEVELS>
                  <LEVEL DATATYPE=""  ISALL="true" SHOW_VALUES="0" MAPTYPE ="" IS_ACCESSIBLE="true" ISVISIBLE="true" IS_DELETED="false" HIDE_MEMBER="0" MATERIALIZE="">
                    <UNIQUENAME><![CDATA[DIMENSION_LEVEL_890916495]]></UNIQUENAME>
                    <NAME><![CDATA[Hierarchy.ALL]]></NAME>
                    <MEMBER_PROPERTIES>
                    </MEMBER_PROPERTIES>
                    <FULLY_QUALIFIED_NAME><![CDATA[]]></FULLY_QUALIFIED_NAME>
                    <DATEDATATYPE><![CDATA[]]></DATEDATATYPE>
                    <FIELDDATATYPE><![CDATA[]]></FIELDDATATYPE>
                    <SUBDATATYPE><![CDATA[]]></SUBDATATYPE>
                    <DISPLAYFIELDDATATYPE><![CDATA[]]></DISPLAYFIELDDATATYPE>
                    <GEOROLE><![CDATA[]]></GEOROLE>
                    <MAPLEVEL><![CDATA[]]></MAPLEVEL>
                    <DATAFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DATAFIELD>
                    <PARENTFIELD QUERY_NAME="" QUERY_ID="" DATA_TYPE=""><![CDATA[]]></PARENTFIELD>
                    <DISPLAYFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DISPLAYFIELD>
                    <HASTIMEINDATEFORMAT><![CDATA[false]]></HASTIMEINDATEFORMAT>
                    <DATEFORMAT><![CDATA[]]></DATEFORMAT>
                    <FORMATTYPE><![CDATA[]]></FORMATTYPE>
                    <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                    <PROPERTIES>
                    </PROPERTIES>
                  </LEVEL>
                  <LEVEL DATATYPE="CHAR"  ISALL="false" SHOW_VALUES="0" MAPTYPE ="" IS_ACCESSIBLE="true" ISVISIBLE="true" IS_DELETED="false" HIDE_MEMBER="0" MATERIALIZE="">
                    <UNIQUENAME><![CDATA[DIMENSION_LEVEL_23]]></UNIQUENAME>
                    <NAME><![CDATA[country]]></NAME>
                    <MEMBER_PROPERTIES>
                    </MEMBER_PROPERTIES>
                    <FULLY_QUALIFIED_NAME><![CDATA[]]></FULLY_QUALIFIED_NAME>
                    <DATEDATATYPE><![CDATA[]]></DATEDATATYPE>
                    <FIELDDATATYPE><![CDATA[]]></FIELDDATATYPE>
                    <SUBDATATYPE><![CDATA[]]></SUBDATATYPE>
                    <DISPLAYFIELDDATATYPE><![CDATA[]]></DISPLAYFIELDDATATYPE>
                    <GEOROLE><![CDATA[]]></GEOROLE>
                    <MAPLEVEL><![CDATA[]]></MAPLEVEL>
                    <DATAFIELD QUERY_NAME="Charter1" QUERY_ID="16540882697562127036042153362366_0"><![CDATA[country]]></DATAFIELD>
                    <PARENTFIELD QUERY_NAME="" QUERY_ID="" DATA_TYPE=""><![CDATA[]]></PARENTFIELD>
                    <DISPLAYFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DISPLAYFIELD>
                    <HASTIMEINDATEFORMAT><![CDATA[false]]></HASTIMEINDATEFORMAT>
                    <DATEFORMAT><![CDATA[]]></DATEFORMAT>
                    <FORMATTYPE><![CDATA[]]></FORMATTYPE>
                    <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                    <PROPERTIES>
                    </PROPERTIES>
                  </LEVEL>
                  <LEVEL DATATYPE="CHAR"  ISALL="false" SHOW_VALUES="0" MAPTYPE ="" IS_ACCESSIBLE="true" ISVISIBLE="true" IS_DELETED="false" HIDE_MEMBER="0" MATERIALIZE="">
                    <UNIQUENAME><![CDATA[DIMENSION_LEVEL_22]]></UNIQUENAME>
                    <NAME><![CDATA[city]]></NAME>
                    <MEMBER_PROPERTIES>
                    </MEMBER_PROPERTIES>
                    <FULLY_QUALIFIED_NAME><![CDATA[]]></FULLY_QUALIFIED_NAME>
                    <DATEDATATYPE><![CDATA[]]></DATEDATATYPE>
                    <FIELDDATATYPE><![CDATA[]]></FIELDDATATYPE>
                    <SUBDATATYPE><![CDATA[]]></SUBDATATYPE>
                    <DISPLAYFIELDDATATYPE><![CDATA[]]></DISPLAYFIELDDATATYPE>
                    <GEOROLE><![CDATA[]]></GEOROLE>
                    <MAPLEVEL><![CDATA[]]></MAPLEVEL>
                    <DATAFIELD QUERY_NAME="Charter1" QUERY_ID="16540882697562127036042153362366_0"><![CDATA[city]]></DATAFIELD>
                    <PARENTFIELD QUERY_NAME="" QUERY_ID="" DATA_TYPE=""><![CDATA[]]></PARENTFIELD>
                    <DISPLAYFIELD QUERY_NAME="" QUERY_ID=""><![CDATA[]]></DISPLAYFIELD>
                    <HASTIMEINDATEFORMAT><![CDATA[false]]></HASTIMEINDATEFORMAT>
                    <DATEFORMAT><![CDATA[]]></DATEFORMAT>
                    <FORMATTYPE><![CDATA[]]></FORMATTYPE>
                    <DESCRIPTION><![CDATA[]]></DESCRIPTION>
                    <PROPERTIES>
                    </PROPERTIES>
                  </LEVEL>
                </LEVELS>
              </HIERARCHY>
            </HIERARCHIES>
            <ATTRS>
            </ATTRS>
            <CALC_MEMBERS>
            </CALC_MEMBERS>
            <SCD TYPE="2">
            </SCD>
          </DIMENSION>
        </DIMENSIONS>
        <MEASURE_GROUPS>
          <DATASOURCES>
            <DATASOURCE ID="16540882697562127036042153362366_0" TYPE="REFERENCED">
            </DATASOURCE>
          </DATASOURCES>
          <MEASURE_GROUP NAME="MeasureGroup" IS_ACCESSIBLE="true" ISVISIBLE="true" MATERIALIZE="">
            <DESCRIPTION><![CDATA[]]></DESCRIPTION>
            <MEASURE_ID><![CDATA[MEASURE_11]]></MEASURE_ID>
          </MEASURE_GROUP>
        </MEASURE_GROUPS>
        <MEASURES>
          <INCREMENTAL_UPDATE_PROPERTIES PROCESSING_MODE="1">
          </INCREMENTAL_UPDATE_PROPERTIES>
          <MEASURE ID="MEASURE_11" TYPE="STANDARD" DATATYPE="NUMBER" SUBTYPE= "" ISVISIBLE="true" ISDEFAULT="true" RESTRICT="false" SOLVE_ORDER="0" ISADJUSTMENT="false" ADJUSTMENT_TYPE="NEGATIVE" DISPLAY_FOLDER="" COLOR="" IS_ACCESSIBLE="true" MATERIALIZE="">
            <UNIQUENAME><![CDATA[MEASURE_11]]></UNIQUENAME>
            <NAME><![CDATA[saleamount]]></NAME>
            <FORMAT USEDEFAULT="0"><![CDATA[#,##0.00]]></FORMAT>
            <FORMATTYPE><![CDATA[2]]></FORMATTYPE>
            <UNIT>
            </UNIT>
            <SUMMARYFUNCTION><![CDATA[0]]></SUMMARYFUNCTION>
            <ACTUALSUMMARYFUNCTION><![CDATA[0]]></ACTUALSUMMARYFUNCTION>
            <DATAFIELD QUERY_NAME="Charter1" QUERY_ID="16540882697562127036042153362366_0"><![CDATA[saleamount]]></DATAFIELD>
            <MINON_MAXON_DATAFIELD QUERY_NAME="Charter1" QUERY_ID="16540882697562127036042153362366_0"><![CDATA[]]></MINON_MAXON_DATAFIELD>
            <EXPRESSION NON_EMPTY_BEHAVIOR="BY_MEASURE"><![CDATA[]]></EXPRESSION>
            <DESCRIPTION><![CDATA[]]></DESCRIPTION>
            <IS_BOUNDARY_DIST_COUNT><![CDATA[false]]></IS_BOUNDARY_DIST_COUNT>
          </MEASURE>
        </MEASURES>
        <LINK_DESIGN_LAYOUT>
        </LINK_DESIGN_LAYOUT>
      </CUBEOBJECT>
      <DELTA_INFO>
      </DELTA_INFO>
    </SPECIFIC>
  </IRO>
</RESPONSE>

Update Cube Deprecated

This API is used to update an existing cube.

Note: This API has been deprecated. Please refer alternate API /smodels/{nameOrId}.

Authorizations:

sessionIdbasicAuth

path Parameters

nameOrId

required

string

Name or Id of CubeObject. Firstly, parameter nameOrId will be treated as Id. In case no CubeObject is found with that Id, then it will search for a CubeObject by taking nameOrId as Name. In case of nameOrId as Name, folderNameOrId is used

header Parameters

Accept	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

cubeXML

required

object

XML of a cube object. This XML can be generated with the help of com.kyvos.commons.entity.reportobjects.CubeObject class.
For e.g.

  <IRO ID="15452933458461127071083153170947" NAME="Historical Field Details" TYPE="ANALYTICAL" SUBTYPE="CUBE" FOLDER_ID="folder_15396014106428127088047133277741" FOLDER_NAME="Query Analyzer" ISPUBLIC="">
  <COMMON>
    <DESC>
      <![CDATA[]]>
    </DESC>
    <COMPATIBILITY_VERSION>
      <![CDATA[1]]>
    </COMPATIBILITY_VERSION>
  </COMMON>
  <SPECIFIC>
    <ATTRS>
      <ATTR NAME="CUBEUNIQUENAME">
        <VALUE>
          <![CDATA[15452933458461127071083153170947]]>
        </VALUE>
      </ATTR>
    </ATTRS>
    <CUBEOBJECT>
      <LAYOUT_PROPERTY>
        <PANEL_DETAILS>
          <![CDATA[{"filters":{"style":{"height":-5},"id":"filters"},"properties":{"style":{"height":94},"id":"properties"},"sourceFields":{"id":"sourceFields","style":{"height":89}}}]]>
        </PANEL_DETAILS>
        <COLUMN_DETAILS>
          <![CDATA[[{"style":{},"panels":["sourceFields"]},{"index":0,"style":{"width":293.326},"panels":[]},{"index":1,"style":{}}]]]>
        </COLUMN_DETAILS>
      </LAYOUT_PROPERTY>
      <SLIDING_WINDOWS>
      <AGGREGATION_STRATEGY TYPE="CONFIGURATION_DRIVEN" >
        <CONFIGURATION_DRIVEN>
          <ENTITY_PROPS_VALUES>
            <PROPERTY>
              <NAME>
                <![CDATA[kyvos.build.precompute.level.threshold]]>
              </NAME>
              <VALUE>
                <![CDATA[]]>
              </VALUE>
              <MODE>
                <![CDATA[DEFAULT]]>
              </MODE>
            </PROPERTY>
            <PROPERTY>
              <NAME>
                <![CDATA[kyvos.build.dimensions.materialize]]>
              </NAME>
              <VALUE>
                <![CDATA[]]>
              </VALUE>
              <MODE>
                <![CDATA[DEFAULT]]>
              </MODE>
            </PROPERTY>
            <PROPERTY>
              <NAME>
                <![CDATA[kyvos.build.precompute.degree]]>
              </NAME>
              <VALUE>
                <![CDATA[]]>
              </VALUE>
              <MODE>
                <![CDATA[DEFAULT]]>
              </MODE>
            </PROPERTY>
            <PROPERTY>
              <NAME>
                <![CDATA[kyvos.build.precompute.hierarchy.levels]]>
              </NAME>
              <VALUE>
                <![CDATA[]]>
              </VALUE>
              <MODE>
                <![CDATA[DEFAULT]]>
              </MODE>
            </PROPERTY>
          </ENTITY_PROPS_VALUES>
        </CONFIGURATION_DRIVEN>
      </AGGREGATION_STRATEGY>
      <DIMENSIONS>
        <DIMENSION ID="Dim_Measures" RESTRICT="false" RESTRICTVALUES="false">
          <NAME>
            <![CDATA[Measures]]>
          </NAME>
          <UNIQUENAME>
            <![CDATA[Measures]]>
          </UNIQUENAME>
          <TYPE>
            <![CDATA[MEASURE]]>
          </TYPE>
          <DEFAULTHIERARCHYUNIQUENAME>
            <![CDATA[Measures]]>
          </DEFAULTHIERARCHYUNIQUENAME>
          <HIERARCHIES>
            <HIERARCHY HASALL="false">
              <UNIQUENAME>
                <![CDATA[Measures]]>
              </UNIQUENAME>
              <ALLMEMBERUNIQUENAME />/n
              <LEVELS>
                <LEVEL DATATYPE="Regular">
                  <UNIQUENAME>
                    <![CDATA[MeasuresLevel]]>
                  </UNIQUENAME>
                  <DATAFIELD />
                  <PROPERTIES />
                </LEVEL>
              </LEVELS>
            </HIERARCHY>
          </HIERARCHIES>
          <ATTRS>
            <ATTR DATATYPE="">
              <UNIQUENAME>
                <![CDATA[Attribute]]>
              </UNIQUENAME>
              <NAME>
                <![CDATA[Attribute]]>
              </NAME>
              <DATAFIELD />
            </ATTR>
          </ATTRS>
        </DIMENSION>
      </DIMENSIONS>
      <MEASURE_GROUPS>
        <MEASURE_GROUP NAME="Measure Group" ISVISIBLE="true" MATERIALIZE="">
          <DESCRIPTION>
            <![CDATA[]]>
          </DESCRIPTION>
          <MEASURE_ID>
            <![CDATA[MEASURE_34820]]>
          </MEASURE_ID>
        </MEASURE_GROUP>
      </MEASURE_GROUPS>
      <MEASURES>
        <MEASURE ID="MEASURE_34820" DATATYPE="NUMBER" ISDEFAULT="true" ISVISIBLE="true" SOLVE_ORDER="0" DISPLAY_FOLDER="" MATERIALIZE="">
          <UNIQUENAME>
            <![CDATA[MEASURE_34820]]>
          </UNIQUENAME>
          <NAME>
            <![CDATA[Query Count]]>
          </NAME>
          <FORMAT USEDEFAULT="0">
            <![CDATA[#,##0]]>
          </FORMAT>
          <FORMATTYPE>
            <![CDATA[2]]>
          </FORMATTYPE>
          <UNIT>
            <![CDATA[]]>
          </UNIT>
          <DATAFIELD QUERY_NAME="field_details" QUERY_ID="15451326173844127065091156882788_0">
            <![CDATA[field_used_count]]>
          </DATAFIELD>
          <EXPRESSION NON_EMPTY_BEHAVIOR="BY_MEASURE">
            <![CDATA[]]>
          </EXPRESSION>
          <DESCRIPTION>
            <![CDATA[]]>
          </DESCRIPTION>
          <SUMMARYFUNCTION>
            <![CDATA[0]]>
          </SUMMARYFUNCTION>
        </MEASURE>
      </MEASURES>
    </CUBEOBJECT>
  </SPECIFIC>
</IRO>

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully replaced cube object: Untitled Cube 1",
"CODE": 0
}

Delete Cube Deprecated

This API is used to delete an existing Cube.

Note: This API has been deprecated. Please refer alternate API /smodels/deleteSmodel.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeId	string Id of the cube of which you want to get the object. If you do not know the cubeId, use the cubeName and folderName/folderId.
cubeName	string Name of the cube of which you want to get the object
folderName	string Folder name of the cube of which you want to get the object.
folderId	string Folder id of the cube of which you want to get the object.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Cube deleted successfully.",
"CODE": 0
}

Save Cube Deprecated

This API is used to add/update cube entity with given entity XML. As this API performs bulk operation, you must have privileges to import and export objects to use this API.

Note: This API has been deprecated. Please refer alternate API /smodels/saveSmodel.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

cubeXML

required

object

XML of the cube entity to be saved.

For e.g.

  <IROS>
    <IRO ID="CUBE_OBJECT_16619426349350127042065120488280" NAME="RestAPITestCube" TYPE="ANALYTICAL" SUBTYPE="CUBE" FOLDER_ID="" FOLDER_NAME="" ISPUBLIC="">
        <COMMON>
          <DESC>
            <![CDATA[]]>
          </DESC>
          <COMPATIBILITY_VERSION>
            <![CDATA[2]]>
          </COMPATIBILITY_VERSION>
        </COMMON>
        <SPECIFIC>
          <ATTRS>
            <ATTR NAME="CUBEUNIQUENAME">
              <VALUE>
                <![CDATA[CUBE_OBJECT_16619426349350127042065120488280]]>
              </VALUE>
            </ATTR>
          </ATTRS>
          <CUBEOBJECT>
            <SLIDING_WINDOWS>
            <AGGREGATION_STRATEGY TYPE="CONFIGURATION_DRIVEN" >
              <CONFIGURATION_DRIVEN>
                <ENTITY_PROPS_VALUES>
              </CONFIGURATION_DRIVEN>
            </AGGREGATION_STRATEGY>
            <DIMENSIONS>
              <DIMENSION ID="Dim_Measures" RESTRICT="false" RESTRICTVALUES="false">
                <NAME>
                  <![CDATA[Measures]]>
                </NAME>
                <UNIQUENAME>
                  <![CDATA[Measures]]>
                </UNIQUENAME>
                <TYPE>
                  <![CDATA[MEASURE]]>
                </TYPE>
                <DEFAULTHIERARCHYUNIQUENAME>
                  <![CDATA[Measures]]>
                </DEFAULTHIERARCHYUNIQUENAME>
                <HIERARCHIES>
                  <HIERARCHY HASALL="false">
                    <UNIQUENAME>
                      <![CDATA[Measures]]>
                    </UNIQUENAME>
                    <ALLMEMBERUNIQUENAME />/n
                    <LEVELS>
                      <LEVEL DATATYPE="Regular">
                        <UNIQUENAME>
                          <![CDATA[MeasuresLevel]]>
                        </UNIQUENAME>
                        <DATAFIELD />
                        <PROPERTIES />
                      </LEVEL>
                    </LEVELS>
                  </HIERARCHY>
                </HIERARCHIES>
                <ATTRS>
                  <ATTR DATATYPE="">
                    <UNIQUENAME>
                      <![CDATA[Attribute]]>
                    </UNIQUENAME>
                    <NAME>
                      <![CDATA[Attribute]]>
                    </NAME>
                    <DATAFIELD />
                  </ATTR>
                </ATTRS>
              </DIMENSION>
              <DIMENSION ID="DIM_809312" ISVISIBLE="true" MATERIALIZE="">
                <UNIQUENAME>
                  <![CDATA[DIM_809312]]>
                </UNIQUENAME>
                <NAME>
                  <![CDATA[field_details]]>
                </NAME>
                <TYPE>
                  <![CDATA[Regular]]>
                </TYPE>
                <DESCRIPTION>
                  <![CDATA[]]>
                </DESCRIPTION>
                <HIERARCHIES>
                <ATTRS>
                  <ATTR DATATYPE="CHAR" DISPLAY_FOLDER="" ISVISIBLE="true"  MATERIALIZE="">
                    <UNIQUENAME>
                      <![CDATA[DIMENSION_ATTRIBUTE_580323]]>
                    </UNIQUENAME>
                    <NAME>
                      <![CDATA[query_id]]>
                    </NAME>
                    <DATAFIELD QUERY_NAME="field_details" QUERY_ID="15451326173844127065091156882788_0">
                      <![CDATA[query_id]]>
                    </DATAFIELD>
                    <DISPLAYFIELD QUERY_NAME="" QUERY_ID="">
                      <![CDATA[]]>
                    </DISPLAYFIELD>
                    <DATEDATATYPE>
                      <![CDATA[]]>
                    </DATEDATATYPE>
                    <FIELDDATATYPE>
                      <![CDATA[]]>
                    </FIELDDATATYPE>
                    <GEOROLE>
                      <![CDATA[]]>
                    </GEOROLE>
                    <MAPLEVEL>
                      <![CDATA[]]>
                    </MAPLEVEL>
                    <TYPE>
                      <![CDATA[Regular]]>
                    </TYPE>
                    <HASTIMEINDATEFORMAT>
                      <![CDATA[false]]>
                    </HASTIMEINDATEFORMAT>
                    <DESCRIPTION>
                      <![CDATA[]]>
                    </DESCRIPTION>
                  </ATTR>
                </ATTRS>
                <CALC_MEMBERS>
                <SCD TYPE="2">
              </DIMENSION>
            </DIMENSIONS>
            <MEASURE_GROUPS>
              <MEASURE_GROUP NAME="field_details" ISVISIBLE="true" MATERIALIZE="">
                <DESCRIPTION>
                  <![CDATA[]]>
                </DESCRIPTION>
                <MEASURE_ID>
                  <![CDATA[MEASURE_527054]]>
                </MEASURE_ID>
              </MEASURE_GROUP>
            </MEASURE_GROUPS>
            <MEASURES>
              <MEASURE ID="MEASURE_527054" DATATYPE="NUMBER" ISDEFAULT="true" ISVISIBLE="true" SOLVE_ORDER="0" DISPLAY_FOLDER="" MATERIALIZE="">
                <UNIQUENAME>
                  <![CDATA[MEASURE_527054]]>
                </UNIQUENAME>
                <NAME>
                  <![CDATA[field_used_count]]>
                </NAME>
                <FORMAT USEDEFAULT="0">
                  <![CDATA[#,##0.00]]>
                </FORMAT>
                <FORMATTYPE>
                  <![CDATA[2]]>
                </FORMATTYPE>
                <UNIT>
                  <![CDATA[]]>
                </UNIT>
                <DATAFIELD QUERY_NAME="field_details" QUERY_ID="15451326173844127065091156882788_0">
                  <![CDATA[field_used_count]]>
                </DATAFIELD>
                <EXPRESSION NON_EMPTY_BEHAVIOR="BY_MEASURE">
                  <![CDATA[]]>
                </EXPRESSION>
                <DESCRIPTION>
                  <![CDATA[]]>
                </DESCRIPTION>
                <SUMMARYFUNCTION>
                  <![CDATA[0]]>
                </SUMMARYFUNCTION>
              </MEASURE>
            </MEASURES>
          </CUBEOBJECT>
        </SPECIFIC>
      </IRO>
    </IROS>

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"RES": [{"MESSAGE": "Successfully added cube object: RestTest1",
"CODE": 0
},
{"MESSAGE": "Successfully added cube object: RestTest2",
"CODE": 0
}
]
}
}

Invoke Cube Build Deprecated

This API is used to invoke cube build, get build status. or cancel builds.

Note: This API has been deprecated. Please refer alternate API /smodels/process.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeId	string Id of the cube of which you want to get the object
cubeName	string Name of the cube of which you want to get the object
folderName	string Folder name of the cube of which you want to get the object
folderId	string Folder id of the cube of which you want to get the object

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

buildType	string Enum: "FULL" "INCREMENTAL" "DROP_PARTITION" "UPDATE_AGGREGATES" "CACHE_POPULATION" "FULL_TEST" Provide the details for cube build type. Possible values: FULL, INCREMENTAL, DROP_PARTITION, UPDATE_AGGREGATES, CACHE_POPULATION and FULL_TEST FULL: Recreates the cube with all available data including recalculation of all aggregations. INCREMENTAL: Updates the cube with latest data. FULL_TEST: Recreates the cube with limited rows. UPDATE_AGGREGATES: updates cube aggregates based on current aggregation strategy. CACHE_POPULATION: Clears cached query responses and then re-populates it with latest cube data. DROP_PARTITION: Create rules to select partitions to drop.
replacePartition	boolean Default: false Enum: true false Determines whether the incremental cube build should be with replace partition or not. Default Value: False
runType	string Default: "NOW" Enum: "NOW" "ONCE" Determines whether the cube build would be performed just now or once at a given date and time. Possible values are NOW, ONCE. Default Value: NOW Now: This will immediately start the job Once: Job will run at the specified time
onceDateTime	string This parameter is only applicable for runType ONCE. It specifies the date and time when the cube build would start(format: mm/dd/yyyy hh:mm)
userParams	string The parameters info which is to be used in cube build. Value in JSON should be passed. Example: [ { "name": "parameterName", "value": "parameterValue" } ]
incrementalJobProcessType	string Type of process if build type is incremental. The possible value is FACT_ADJUSTMENTS
buildConnectionName	string Build Connection Name
dropPartitionRulesJson	object Value in JSON should be passed as what is in the database, not the display value. IsValueQualified is true when year and month both are present in value and must be passed at that time only as shown in the above JSON example. valueSeparator is used when we need to pass more than one value as shown in the below JSON Example. { "rules": [ { "factNames": [ "PurchaseDS", "SalesDS" ], "conditions": [ { "dimensionName": "DatesGTD", "levelName": "Month", "operator": "INLIST", "value": "JAN-2012@FEB-2012", "valueSeparator": "@", "isValueQualified": true }, { "dimensionName": "DatesGTD", "levelName": "Month", "operator": "EQUAL_TO", "value": "JUL-2012", "isValueQualified": true } ] }, { "factNames": [ "SalesDS" ], "conditions": [ { "dimensionName": "DatesGTD", "levelName": "Month", "operator": "BETWEEN", "value": "FEB-2013", "secondValue": "APR-2013", "isValueQualified": true } ] } ] }
updateAggregatesPartitions	object List of partitions needs to be updated should be passed in JSON format. Example: { "partitions": [ { "caption": "2020-06-30", "id": "18444", "factName": "", } ] }
systemParamsJson	object Value in JSON should be passed. The system parameters key value pair JSON array of object which is to be used in cube build. Example: user can pass selected datasets for Incremental build in system Params. { "name": "DATASETS", "value": [ { "name": "Join of HospitalDetails, Hospitals" }, { "name": "Accounting" } ] }
recommendationParamsJson	object Value in JSON should be passed. JSON Example. { "RECOMMENDATION_TYPE": "AGGREGATION", "AGGREGATION_STRATEGY_TYPE": "ONLY_NEW_AGGREGATION/KEEP_EXISTING/MINIMAL_AGGREGATION", "QUERY_DAYS": 3, "QUERY_EXECUTION_TIME": 10, "SELECTED_USERS": "system-user", //user names of user whose queries needs to be considered "CONSIDER_QUERY_PATTERNS": false //whether to inclue additonal query or not }

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Cube build submitted successfully.",
"CODE": 0
}

Get Build Status Deprecated

This API is used to fetch cube build status.

Note: This API has been deprecated. Please refer alternate API /smodels/jobStatus.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeId	string Id of the cube of which you want to get the object. If you do not know the cubeId, use the cubeName and folderName/folderId.
cubeName	string Name of the cube of which you want to get the object
folderName	string Folder name of the cube of which you want to get the object.
folderId	string Folder id of the cube of which you want to get the object.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": "COMPLETED"
}

Get Build Summary Deprecated

This API is used to fetch cube build summary.

Note: This API has been deprecated. Please refer alternate API /smodels/jobSummary.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeId	string Id of the cube of which you want to get the object.
folderId	string Folder id of the cube of which you want to get the object.
cubeName	string Name of the cube of which you want to get the object.
folderName	string Folder name of the cube of which you want to get the object.
buildType	string Enum: "FULL" "INCREMENTAL" "DROP_PARTITION" "UPDATE_AGGREGATES" "CACHE_POPULATION" "FULL_TEST" Example: buildType=FULL Provide the details for cube build type. Possible values: FULL, INCREMENTAL, DROP_PARTITION, UPDATE_AGGREGATES, CACHE_POPULATION and FULL_TEST FULL: Recreates the cube with all available data including recalculation of all aggregations. INCREMENTAL: Updates the cube with latest data. FULL_TEST: Recreates the cube with limited rows. UPDATE_AGGREGATES: updates cube aggregates based on current aggregation strategy. CACHE_POPULATION: Clears cached query responses and then re-populates it with latest cube data. DROP_PARTITION: Create rules to select partitions to drop.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"ALL_BUILD_STATUS": {"BUILD_STATUS": {"BUILD_FUNCTION": "Test",
"CONSOLIDATED_BUILD_STATUS": {"COMPLETED": {"PROBLEMS": {"PROBLEM": [{"MESSAGE": "The hierarchy or attribute names are either duplicate across dimensions or invalid. Following are the invalid entities:",
"PROBLEM_FUNCTIONAL_TYPE": "DEFAULT",
"CUBE_VIEW_TYPE": "PHYSICAL",
"TYPE": "WARNING",
"STACKTRACE": {"REASON": {"MESSAGE": "Hierarchy/Attribute Name:Hierarchy : (Dim Name: Geography, Type:hierarchy); (Dim Name: Time, Type:hierarchy); (Dim Name: tManufacturer, Type:hierarchy);",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "Hierarchy",
"OBJECT": "CURRENT",
"NAME": "Hierarchy"
}
}
},
{"MESSAGE": "Registered file Product-Sales_Detail_50GB contains some invalid entries.",
"PROBLEM_FUNCTIONAL_TYPE": "DEFAULT",
"OBJECTS": {"OBJECT": {"SUBTYPE": "REGISTERED",
"ID": "14078499836997127032066196431512",
"TYPE": "QUERY",
"NAME": "Product-Sales_Detail_50GB"
}
},
"TYPE": "WARNING",
"STACKTRACE": {"REASON": [{"MESSAGE": "Blank number values replaced to default for step Fetch :2",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Blank row for step Fetch :1",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Blank column value for step Fetch :1",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Blank date values replaced to default for step Fetch :0",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Mismatch data format for step Fetch :0",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Mismatch column size for step Fetch :0",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Mismatch data type for step Fetch :0",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
}
]
}
}
]
},
"CUBEBUILD_ELAPSED_TIME": 317974,
"IS_AGGREGATE_BUILD": false,
"SIZE": 500882823,
"TIMESTAMP": "08/28/2022 12:32:39",
"SECTIONS": {"SECTION": [{"MESSAGES": {"MESSAGE": [{"TYPE": "INFO",
"content": "<B>Dimensions</B>"
},
{"TYPE": "INFO",
"content": "Dimension: <B>Geography</B> (Member count: <B>51,304</B>, Metadata size: <B>47.2 MB</B>, Type: <B>Regular</B>)<BR>&nbsp;&nbsp;&nbsp;Hierarchy:&nbsp;<B>Hierarchy</B>(Member count: <B>51,304</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Continent</B> (Member count: <B>7</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Country</B> (Member count: <B>247</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>State</B> (Member count: <B>2,724</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>City</B> (Member count: <B>51,304</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Geography_Implicit_Level</B> (Member count: <B>51,304</B>)<BR>&nbsp;&nbsp;&nbsp;Attributes:&nbsp<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Attribute:&nbsp;<B>Region(Profit)%, : / \\ * | ? % $ ! + = {} < ></B> (Member count: <B>156</B>)<BR>"
},
{"TYPE": "INFO",
"content": "Dimension: <B>Time</B> (Member count: <B>1,703</B>, Metadata size: <B>52.4 MB</B>, Type: <B>Regular</B>)<BR>&nbsp;&nbsp;&nbsp;Hierarchy:&nbsp;<B>Hierarchy</B>(Member count: <B>1,703</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Year</B> (Member count: <B>6</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Quarter</B> (Member count: <B>20</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Month</B> (Member count: <B>57</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Week</B> (Member count: <B>276</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Day</B> (Member count: <B>1,703</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Date</B> (Member count: <B>1,703</B>)<BR>"
},
{"TYPE": "INFO",
"content": "Dimension: <B>DCustomer-Detail</B> (Member count: <B>795</B>, Metadata size: <B>18.9 MB</B>, Type: <B>Regular</B>)<BR>&nbsp;&nbsp;&nbsp;Hierarchy:&nbsp;<B>CustomerHierarchy</B>(Member count: <B>795</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Customer_Segment</B> (Member count: <B>4</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Customer_Name</B> (Member count: <B>795</B>)<BR>"
},
{"TYPE": "INFO",
"content": "Dimension: <B>Product-Detail</B> (Member count: <B>46</B>, Metadata size: <B>27.3 MB</B>, Type: <B>Regular</B>)<BR>&nbsp;&nbsp;&nbsp;Hierarchy:&nbsp;<B>Hierarchy(Profit)%, : / \\ * | ? % $ ! + = {} < ></B>(Member count: <B>46</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Product_Category(Profit)%, : / \\ * | ? % $ ! + = {} < ></B> (Member count: <B>3</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Product_Type(Profit)%, : / \\ * | ? % $ ! + = {} < ></B> (Member count: <B>10</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Product_Name</B> (Member count: <B>46</B>)<BR>"
},
{"TYPE": "INFO",
"content": "Dimension: <B>tManufacturer</B> (Member count: <B>21</B>, Metadata size: <B>8.4 MB</B>, Type: <B>Regular</B>)<BR>&nbsp;&nbsp;&nbsp;Hierarchy:&nbsp;<B>Hierarchy</B>(Member count: <B>21</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Manufacturer</B> (Member count: <B>21</B>)<BR>"
},
{"TYPE": "INFO",
"content": "<B>Measure Datasets</B>"
},
{"TYPE": "INFO",
"content": "Measure dataset: <B> Product-Sales_Detail_50GB</B> (Rows processed: <B>1,814,808</B>, Rows skipped: <B>1</B>, Total file size: <B>402.91 MB</B>, Execution Time: <B>08/28/2022 12:32:26</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Shipping_Cost</B>,&nbsp;Function: <B>sum</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Discount</B>,&nbsp;Function: <B>average</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Product_Type_DC</B>,&nbsp;Function: <B>distinct count</B>,&nbsp;Accuracy Type:&nbsp;<B>Accurate</B>,&nbsp;Calculated on:&nbsp;<B>Product_Type</B>,&nbsp;Member count:&nbsp;<B>10</B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Product_ID</B>,&nbsp;Function: <B>count</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Order_Quantity</B>,&nbsp;Function: <B>count</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Region_DC</B>,&nbsp;Function: <B>distinct count</B>,&nbsp;Accuracy Type:&nbsp;<B>Accurate</B>,&nbsp;Calculated on:&nbsp;<B>Region</B>,&nbsp;Member count:&nbsp;<B>156</B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>(Profit)%, : / \\ * | ? % $ ! + = {} < ></B>,&nbsp;Function: <B>sum</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Sale_Amount</B>,&nbsp;Function: <B>sum</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Row Count - Product-Sales_Detail_50GB - SYSTEM MEASURE</B>,&nbsp;Function: <B>count</B></B>"
}
]
},
"TYPE": "PHYSICAL_VIEW"
},
{"MESSAGES": {"MESSAGE": [{"TYPE": "INFO",
"content": "Measure dataset: <B> Product-Sales_Detail_50GB</B>"
},
{"TYPE": "INFO",
"content": "&nbsp;&nbsp;&nbsp;<B>Design:</B>\t\t\tPartition column: <B>None</B>\tBase partition range size: <B>None</B>"
}
]
},
"TYPE": "PARTITION_STRATEGY"
},
{"MESSAGES": "",
"TYPE": "ADVANCED_PROPERTIES"
},
{"MESSAGES": "",
"TYPE": "AGGREGATION_STRATEGY"
},
{"MESSAGES": {"MESSAGE": [{"TYPE": "INFO",
"content": "Cube metadata size: <B>158.43 MB</B>"
},
{"TYPE": "INFO",
"content": "Connection Name: <B>DefaultHadoopCluster01</B>"
},
{"TYPE": "INFO",
"content": "Cube Compatibility Version: <B>1</B>"
},
{"TYPE": "INFO",
"content": "<BR><B>Test build details:</B><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Last fact partitions processed:&nbsp<B>3</B><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Minimal aggregation:&nbsp<B>true</B>"
}
]
},
"TYPE": "MISCELLANEOUS"
},
{"MESSAGES": {"MESSAGE": {"TYPE": "INFO",
"content": "{\"total\":{\"cuboidSize\":\"342.45 MB\",\"maxCuboidSize\":\"22.10 MB\",\"avgCuboidSize\":\"14.89 MB\",\"cuboidCount\":23,\"minCuboidSize\":\"4.09 KB\"},\"colOrder\":{\"cuboidSize\":4,\"dimName\":2,\"maxCuboidSize\":6,\"avgCuboidSize\":5,\"cuboidCount\":3,\"minCuboidSize\":7,\"measureDatasetName\":1},\"dimensions\":[{\"cuboidSize\":\"195.54 MB\",\"dimName\":\"Geography\",\"maxCuboidSize\":\"22.10 MB\",\"avgCuboidSize\":\"21.73 MB\",\"cuboidCount\":9,\"minCuboidSize\":\"21.30 MB\",\"measureDatasetName\":\"Product-Sales_Detail_50GB\"},{\"cuboidSize\":\"140.19 MB\",\"dimName\":\"Time\",\"maxCuboidSize\":\"17.68 MB\",\"avgCuboidSize\":\"17.52 MB\",\"cuboidCount\":8,\"minCuboidSize\":\"17.41 MB\",\"measureDatasetName\":\"Product-Sales_Detail_50GB\"},{\"cuboidSize\":\"6.70 MB\",\"dimName\":\"DCustomer-Detail\",\"maxCuboidSize\":\"3.35 MB\",\"avgCuboidSize\":\"3.35 MB\",\"cuboidCount\":2,\"minCuboidSize\":\"3.34 MB\",\"measureDatasetName\":\"Product-Sales_Detail_50GB\"},{\"cuboidSize\":\"17.61 KB\",\"dimName\":\"Product-Detail\",\"maxCuboidSize\":\"8.81 KB\",\"avgCuboidSize\":\"8.81 KB\",\"cuboidCount\":2,\"minCuboidSize\":\"8.80 KB\",\"measureDatasetName\":\"Product-Sales_Detail_50GB\"},{\"cuboidSize\":\"8.26 KB\",\"dimName\":\"tManufacturer\",\"maxCuboidSize\":\"4.17 KB\",\"avgCuboidSize\":\"4.13 KB\",\"cuboidCount\":2,\"minCuboidSize\":\"4.09 KB\",\"measureDatasetName\":\"Product-Sales_Detail_50GB\"}]}"
}
},
"TYPE": "CUBOID_DETAILS"
}
]
}
}
},
"BUILD_NO": 1,
"HISTORY_ID": "840C10B0-DC58-6C95-5C63-C02CC9FD4AC8",
"STATUS": "COMPLETED",
"BUILD_TYPE": "FULL_TEST",
"CURRENT_BUILD_STATUS": {"COMPLETED": {"PROBLEMS": {"PROBLEM": [{"MESSAGE": "The hierarchy or attribute names are either duplicate across dimensions or invalid. Following are the invalid entities:",
"PROBLEM_FUNCTIONAL_TYPE": "DEFAULT",
"CUBE_VIEW_TYPE": "PHYSICAL",
"TYPE": "WARNING",
"STACKTRACE": {"REASON": {"MESSAGE": "Hierarchy/Attribute Name:Hierarchy : (Dim Name: Geography, Type:hierarchy); (Dim Name: Time, Type:hierarchy); (Dim Name: tManufacturer, Type:hierarchy);",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "Hierarchy",
"OBJECT": "CURRENT",
"NAME": "Hierarchy"
}
}
},
{"MESSAGE": "Registered file Product-Sales_Detail_50GB contains some invalid entries.",
"PROBLEM_FUNCTIONAL_TYPE": "DEFAULT",
"OBJECTS": {"OBJECT": {"SUBTYPE": "REGISTERED",
"ID": "14078499836997127032066196431512",
"TYPE": "QUERY",
"NAME": "Product-Sales_Detail_50GB"
}
},
"TYPE": "WARNING",
"STACKTRACE": {"REASON": [{"MESSAGE": "Blank number values replaced to default for step Fetch :2",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Blank row for step Fetch :1",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Blank column value for step Fetch :1",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Blank date values replaced to default for step Fetch :0",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Mismatch data format for step Fetch :0",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Mismatch column size for step Fetch :0",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"MESSAGE": "Mismatch data type for step Fetch :0",
"ISEXISTS": true,
"ISENCODED": false,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
},
{"ISEXISTS": true,
"ISENCODED": true,
"ID": "14078499836990127090049155979996",
"OBJECT": "CURRENT",
"TYPE": "FETCH",
"NAME": "Fetch"
}
]
}
}
]
},
"CUBEBUILD_ELAPSED_TIME": 317974,
"IS_AGGREGATE_BUILD": false,
"SIZE": 500882823,
"TIMESTAMP": "08/28/2022 12:32:39",
"SECTIONS": {"SECTION": [{"MESSAGES": {"MESSAGE": [{"TYPE": "INFO",
"content": "<B>Dimensions</B>"
},
{"TYPE": "INFO",
"content": "Dimension: <B>Geography</B> (Member count: <B>51,304</B>, Metadata size: <B>47.2 MB</B>, Type: <B>Regular</B>)<BR>&nbsp;&nbsp;&nbsp;Hierarchy:&nbsp;<B>Hierarchy</B>(Member count: <B>51,304</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Continent</B> (Member count: <B>7</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Country</B> (Member count: <B>247</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>State</B> (Member count: <B>2,724</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>City</B> (Member count: <B>51,304</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Geography_Implicit_Level</B> (Member count: <B>51,304</B>)<BR>&nbsp;&nbsp;&nbsp;Attributes:&nbsp<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Attribute:&nbsp;<B>Region(Profit)%, : / \\ * | ? % $ ! + = {} < ></B> (Member count: <B>156</B>)<BR>"
},
{"TYPE": "INFO",
"content": "Dimension: <B>Time</B> (Member count: <B>1,703</B>, Metadata size: <B>52.4 MB</B>, Type: <B>Regular</B>)<BR>&nbsp;&nbsp;&nbsp;Hierarchy:&nbsp;<B>Hierarchy</B>(Member count: <B>1,703</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Year</B> (Member count: <B>6</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Quarter</B> (Member count: <B>20</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Month</B> (Member count: <B>57</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Week</B> (Member count: <B>276</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Day</B> (Member count: <B>1,703</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Date</B> (Member count: <B>1,703</B>)<BR>"
},
{"TYPE": "INFO",
"content": "Dimension: <B>DCustomer-Detail</B> (Member count: <B>795</B>, Metadata size: <B>18.9 MB</B>, Type: <B>Regular</B>)<BR>&nbsp;&nbsp;&nbsp;Hierarchy:&nbsp;<B>CustomerHierarchy</B>(Member count: <B>795</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Customer_Segment</B> (Member count: <B>4</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Customer_Name</B> (Member count: <B>795</B>)<BR>"
},
{"TYPE": "INFO",
"content": "Dimension: <B>Product-Detail</B> (Member count: <B>46</B>, Metadata size: <B>27.3 MB</B>, Type: <B>Regular</B>)<BR>&nbsp;&nbsp;&nbsp;Hierarchy:&nbsp;<B>Hierarchy(Profit)%, : / \\ * | ? % $ ! + = {} < ></B>(Member count: <B>46</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Product_Category(Profit)%, : / \\ * | ? % $ ! + = {} < ></B> (Member count: <B>3</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Product_Type(Profit)%, : / \\ * | ? % $ ! + = {} < ></B> (Member count: <B>10</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Product_Name</B> (Member count: <B>46</B>)<BR>"
},
{"TYPE": "INFO",
"content": "Dimension: <B>tManufacturer</B> (Member count: <B>21</B>, Metadata size: <B>8.4 MB</B>, Type: <B>Regular</B>)<BR>&nbsp;&nbsp;&nbsp;Hierarchy:&nbsp;<B>Hierarchy</B>(Member count: <B>21</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Level:&nbsp<B>Manufacturer</B> (Member count: <B>21</B>)<BR>"
},
{"TYPE": "INFO",
"content": "<B>Measure Datasets</B>"
},
{"TYPE": "INFO",
"content": "Measure dataset: <B> Product-Sales_Detail_50GB</B> (Rows processed: <B>1,814,808</B>, Rows skipped: <B>1</B>, Total file size: <B>402.91 MB</B>)<BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Shipping_Cost</B>,&nbsp;Function: <B>sum</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Discount</B>,&nbsp;Function: <B>average</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Product_Type_DC</B>,&nbsp;Function: <B>distinct count</B>,&nbsp;Accuracy Type:&nbsp;<B>Accurate</B>,&nbsp;Calculated on:&nbsp;<B>Product_Type</B>,&nbsp;Member count:&nbsp;<B>10</B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Product_ID</B>,&nbsp;Function: <B>count</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Order_Quantity</B>,&nbsp;Function: <B>count</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Region_DC</B>,&nbsp;Function: <B>distinct count</B>,&nbsp;Accuracy Type:&nbsp;<B>Accurate</B>,&nbsp;Calculated on:&nbsp;<B>Region</B>,&nbsp;Member count:&nbsp;<B>156</B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>(Profit)%, : / \\ * | ? % $ ! + = {} < ></B>,&nbsp;Function: <B>sum</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Sale_Amount</B>,&nbsp;Function: <B>sum</B></B><BR>&nbsp;&nbsp;&nbsp;&nbsp;Measure:&nbsp;<B>Row Count - Product-Sales_Detail_50GB - SYSTEM MEASURE</B>,&nbsp;Function: <B>count</B></B>"
}
]
},
"TYPE": "PHYSICAL_VIEW"
},
{"MESSAGES": {"MESSAGE": [{"TYPE": "INFO",
"content": "Measure dataset: <B> Product-Sales_Detail_50GB</B>"
},
{"TYPE": "INFO",
"content": "&nbsp;&nbsp;&nbsp;<B>Design:</B>\t\t\tPartition column: <B>None</B>\tBase partition range size: <B>None</B>"
}
]
},
"TYPE": "PARTITION_STRATEGY"
},
{"MESSAGES": {"MESSAGE": {"TYPE": "INFO",
"content": "\n\t\t\t\t\t<P>Modified Properties:<BR>&nbsp;&nbsp;&nbsp;kyvos.mdx.minifyUniqueName.hierarchyDepth :&nbsp<B>100</B><BR>&nbsp;&nbsp;&nbsp;kyvos.query.cuboidcache.strategy :&nbsp<B>Full</B><BR>&nbsp;&nbsp;&nbsp;kyvos.query.resultcache.strategy :&nbsp<B>None</B><BR>&nbsp;&nbsp;&nbsp;kyvos.sync.rows.mismatchcolumns :&nbsp<B>True</B><BR>&nbsp;&nbsp;&nbsp;kyvos.query.unrelateddim.ignore :&nbsp<B>True</B><BR>&nbsp;&nbsp;&nbsp;kyvos.query.cuboid.cache.minDims :&nbsp<B>0</B><BR>&nbsp;&nbsp;&nbsp;kyvos.extended.logging :&nbsp<B>true</B><BR>&nbsp;&nbsp;&nbsp;kyvos.query.cuboidcache.compression :&nbsp<B>True</B><BR>&nbsp;&nbsp;&nbsp;kyvos.query.nonrelatedfact.ignore :&nbsp<B>true</B><BR>&nbsp;&nbsp;&nbsp;kyvos.cuboid.replication.type :&nbsp<B>None</B><BR>&nbsp;&nbsp;&nbsp;kyvos.query.cuboidcache.tier :&nbsp<B>Disk Backed Off-Heap</B><BR>&nbsp;&nbsp;&nbsp;kyvos.mdx.multidimensional.optimize :&nbsp<B>True</B></P>\n\t\t\t\t\t<BR><P>Inherited Properties:<BR>&nbsp;&nbsp;&nbsp;spark.driver.memory :&nbsp<B>8g</B><BR>&nbsp;&nbsp;&nbsp;spark.dynamicAllocation.minExecutors :&nbsp<B>0</B><BR>&nbsp;&nbsp;&nbsp;kyvos.build.execution.engine :&nbsp<B>Spark</B><BR>&nbsp;&nbsp;&nbsp;spark.executor.cores :&nbsp<B>4</B><BR>&nbsp;&nbsp;&nbsp;spark.yarn.executor.memoryOverhead :&nbsp<B>6144</B><BR>&nbsp;&nbsp;&nbsp;kyvos.number.blank.default :&nbsp<B>0</B><BR>&nbsp;&nbsp;&nbsp;spark.executor.memory :&nbsp<B>20g</B><BR>&nbsp;&nbsp;&nbsp;spark.dynamicAllocation.maxExecutors :&nbsp<B>100</B></P>\n\t\t\t\t\t<BR><P>Default Properties:<BR>&nbsp;&nbsp;&nbsp;kyvos.build.clustering.maxlength :&nbsp<B>4</B><BR>&nbsp;&nbsp;&nbsp;kyvos.build.speculative.enabled :&nbsp<B>False</B><BR>&nbsp;&nbsp;&nbsp;kyvos.build.aggregate.storage.optimized :&nbsp<B>False</B><BR>&nbsp;&nbsp;&nbsp;kyvos.dim.shared.member.identifier :&nbsp<B>~</B><BR>&nbsp;&nbsp;&nbsp;kyvos.split.combination :&nbsp<B>False</B><BR>&nbsp;&nbsp;&nbsp;kyvos.build.aggregation.persistSummary :&nbsp<B>True</B><BR>&nbsp;&nbsp;&nbsp;kyvos.build.dimension.hop :&nbsp<B>0:2,2:4,4:6,6:8,8:10,10:12,12:14,14:16,16:18,1:3,3:5,5:7,7:9,9:11,11:13,13:15,15:17,17:19</B><BR>&nbsp;&nbsp;&nbsp;kyvos.build.sample.percent :&nbsp<B>0.01</B><BR>&nbsp;&nbsp;&nbsp;kyvos.cuboid.clustering.blocksize :&nbsp<B>524288</B><BR>&nbsp;&nbsp;&nbsp;kyvos.build.blankvalue.badrow :&nbsp<B>True</B></P>\n\t\t\t\t\t\t"
}
},
"TYPE": "ADVANCED_PROPERTIES"
},
{"MESSAGES": {"MESSAGE": {"TYPE": "INFO",
"content": "Aggregation Strategy :<B> Expert mode </B><BR>&nbsp;&nbsp;&nbsp;Selective hierarchy materialization :<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[tManufacturer].[Hierarchy]:Manufacturer<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Geography].[Hierarchy]:Geography_Implicit_Level<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[DCustomer-Detail].[CustomerHierarchy]:Customer_Name<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Product-Detail].[Hierarchy(Profit)%, : / \\ * | ? % $ ! + = {} < >]:Product_Name<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;[Time].[Hierarchy]:Date<BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"
}
},
"TYPE": "AGGREGATION_STRATEGY"
},
{"MESSAGES": {"MESSAGE": [{"TYPE": "INFO",
"content": "Cube metadata size: <B>158.43 MB</B>"
},
{"TYPE": "INFO",
"content": "Server Version: <B>2022.3 R9_2022.3_dev-08280030</B>"
},
{"TYPE": "INFO",
"content": "Connection Name: <B>DefaultHadoopCluster01</B>"
},
{"TYPE": "INFO",
"content": "Cube Compatibility Version: <B>1</B>"
},
{"TYPE": "INFO",
"content": "<BR><B>Test build details:</B><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Last fact partitions processed:&nbsp<B>3</B><BR>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Minimal aggregation:&nbsp<B>true</B>"
}
]
},
"TYPE": "MISCELLANEOUS"
},
{"MESSAGES": {"MESSAGE": {"TYPE": "INFO",
"content": "{\"total\":{\"cuboidSize\":\"342.45 MB\",\"maxCuboidSize\":\"22.10 MB\",\"avgCuboidSize\":\"14.89 MB\",\"cuboidCount\":23,\"minCuboidSize\":\"4.09 KB\"},\"colOrder\":{\"cuboidSize\":4,\"dimName\":2,\"maxCuboidSize\":6,\"avgCuboidSize\":5,\"cuboidCount\":3,\"minCuboidSize\":7,\"measureDatasetName\":1},\"dimensions\":[{\"cuboidSize\":\"195.54 MB\",\"dimName\":\"Geography\",\"maxCuboidSize\":\"22.10 MB\",\"avgCuboidSize\":\"21.73 MB\",\"cuboidCount\":9,\"minCuboidSize\":\"21.30 MB\",\"measureDatasetName\":\"Product-Sales_Detail_50GB\"},{\"cuboidSize\":\"140.19 MB\",\"dimName\":\"Time\",\"maxCuboidSize\":\"17.68 MB\",\"avgCuboidSize\":\"17.52 MB\",\"cuboidCount\":8,\"minCuboidSize\":\"17.41 MB\",\"measureDatasetName\":\"Product-Sales_Detail_50GB\"},{\"cuboidSize\":\"6.70 MB\",\"dimName\":\"DCustomer-Detail\",\"maxCuboidSize\":\"3.35 MB\",\"avgCuboidSize\":\"3.35 MB\",\"cuboidCount\":2,\"minCuboidSize\":\"3.34 MB\",\"measureDatasetName\":\"Product-Sales_Detail_50GB\"},{\"cuboidSize\":\"17.61 KB\",\"dimName\":\"Product-Detail\",\"maxCuboidSize\":\"8.81 KB\",\"avgCuboidSize\":\"8.81 KB\",\"cuboidCount\":2,\"minCuboidSize\":\"8.80 KB\",\"measureDatasetName\":\"Product-Sales_Detail_50GB\"},{\"cuboidSize\":\"8.26 KB\",\"dimName\":\"tManufacturer\",\"maxCuboidSize\":\"4.17 KB\",\"avgCuboidSize\":\"4.13 KB\",\"cuboidCount\":2,\"minCuboidSize\":\"4.09 KB\",\"measureDatasetName\":\"Product-Sales_Detail_50GB\"}]}"
}
},
"TYPE": "CUBOID_DETAILS"
},
{"MESSAGES": "",
"TYPE": "BUILD_INPUTS"
},
{"MESSAGES": "",
"TYPE": "TIME_INFO"
}
]
},
"BUILD_STATUS": "SUCCESSFUL"
}
},
"SUB_TYPE": "CUBE",
"TYPE": "ANALYTICAL",
"INSTANCE_ID": "D9639F71-E256-3CD7-3803-67C5D3A61DD8"
}
}
}
}

Cancel Build Deprecated

This API is used to cancel build jobs on the cube.

Note: This API has been deprecated. Please refer alternate API /smodels/cancelJob.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeId	string Id of the cube of which you want to get the object. If you do not know the cubeId, use the cubeName and folderName/folderId.
cubeName	string Name of the cube of which you want to get the object
folderName	string Folder name of the cube of which you want to get the object.
folderId	string Folder id of the cube of which you want to get the object.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Cancel build success.",
"CODE": 0
}

Resume Cube Build Deprecated

This API is used to resume cube build if any resumable failed.

Note: This API has been deprecated. Please refer alternate API /smodels/resumeJob.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeId	string Id of the cube of which you want to get the object. If you do not know the cubeId, use the cubeName and folderName/folderId.
cubeName	string Name of the cube of which you want to get the object
folderName	string Folder name of the cube of which you want to get the object.
folderId	string Folder id of the cube of which you want to get the object.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully resumed Cube build.",
"CODE": 0
}

Add and Update Calculated Measures Deprecated

This API is used to add/update calculated measures in a cube. The API will only add/update calculated measures. If the measure is not calculated, then any update in that measure will be ignored.

Note: This API has been deprecated. Please refer alternate API /smodels/addUpdateCalculatedMeasures.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeId	string Id of the cube object. Either cubeId or cubeName is mandatory to get the cube object.
cubeName	string Name of CubeObject.
folderName	string Folder name from which you want to get Cube Objects.
folderId	string Folder id of the cube of which you want to get the object

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

measureJSON	object A JSON string containing the name of the measure as key and expression as value. for e.g. { "measureName1": { "expression": "expression1" }, "measureName2": { "expression": "expression2" } }
groupName	string Name of the measure group in which you want to add or update a calcualted measure.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully replaced cube object: Untitled Cube 1",
"CODE": 0
}

Add and Update Calculated Members Deprecated

This API is used to add/update calculated measures in a cube. The API will only add/update calculated measures. If the measure is not calculated, then any update in that measure will be ignored.

Note: This API has been deprecated. Please refer alternate API /smodels/addUpdateCalculatedMembers.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeId	string Id of the cube object. Either cubeId or cubeName is mandatory to get the cube object.
cubeName	string Name of CubeObject.
folderName	string Folder name from which you want to get Cube Objects.
folderId	string Folder id of the cube of which you want to get the object

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

memberJSON	string A JSON string containing the name of the calculated member as a key and another JSON object containing other required information including a description key for providing details of the calculated member. The value for the description key should be String with a character limit of 200. Structure of member JSON: { "memberName1": { "dimensionName": "", "type": "Type can be HIERARCHY or ATTRIBUTE", "hierarchyName": "Needed in case of type=HIERARCHY and having multiple hierarchies", "attributeName": "Needed when type is ATTRIBUTE", "parentMember": "Not needed in case of ALLMEMBER. Should be in the form of [Level name].fully qualified name", "expression": "", "solveOrder": "", "description": "Description for memberName1" } }
validate	boolean Default: false Enum: true false A Boolean flag, whether to validate member expression OR not. Note: Expressions will only be validated if the cube is built.
save	boolean Default: false Enum: true false A Boolean flag, whether to validate member expression OR not

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully replaced cube object: Untitled Cube 1",
"CODE": 0
}

Get Aggregates Deprecated

This API is used to get aggregates XML with respect to the cube entity.

Note: This API has been deprecated. Please refer alternate API /smodels/getAggregates.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeId	string Id of the cube object. Either cubeId or cubeName is mandatory to get the cube object
cubeName	string Name of the cube of which you want to get the object
folderName	string Folder name of the cube of which you want to get the object.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/xml

<RESPONSE>
    <ENTITIES>
    <ENTITY ID="16027542124359127032012146854717" SUB_TYPE="CUBE" TYPE="ANALYTICAL">
        <AGGREGATION_STRATEGY TYPE="QUERY_DRIVEN">
            <QUERY_DRIVEN>
                <AGGREGATES_DEF_ID>
                    <![CDATA[16028500517512AGGREGATION235746]]>
                </AGGREGATES_DEF_ID>
                <AGGREGATES_COUNT>
                    <![CDATA[14]]>
                </AGGREGATES_COUNT>
                <LAST_ACCEPTED_TIME>
                    <![CDATA[10/16/2020 05:07:52]]>
                </LAST_ACCEPTED_TIME>
            </QUERY_DRIVEN>
        </AGGREGATION_STRATEGY>
        <AGGREGATE_INFOS>
            <AGGREGATE_INFO>
                <![CDATA[{"AGGREGATE_ID":"16038722479529AGGREGATION351759","AGGREGATION_SUMMARY":"{\"ORDERED_DIMS\":{\"15821179570596127084040176656597\":\"DIM_698~DIM_175~DIM_240~DIM_266~DIM_291~DIM_490~DIM_502~DIM_188~DIM_527~DIM_303~DIM_342~DIM_358\",\"15821168436916127054085189816798\":\"DIM_621~DIM_175~DIM_240~DIM_266~DIM_291~DIM_188~DIM_303~DIM_342~DIM_358\",\"15821163182138127072036116411602\":\"DIM_240~DIM_303~DIM_458\",\"15821167288096127053016188722790\":\"DIM_240~DIM_815~DIM_763~DIM_906~DIM_945\",\"15821172402147127077045148224334\":\"DIM_606~DIM_240~DIM_266~DIM_291~DIM_490~DIM_502~DIM_188~DIM_527~DIM_303~DIM_342~DIM_358\"},\"AGGREGATES_COUNT\":\"14\",\"ORIENTATION_INFO\":\"1\",\"AGGREGATES\":[{\"15821179570596127084040176656597\":{\"DIM_240\":[{\"DIMENSIONS\":[{\"DIMENSION\":{\"FIELDS\":[{\"LEVEL\":{\"UNIQUE_NAME\":\"DIM_188_Implicit_Level\",\"NAME\":\"Product_Implicit_Level\"}}],\"UNIQUE_NAME\":\"DIM_188\",\"NAME\":\"Product{\"MEASURE\":{\"UNIQUE_NAME\":\"MEASURE_1472\",\"NAME\":\"Extended AmountD\"}},{\"MEASURE\":{\"UNIQUE_NAME\":\"MEASURE_1473\",\"NAME\":\"Standard Product CostD\"}},{\"MEASURE\":{\"UNIQUE_NAME\":\"MEASURE_1474\",\"NAME\":\"Total Product CostD\"}},{\"MEASURE\":{\"UNIQUE_NAME\":\"MEASURE_1475\",\"NAME\":\"Sales AmountD\"}},{\"MEASURE\":{\"UNIQUE_NAME\":\"MEASURE_1476\",\"NAME\":\"Tax AmountD\"}},{\"MEASURE\":{\"UNIQUE_NAME\":\"MEASURE_1477\",\"NAME\":\"Freight CostD\"}},{\"MEASURE\":{\"UNIQUE_NAME\":\"MEASURE_1478\",\"NAME\":\"Transaction Cost\"}},{\"MEASURE\":{\"UNIQUE_NAME\":\"MEASURE_3767\",\"NAME\":\"Order Count\"}}],\"UNIQUE_NAME\":\"MEASURE\",\"NAME\":\"MEASURE\"}},\"AGGREGATE_STATUS\":\"Not Modified\",\"ID\":-2077199616}],\"DIM_175\":[{\"DIMENSIONS\":[{\"DIMENSION\":{\"FIELDS\":[{\"LEVEL\":{\"UNIQUE_NAME\":\"DIMENSION_LEVEL_648\",\"NAME\":\"Country\"}}],\"UNIQUE_NAME\":\"DIM_175\",\"NAME\":\"Customer\"}},{\"DIMENSION\":{\"FIELDS\":[{\"LEVEL\":{\"UNIQUE_NAME\":\"DIM_240_ALL\",\"NAME\":\"Date_ALL\"}},{\"LEVEL\":{\"UNIQUE_NAME\":\"DIM_240_Implicit_Level\",\"NAME\":\"Date_ATTR_]}}]}"}]]>
            </AGGREGATE_INFO>
    </AGGREGATE_INFOS>
    </ENTITY>
    </ENTITIES>
</RESPONSE>

Save Aggregates Deprecated

This API is used to save aggregates info with the given cube entity. As this API performs bulk operation, you must have privileges to import and export objects to use this API.

Note: This API has been deprecated. Please refer alternate API /smodels/saveAggregates.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

aggregatesXML

required

object

Aggregates information to be saved.

For e.g.

      <ENTITY ID="16027542124359127032012146854717" SUB_TYPE="CUBE" TYPE="ANALYTICAL">

          <AGGREGATION_STRATEGY TYPE="QUERY_DRIVEN">

              <QUERY_DRIVEN>

                  <AGGREGATES_DEF_ID>

                      <![CDATA[16028500517512AGGREGATION235746]]>

                  </AGGREGATES_DEF_ID>

                  <AGGREGATES_COUNT>

                      <![CDATA[14]]>

                  </AGGREGATES_COUNT>

                  <LAST_ACCEPTED_TIME>

                      <![CDATA[10/16/2020 05:07:52]]>

                  </LAST_ACCEPTED_TIME>

              </QUERY_DRIVEN>

          </AGGREGATION_STRATEGY>

          <AGGREGATE_INFOS>

              <AGGREGATE_INFO>

                  <![CDATA[{"AGGREGATE_ID":"16038722479529AGGREGATION351759","AGGREGATION_SUMMARY":"{"ORDERED_DIMS":{"15821179570596127084040176656597":"DIM_698DIM_175DIM_240DIM_266DIM_291DIM_490DIM_502DIM_188DIM_527DIM_303DIM_342DIM_358","15821168436916127054085189816798":"DIM_621DIM_175DIM_240DIM_266DIM_291DIM_188DIM_303DIM_342DIM_358","15821163182138127072036116411602":"DIM_240DIM_303DIM_458","15821167288096127053016188722790":"DIM_240DIM_815DIM_763DIM_906DIM_945","15821172402147127077045148224334":"DIM_606DIM_240DIM_266DIM_291DIM_490DIM_502DIM_188DIM_527DIM_303DIM_342~DIM_358"},"AGGREGATES_COUNT":"14","ORIENTATION_INFO":"1","AGGREGATES":[{"15821179570596127084040176656597":{"DIM_240":[{"DIMENSIONS":[{"DIMENSION":{"FIELDS":[{"LEVEL":{"UNIQUE_NAME":"DIM_188_Implicit_Level","NAME":"Product_Implicit_Level"}}],"UNIQUE_NAME":"DIM_188","NAME":"Product{"MEASURE":{"UNIQUE_NAME":"MEASURE_1472","NAME":"Extended AmountD"}},{"MEASURE":{"UNIQUE_NAME":"MEASURE_1473","NAME":"Standard Product CostD"}},{"MEASURE":{"UNIQUE_NAME":"MEASURE_1474","NAME":"Total Product CostD"}},{"MEASURE":{"UNIQUE_NAME":"MEASURE_1475","NAME":"Sales AmountD"}},{"MEASURE":{"UNIQUE_NAME":"MEASURE_1476","NAME":"Tax AmountD"}},{"MEASURE":{"UNIQUE_NAME":"MEASURE_1477","NAME":"Freight CostD"}},{"MEASURE":{"UNIQUE_NAME":"MEASURE_1478","NAME":"Transaction Cost"}},{"MEASURE":{"UNIQUE_NAME":"MEASURE_3767","NAME":"Order Count"}}],"UNIQUE_NAME":"MEASURE","NAME":"MEASURE"}},"AGGREGATE_STATUS":"Not Modified","ID":-2077199616}],"DIM_175":[{"DIMENSIONS":[{"DIMENSION":{"FIELDS":[{"LEVEL":{"UNIQUE_NAME":"DIMENSION_LEVEL_648","NAME":"Country"}}],"UNIQUE_NAME":"DIM_175","NAME":"Customer"}},{"DIMENSION":{"FIELDS":[{"LEVEL":{"UNIQUE_NAME":"DIM_240_ALL","NAME":"Date_ALL"}},{"LEVEL":{"UNIQUE_NAME":"DIM_240_Implicit_Level","NAME":"Date_ATTR_]}}]}"}]]>

              </AGGREGATE_INFO>

          </AGGREGATE_INFOS>

      </ENTITY>

Responses

Get Cube Advanced Properties Deprecated

This API is used to get Cube Advanced Properties.

Note: This API has been deprecated. Please refer alternate API /smodels/properties.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeId	string Id of the cube of which you want to get the object. If you do not know the cubeId, use the cubeName and folderName/folderId.
cubeName	string Name of the cube of which you want to get the object
folderName	string Name of the folder from which you want to get the cube. if the cube is present on the root directory, give the folder name as [Root]
folderId	string Folder id of the cube of which you want to get the object.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"RESPONSE": {"PROPERTIES": ""
}
}

Update Cube Advanced Properties Deprecated

This API is used to update cube advanced properties.

Note: This API has been deprecated. Please refer alternate API /smodels/properties.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeId	string Id of the cube of which you want to get the object. If you do not know the cubeId, use the cubeName and folderName/folderId.
cubeName	string Name of the cube of which you want to get the object
folderName	string Name of the folder from which you want to get the cube. if the cube is present on the root directory, give the folder name as [Root]
folderId	string Folder id of the cube of which you want to get the object.

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

propertyJSON

required

object

propertyJSON should be a valid JSON array having objects with name and value. "name" is the property name and "value" is property value.

for e.g.

 [
  {
    "name": "kyvos.build.precompute.hierarchy.levels",
    "value": "Kyvos_GIS_UpToZip.H_Kyvos_GIS_UpToZip"
  }
]

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully updated entity level properties",
"CODE": 0
}

Update properties of Cube Deprecated

This API is used to update one or more properties of the cube. For example DESCRIPTION property, TAGS property etc.
Note - User should provide either "cubeId" or "cubeName" and "folderName" details.

Note: This API has been deprecated. Please refer alternate API /smodels/entityProperties.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

cubeId	string Id of the cube for which you want to update properties. If you do not know the cube id, use the cube name and folder name.
cubeName	string Name of the cube for which you want to update properties.
folderName	string Folder name of the cube for which you want to update properties.
propertyJSON required	object JSON containing an array of property name and their values. For e.g. [ { "name": "DESCRIPTION", "value": "description" }, { "name": "TAGS" "value": "tag" } ]

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully updated properties of the cube.",
"CODE": 0
}

Get Cache Population Rules Deprecated

This API is used to get cache population rules XML with respect to the cube entity.

Note: This API has been deprecated. Please refer alternate API /smodels/getCachePopulationRules.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeId	string Id of the cube object. Either cubeId or cubeName is mandatory to get the cube object
cubeName	string Name of the cube of which you want to get the object
folderName	string Name of the folder from which you want to get the cube. if the cube is present on the root directory, give the folder name as [Root]

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/xml

<RESPONSE>
  <ENTITIES>
          <ENTITY ID="15639500788366127066047191013171" SUBTYPE="CUBE" TYPE="ANALYTICAL">
      <RULES>
      <RULE CACHE_ACTION="REPOPULATE_CACHE" CACHE_ON_CUBE_REBUILD="NONE" ID="16037484241013123417809" PRECAHE_SQL_CASCADING_FILTERS="YES" TYPE="HISTORICAL">
  <FILTERS MAXROWS="">
  </FILTERS></RULE>
  </RULES>
  </ENTITY>
  </ENTITIES>
</RESPONSE>

Save Cache Population Rules Deprecated

This API is used to save aggregates info with the given cube entity. As this API performs bulk operation, you must have privileges to import and export objects to use this API.

Note: This API has been deprecated. Please refer alternate API /smodels/saveCachePopulationRules.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

cachePopulationRuleXML

required

string

Cache Population information to be saved.
For e.g.

 <ENTITY ID="15639500788366127066047191013171" SUBTYPE="CUBE" TYPE="ANALYTICAL">

              <RULES>

                  <RULE CACHE_ACTION="REPOPULATE_CACHE" CACHE_ON_CUBE_REBUILD="NONE" ID="16037484241013123417809" PRECAHE_SQL_CASCADING_FILTERS="YES" TYPE="HISTORICAL">

                      <FILTERS MAXROWS=""></FILTERS>

                  </RULE>

              </RULES>

          </ENTITY>

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Successfully updated rules",
"CODE": 0
}

Save Recommendations Deprecated

This API is used to save recommendations on the same cube or generate a new copy of it.

Note: This API has been deprecated. Please refer alternate API /smodels/applyRecommendations.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeId	string Cube id on which need to apply recommendation
cubeName	string Cube name on which need to apply recommendation
folderId	string Folder id on which need to apply recommendation
folderName	string Folder name on which need to apply recommendation

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

materializationLevel	string Enum: "high" "medium" "low" High Materialization level will create more aggregates giving better query performance, but it increases cube build size. Low materialization will create less aggregates, resulting in reduced cube build size, but all queries may not perform fast. Possible Values: `high` `medium` `low`
recommendationType	string Enum: "completeDesign" "onlyAggregationStrategy" "onlyAdditionalAgreegates (Aggregatoin Strategy = Smart)" "onlyPhysicalView" "onlyPartitionStrategy" The type of recommendation. Possible values: `completeDesign`: Complete cube design will be recommended and updated (Physical view, Partition strategy & Aggregation strategy) `onlyAggregationStrategy`: Only Aggregation strategy will be recommended and updated. `onlyAdditionalAgreegates`: Only additional aggregates will be recommended and updated, only applicable in smart mode. `onlyPhysicalView`: Only Physical View will be recommended and updated. `onlyPartitionStrategy`: Only Partition Strategy will be recommended and updated.
aggregation Strategy	string Need to take recommendation either in Expert or smart mode
createCopy	boolean Enum: true false True if need to create new cube, false if need to apply recommendation on same cube
queryFilters	object Pass the following input in json format. For e.g. { "QueryDays": "10", "queryTimeThreshold": "245", "selectedUsers": "ankit,ashish", "IncludeAdditionalQueries": "true" }

Responses

Get Partition Strategy Deprecated

This API is used to get fact wise partition strategy for a cube.

Note: This API has been deprecated. Please refer alternate API /smodels/partitionStrategy.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeId	string Id of the cube object. Either cubeId or cubeName is mandatory to get the cube object
cubeName	string Name of the cube of which you want to get the object
folderName	string Name of the folder from which you want to get the cube. if the cube is present on the root directory, give the folder name as [Root]

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"14823984009460127044035111861522": {"partitionStrategy": [{"name": "date",
"id": "DIM_230166!!!H_678469!!!DIMENSION_LEVEL_314482",
"type": "LEVEL",
"isBasePartition": "true"
}
],
"name": "fact"
}
}

Execute Data Profiling on Cube Deprecated

This API is used to execute data profiling job for the cube.

Note: This API has been deprecated. Please refer alternate API /smodels/dataProfile.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeId	string Id of the cube of which you want to get the object
cubeName	string Name of the cube of which you want to get the object
folderName	string Folder name of the cube of which you want to get the object
folderId	string Folder id of the cube of which you want to get the object

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

runType	string Default: "NOW" Enum: "NOW" "ONCE" Job frequency to run (NOW/ONCE) Default Value: NOW Now: This will immediately start the job Once: Job will run at the specified time
onceDateTime	string Date time in format (09/20/2014 17:25) Required when runType is ONCE
userParams	string The parameters info which is to be used in cube data profiling. Value in JSON should be passed. Example: [ { "name": "parameterName", "value": "parameterValue" } ]
buildConnectionName	string Name of build Connection
dataProfileJson	object Data profile settings in string formatted JSON object. { "samplingOptions": "SAMPLE/ALL", "fieldsGroup": "COMPLETE / ALLDIMENSIONS /CUSTOM", "fields": [ { "fieldId": "id of element", "fieldType": "DIMENSION/LEVEL/ATTRIBUTE/MEASURE/MEASURE_GROUP", "displayName": "name of element", "parentName": "display name of parent element required for Levels,attributes & measures" } ] }

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Data profile job added successfully.",
"CODE": 0
}

Get Job Execution Status Deprecated

This API is used to get job execution status for the cube.

Note: This API has been deprecated. Please refer alternate API /smodels/jobExecutionStatus.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeId	string Id of the cube of which you want to get the object
cubeName	string Name of the cube of which you want to get the object
folderName	string Folder name of the cube of which you want to get the object
folderId	string Folder id of the cube of which you want to get the object

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"DATA": {"INQUEUEJOBS": "",
"JOBEXECUTIONSTATUS": {"UPCOMINGJOBS": "",
"HISTORY": {"HISTORYITEM": {"HISTORY_ID": "7897EF85-9600-9943-2FA5-A3E2D9EB058C",
"IS_IDEAL_BUILD": false,
"STATUS": "SUCCESSFUL",
"FREQUENCY_TYPE": "ONCE",
"SCHEDULED_TIME": "05/04/2022 11:39:10",
"RUNTIME": "05/04/2022 11:40:12",
"BUILD_TYPE": "DATA_PROFILE",
"USER_NAME": "user 1"
}
}
}
}
}

Get Dataset List Deprecated

This API is used to get JSON list of all the data sets currently used in cube design.

Note: This API has been deprecated. Please refer alternate API /smodels/datasetNames.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeId	string Id of the cube of which you want to get the object
cubeName	string Name of the cube of which you want to get the object
folderName	string Folder name of the cube of which you want to get the object
folderId	string Folder id of the cube of which you want to get the object
datasetType	string Enum: "ALL_DATASETS" "ALL_FACT_DATASETS" "PARTITIONED_FACT_DATASETS" "ALL_DIMENSION_DATASETS" Additional filter to get filtered list. `ALL_DATASETS`: Datasets which are used in the cube for creating dimensions or measures `ALL_DIMENSION_DATASETS`: Datasets which are used in the cube for creating dimensions. `ALL_FACT_DATASETS`: Datasets which are used in the cube for creating measures `PARTITIONED_FACT_DATASETS`: Datasets which are used in the cube for creating measures and are related with the dimension which is used to create base partition in cube (Partition Strategy)

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

[{"name": "Product-Sales_Detail_50GB",
"id": "14078499836997127032066196431512",
"type": "FACT"
}
]

Get Scripts Deprecated

This API is used to get all the scripts currently saved in cube.

Note: This API has been deprecated. Please refer alternate API /smodels/scripts.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeId	string Id of the cube of which you want to get the object
cubeName	string Name of the cube of which you want to get the object
folderName	string Folder name of the cube of which you want to get the object
folderId	string Folder id of the cube of which you want to get the object

header Parameters

Accept required	string Example: application/json Supported response types are JSON. Possible values: application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

[{"expression": "SCOPE(subcube_expression1); \n\t This = [Mdx_statement]; \nEND SCOPE;",
"name": "DEFAULT_SCRIPT",
"disabled": false
}
]

Add/Update Scripts Deprecated

This API is used to add or update the script in cube.

Note: This API has been deprecated. Please refer alternate API /smodels/scripts.

Authorizations:

sessionIdbasicAuth

query Parameters

cubeId	string Id of the cube of which you want to get the object
cubeName	string Name of the cube of which you want to get the object
folderName	string Folder name of the cube of which you want to get the object
folderId	string Folder id of the cube of which you want to get the object

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

scripts

object

The script info which is to be added in cube
For example:

 [
   {
     "expression": "SCOPE(subcube_expression1); \n\t This = [Mdx_statement]; \nEND SCOPE;",
     "name": "DEFAULT_SCRIPT",
     "disabled": false
   }
 ]

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Script added/updated successfully",
"CODE": 0
}

Delete Script Deprecated

This API is used to delete an existing script in cube.

Note: This API has been deprecated. Please refer alternate API /smodels/scripts/{scriptName}.

Authorizations:

sessionIdbasicAuth

path Parameters

scriptName

required

string

Example: DEFAULT_SCRIPT

Name of script to be deleted.

query Parameters

cubeId	string Id of the cube of which you want to get the object
cubeName	string Name of the cube of which you want to get the object
folderName	string Folder name of the cube of which you want to get the object
folderId	string Folder id of the cube of which you want to get the object

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON. Possible values: application/json
sessionid	string The session Id is the token received from the login API. Note: Session Id is required for Token-based Authentication.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Script deleted successfully",
"CODE": 0
}

Copy Cube Deprecated

This API is used to copy the cube in the desired destination folder.
Note - User should provide either "sourceCubeId" or "sourceCubeName" and "sourceFolderName" details.

Note: This API has been deprecated. Please refer alternate API /smodels/copy.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Value: "application/XML" Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

sourceCubeId	string Id of the cube for which you want to create a copy. If you do not know the cube id, use the cube name and folder name.
sourceCubeName	string Name of the cube for which you want to create a copy.
sourceFolderName	string Folder name of the cube for which you want to create a copy.
targetCubeName required	string Name of the target cube that you want to create.
targetFolderId	string Target folder id where you want to create the copy.
targetFolderName	string Target folder name where you want to create the copy.
copyLinkedData	boolean Default: false Enum: true false A flag to indicate whether the historical queries of the source cube should be linked to the new cube or not.

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Cube copied successfully.",
"CODE": 0
}

Validate Cube Deprecated

This API is used for cube validation.

Note: This API has been deprecated. Please refer alternate API /smodels/validate.

Authorizations:

sessionIdbasicAuth

header Parameters

Accept required	string Example: application/XML Supported response types are JSON or XML. Possible values: application/xml or application/json
Content-Type required	string Value: "application/x-www-form-urlencoded" Example: application/x-www-form-urlencoded The media type of the body of the request Value: 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 schema: application/x-www-form-urlencoded

cubeId	string Id of cube which you wants to be validated. If cubeId isn't available, use cubeName and folderName.
cubeName	string Name of the cube which you wants to get validated.
folderName	string Name of the folder from which you want to validate cube.
propertiesXML	string Properties XML if needs to be validated along with cube.
buildType	string Type of build validations are required (Valid values: "UPDATE_AGGREGATES"/"INCREMENTAL")
incrementalType	string Type of incremental build validations are triggered for (Valid value: "FACT_ADJUSTMENTS")
validateDependentEntities	string If dependent entities are to be validated (Valid values: true/false)
validationType	string Only cube design or design with it's impact on subsequent build needs to be validated (Valid value: DESIGN_SUBSEQUENT_BUILD)
cubeViewType	string If validating only physical view of cube (Valid value: "PHYSICAL")

Responses

Response samples

200

Content type

application/json

{"MESSAGE": "Cube validated successfully",
"CODE": 200,
"VALIDATION_STATUS": "VALID"
}