API Documentation

List of Sections

Tekizma Reporting API Documentation

GET `/getClientsList`

Description: Retrieves a list of all clients.

Response:

[
    {
        "client_id": 1,
        "id": 13,
        "company_name": "tekizma"
    }
]

Example Request:

GET /getClientsList

POST `/getClientsOfClient`

Description: Returns a paginated list of clients for a given parent client, optionally filtered by a search term.

Field	Type	Required	Description
filterValue	string	No	Optional search or filter value
x-client-id	string (header)	Yes	Parent Client ID

Response:

{
    "data": [
        {
            "client_id": 25,
            "company_name": "SchoolA"
        },
        {
            "client_id": 1,
            "company_name": "tekizma"
        }
    ],
    "totalRecords": 2
}

Error Codes:

Code	Message
DNX_ADM_024	Missing clientId

Example Request:

POST /getClientsOfClient
Content-Type: application/json
x-client-id: "1"
{
    "pageNo":1,
    "pageSize":10,
    "filterValue":"h"
}

Example Error Request:

POST /getClientsOfClient
Content-Type: application/json
x-client-id: ""
{
    "pageNo": "1",
    "pageSize": 10,
    "filterValue":"h"
}

Example Error Response:

{
    "error": true,
    "code": "DNX_ADM_024",
    "message": "Missing clientId"
}

POST `/creatingUser`

Description: Creates a new user with the specified details, handling validation, role assignment, domain and client context. Supports standalone and integrated login types.

Param	Type	Required	Description
registerUserDetails	object	Yes	User registration details including username, email, name, roles, domain, and other optional fields.

registerUserDetails Object Fields:

Field	Type	Required	Description
userName	string	Yes	Username for the new user
email	string	Yes	Email address
firstName	string	Yes	User’s first name
middleName	string	No	User’s middle name
lastName	string	No	User’s last name
dob	string (date)	No	Date of birth (validated)
companyName	string	No	Company name
isSSO	boolean	No (default true)	Whether user uses Single Sign-On
plan	string	No	User subscription plan
type	string	No	User type
domainId	string	Yes	Domain identifier
roleIds	string (JSON array)	No	JSON string of role IDs
roleOrgData	array	No	Array of role & client mappings
selectedPage	string	No	Selected page identifier
userId	string	No	Existing user ID (for updates)

Response:

{
    "success": true,
    "message": "done.",
    "result": {
        "userDetailId": "0440544a-46cf-41ee-b73c-c467833f3729",
        "userInfo": [
            {
                "userProfileId": 125,
                "clientId": "1"
            }
        ]
    }
}

Error Codes:

Code	Message
DNX_ADM_001	Missing User details
DNX_ADM_002	Missing Username
DNX_ADM_003	Missing Email
DNX_ADM_004	Missing First name
DNX_ADM_005	Missing Domain Id
DNX_ADM_006	Invalid date of birth

Example Request:

POST /creatingUser
Content-Type: application/json
{
  "registerUserDetails": {
    "userName": "sam",
    "email": "sam@example.com",
    "firstName": "Sam",
    "middleName": "M",
    "lastName": "Doe",
    "dob": "1985-07-24",
    "companyName": "Acme Corp",
    "isSSO": true,
    "plan": "premium",
    "type": "generalUser",
    "domainId": "3",
    "roleIds": "[1,2]",
    "roleOrgData": [
      {
        "clientId": "1",
        "roleIds": [1,2],
        "isPrimaryClientUser": 1
      }
    ],
    "selectedPage": "dashboard"
  }
}

Example Error Response:

{
    "error": true,
    "code": "DNX_ADM_002",
    "message": "Missing Username"
}

GET `/updateUser/:obj`

Description: Updates the user details provided in the obj URL parameter, which should be a JSON string containing user information.

Param	Type	Required	Description
obj	string (JSON)	Yes	Stringified JSON object containing the user details to update

User Details Fields (inside obj):

Field	Type	Required	Description
EMAIL	string	Yes	User’s email address
FIRST_NAME	string	Yes	User’s first name
LAST_NAME	string	No	User’s lat name

Headers:

Header	Required	Description
x-client-id	No	Client ID for saving organization data

Response:

{
    "success": true,
    "message": "done."
}

Error Codes:

Code	Message
DNX_ADM_001	Missing User details
DNX_ADM_003	Missing Email
DNX_ADM_004	Missing First name

Example Request:

POST /updateUser/%7B%22email%22%3A%22john@example.com%22%2C%22firstName%22%3A%22John%22%7D
x-client-id: 12345

Example Error Response:

{
    "error": true,
    "code": "DNX_ADM_003",
    "message": "Missing Email"
}

POST `/deleteUser`

Description: Deletes or marks as deleted various entities based on the type and userId provided in the request body. Supported types include User Management, Data Source Management, Role Management, Dashboard, Client Management, Group Management, Scheduled reports, Connectors, Migration, Workflow, Inbox, and others.

Param	Type	Required	Description
userId	string	Yes	ID of the user or entity to delete
type	string	Yes	Type of entity to delete (e.g., User_Management, Data_Source_Management, Role_Management, My_Dashboard, Client_Management, Group Management, etc.)
isDataSource	boolean	No	Flag used when type is “All_Scheduled” to delete related schedule report connectors

Response:

{
    "success": true,
    "message": "done."
}

Error Codes:

Code	Message
DNX_ADM_021	Missing userId
DNX_ADM_014	Missing type

Example Request:

POST /deleteUser
Content-Type: application/json
{
  "userId": "145",
  "type": "User_Management"
}

Example Error Response:

{
    "error": true,
    "code": "DNX_ADM_021",
    "message": "Missing userId"
}

GET `/getClientsBasedOnUserDetailId/:userDetailId`

Description: Retrieves a list of clients associated with a specific user, identified by their userDetailId.

Param	Type	Required	Description
userDetailId	string	Yes	User Detail ID
x-client-id	string (header)	Yes	Client ID

Response:

[
    {
        "client_id": 1,
        "company_name": "tekizma",
        "is_primary_client_user": 1
    }
]

Error Codes:

Code	Message
DNX_ADM_022	Missing userDetailId
DNX_ADM_024	Missing clientId

Example Request:

GET /getClientsBasedOnUserDetailId/16da7eac-af5d-11ec-921d-00ffd7e419

Example Error Request:

GET /getClientsBasedOnUserDetailId/16da7eac-af5d-11ec-921d-00ffd7e419
ClientId header : none

Example Error Response:

{
    "error": true,
    "code": "DNX_ADM_024",
    "message": "Missing clientId"
}

POST `/getSettings`

Description: Retrieves specific user settings based on user profile ID, client ID, and the name of the settings requested.

Param	Type	Required	Description
userProfileId	string	Yes	User profile ID for which settings are requested
clientId	string	Yes	Client ID related to the user
settingsName	string	Yes	Name/key of the settings to fetch

Response:

[
    {
        "id": 163,
        "name": "ASK_ME_ENABLED",
        "value": "false"
    }
]

Error Codes:

Code	Message
DNX_ADM_021	Missing userId
DNX_ADM_024	Missing clientId
DNX_ADM_025	Missing settingsName

Example Request:

POST /getSettings
Content-Type: application/json
{
  "userProfileId": "123",
  "clientId": "456",
  "settingsName": "ASK_ME_ENABLED"
}

Example Error Response:

{
    "error": true,
    "code": "DNX_ADM_024",
    "message": "Missing clientId"
}

GET `/getDomainByName/:name`

Description: Retrieves domain details for the specified domain name and sets the login type in the domain object.

Param	Type	Required	Description
name	string	Yes	Domain name to search for

Response:

[
    {
        "id": 1,
        "domain_name": "tekizma",
        "logo_url": "https://reporting-2019.s3.ap-south-1.amazonaws.com/icons/newLogo.png",
        "available_themes": "theme4Theme,defaultTheme,theme1Theme,theme2Theme,theme3Theme,theme5Theme,theme7Theme,whiteTheme,theme8Theme,New7Theme,New1Theme,New2Theme,New3Theme,New4Theme,New5Theme,New6Theme,theme9Theme,theme10Theme",
        "default_theme_index": 0,
        "copyrights_text": "© 2019. Tekizma Inc. All Rights Reserved",
        "type": "dev",
        "status": "active",
        "title_logo": "https://reporting-2019.s3.ap-south-1.amazonaws.com/icons/faviconForTekizma.ico",
        "dark_logo_url": "https://reporting-2019.s3.ap-south-1.amazonaws.com/icons/newLogo.png",
        "powered_by_text": "Powered By Tekizma BI",
        "dark_title_logo": "https://reporting-2019.s3.ap-south-1.amazonaws.com/icons/faviconForTekizma.ico",
        "login_html": null,
        "loginType": "thirdParty"
    }
]

Example Request:

GET /getDomainByName/tekizma

POST `/createClient`

Description: Creates a new client record for the given parent client, using the provided company name and the currently logged-in user’s ID.

Field	Type	Required	Description
company details	string	Yes	Comapny Details
x-client-id	string (header)	Yes	Parent Client ID

Response:

{
    "success": true,
    "message": "done."
}

Error Codes:

Code	Message
DNX_ADM_017	Missing company details
DNX_ADM_024	Missing clientId

Example Request:

POST /createClient
Content-Type: application/json
x-client-id:1
{
  "companyDetails": {
    "formValues": {
      "clientName": "TekizmaNew",
      "clientAddress": "USA",
      "clientNumber": "123-456-7890",
      "externalId": ""
    },
    "keyValueset": []
  }
}

Example Error Request:

POST /createClient
Content-Type: application/json
x-client-id: 1
{
  "companyDetails": ""
}

Example Error Response:

{
    "error": true,
    "code": "DNX_ADM_027",
    "message": "Missing company details"
}

POST `/updateClient`

Description: Updates an existing client record with the provided ID and company details.

Field	Type	Required	Description
id	string	Yes	Client Id
companyDetails	string	Yes	Updated company details (name, address, etc.).

Response:

{
    "success": true,
    "message": "done."
}

Error Codes:

Code	Message
DNX_ADM_024	Missing client id
DNX_ADM_027	Missing company details

Example Request:

POST /updateClient
Content-Type: application/json
{
  "id": "30",
  "companyDetails": {
    "formValues": {
      "clientName": "Tekizma Updated",
      "clientAddress": "USA",
      "clientNumber": "987-654-3210",
      "externalId": "EXT001"
    },
    "keyValueset": []
  }
}

Example Error Request:

POST /updateClient
Content-Type: application/json
{
  "id": "",
  "companyDetails": {
    "formValues": {
      "clientName": "Tekizma Updated",
      "clientAddress": "USA",
      "clientNumber": "987-654-3210",
      "externalId": "EXT001"
    },
    "keyValueset": []
  }
}

Example Error Response:

{
    "error": true,
    "code": "DNX_ADM_024",
    "message": "Missing clientId"
}

POST `/retrieveClientDetails`

Description:Retrieves detailed information of a specific child client using the provided clientId.

Field	Type	Required	Description
clientId	string	Yes	Client ID

Response:

{
    "success": true,
    "message": "done.",
    "result": {
        "clientDetails": [
            {
                "id": 1,
                "company_name": "tekizma",
                "address": null,
                "phone": null,
                "owner_user_id": 13,
                "domain_id": "3",
                "is_owner": 1,
                "attr1": null,
                "attr2": null,
                "created_date": null,
                "created_by": null,
                "updated_date": null,
                "updated_by": null,
                "is_deleted": 0,
                "external_id": "0000070297"
            }
        ],
        "keyValueSetDetails": []
    }
}

Error Codes:

Code	Message
DNX_ADM_024	Missing clientId

Example Request:

POST /retrieveClientDetails
Content-Type: application/json
{
    "clientId":1
}

Example Error Request:

POST /retrieveClientDetails
Content-Type: application/json
{
    "clientId":""
}

Example Error Response:

{
    "error": true,
    "code": "DNX_ADM_024",
    "message": "Missing clientId"
}

POST `/updateClientTable`

Description: Updates client table information for the specified client using provided raw object data and key-value set.

Field	Type	Required	Description
clientId	string	Yes	The unique identifier of the client to update.
obj	string (JSON)	Yes	Raw JSON string containing updated client details.
keyValueSet	object	Yes	Key-value pairs specifying the fields to update in the client table.

Response:

{
    "success": true,
    "message": "done."
}

Error Codes:

Code	Message
DNX_ADM_024	Missing clientId
DNX_ADM_027	Missing company details
DNX_ADM_028	Missing keyValueSet

Example Request:

POST /updateClientTable
Content-Type: application/json
{
    "clientId":"30",
    "companyDetails": "{\"clientName\":\"TekizmaNew\",\"clientAddress\":\"USA\",\"clientNumber\":\"123-456-7899\",\"externalId\":\"\"}",
    "keyValueSet": []
}

Example Error Request:

POST /updateClientTable
Content-Type: application/json
{
    "clientId":"",
    "companyDetails": "{\"clientName\":\"TekizmaNew\",\"clientAddress\":\"USA\",\"clientNumber\":\"123-456-7899\",\"externalId\":\"\"}",
    "keyValueSet": []
}

Example Error Response:

{
    "error": true,
    "code": "DNX_ADM_024",
    "message": "Missing clientId"
}

POST `/getUserRoleDataIfSuperOwner`

Description: Retrieves user and role data if the current user is a super owner for the specified client.

Field	Type	Required	Description
clientId	string	Yes	The unique identifier of the client for which to fetch role data.

Response:

[
    {
        "role": [
            {
                "ID": 2,
                "ROLE_NAME": "NORTH RSM"
            },
            {
                "ID": 3,
                "ROLE_NAME": "EAST RSM"
            }
        ]
    },
    {
        "user": [
            {
                "ID": 13,
                "EMAIL": "john.doe@tekizma.com",
                "USER_NAME": "john"
            },
            {
                "ID": 113,
                "EMAIL": "schoolc@yopmail.com",
                "USER_NAME": "schoolc"
            }
        ]
    }
]

Error Codes:

Code	Message
DNX_ADM_024	Missing clientId

Example Request:

POST /getUserRoleDataIfSuperOwner
Content-Type: application/json
{
    "clientId":"1"
}

Example Error Request:

POST /getUserRoleDataIfSuperOwner
Content-Type: application/json
{
    "clientId": ""
}

Example Error Response:

{
    "error": true,
    "code": "DNX_ADM_024",
    "message": "Missing clientId"
}

GET `/getClientsByUserDetailId/:userDetailId`

Description: Retrieves a list of selected clients associated with the specified user, identified by their userDetailId.

Param	Type	Required	Description
userDetailId	string	Yes	User Detail ID

Response:

[
    {
        "client_id": 1,
        "company_name": "tekizma",
        "is_primary_client_user": 1
    }
]

Example Request:

GET /getClientsByUserDetailId/16da7eac-af5d-11ec-921d-00ffd7e419

Example Error Request:

GET /getClientsByUserDetailId/

Example Error Response:

[]

POST `/getListOfGroups`

Description: Retrieves a paginated list of all groups for the specified client. Supports optional filtering by group name or related data using filterValue.

Param	Type	Required	Description
clientId	string	Yes	Client ID (fetched from server context)
filterValue	string	No	Text filter for group search (partial match, case-insensitive)
pageSize	number	No	Number of records to return per page
pageNo	number	No	Page number (starting from 0)

Response:

{
    "data": [
        {
            "id": 3,
            "name": "aad",
            "parent_id": null,
            "is_deleted": 0,
            "client_id": 1
        }
    ],
    "totalRecords": 1
}

Error Codes:

Code	Message
DNX_ADM_024	Missing clientId

Example Request:

POST /getListOfGroups
Content-Type: application/json

{
    "filterValue": "a",
    "pageSize": 10,
    "pageNo": 1
}

Example Error Request:

POST /getListOfGroups
clientId=""
Content-Type: application/json

{
    "pageSize": 10,
    "pageNo": 1
}

Example Error Response:

{
    "error": true,
    "code": "DNX_ADM_024",
    "message": "Missing clientId"
}

POST `/saveGroups`

Description: Creates or updates a group along with assigned roles and users. Allows specifying a parent group and supports marking a group as deleted.

Param	Type	Required	Description
groupObject	object	Yes	Group details object containing groupName and other properties
groupObject.groupName	string	Yes	Name of the group
roleArray	array	Yes	Array of role IDs assigned to the group
userArray	array	Yes	Array of users assigned to the group
parentId	number \| null	Yes	Parent group ID (0 or null for no parent)
isDel	boolean	Yes	Flag indicating if the group should be marked as deleted
clientId	string	Yes	Client ID (retrieved from server context)

Response:

{
    "fieldCount": 0,
    "affectedRows": 1,
    "insertId": 8,
    "serverStatus": 2,
    "warningCount": 0,
    "message": "",
    "protocol41": true,
    "changedRows": 0
}

Error Codes:

Code	Message
DNX_ADM_029	Missing obj (groupObject)
DNX_ADM_030	Missing name (groupName)
DNX_ADM_031	Missing or invalid roleId array
DNX_ADM_032	Missing User details (userArray)
DNX_ADM_033	Missing Type (parentId)
DNX_ADM_034	Missing Type (isDel must be boolean)
DNX_ADM_024	Missing clientId

Example Request:

POST /saveGroups
Content-Type: application/json
{
    "groupObject": {
        "groupName": "Project Managers"
    },
    "roleArray": [1, 3, 5],
    "userArray": [
       "16da7eac-af5d-11ec-921d-00ffd7e41936"
    ],
    "parentId": 0,
    "isDel": false
}

Example Error Request:

POST /saveGroups
Content-Type: application/json
{
    "groupObject":"",
    "roleArray": [1, 3, 5],
    "userArray": [
       "16da7eac-af5d-11ec-921d-00ffd7e41936"
    ],
    "parentId": 0,
    "isDel": false
}

Example Error Response:

{
    "error": true,
    "code": "DNX_ADM_029",
    "message": "Missing obj (groupObject)"
}

POST `/updateGroups/:groupId`

Description: Updates an existing group’s details, including roles, users, parent group, and deletion status, for the specified groupId.

Param	Type	Required	Description
groupId	number	Yes	ID of the group to update (path parameter)
groupObject	object	Yes	Group details object containing groupName and other properties
groupObject.groupName	string	Yes	Name of the group
roleArray	array	Yes	Array of role IDs assigned to the group
userArray	array	Yes	Array of user details assigned to the group
parentId	number \| null	Yes	Parent group ID (0 or null for no parent)
isDel	boolean	Yes	Flag indicating if the group should be marked as deleted
clientId	string	Yes	Client ID (retrieved from server context)

Response:

{
    "fieldCount": 0,
    "affectedRows": 1,
    "insertId": 0,
    "serverStatus": 2,
    "warningCount": 0,
    "message": "(Rows matched: 1  Changed: 1  Warnings: 0",
    "protocol41": true,
    "changedRows": 1
}

Error Codes:

Code	Message
DNX_ADM_029	Missing obj (groupObject)
DNX_ADM_030	Missing name (groupName)
DNX_ADM_031	Missing or invalid roleId array
DNX_ADM_032	Missing User details (userArray)
DNX_ADM_033	Missing Type (parentId)
DNX_ADM_034	Missing Type (isDel must be boolean)
DNX_ADM_024	Missing clientId

Example Request:

POST /updateGroups/3
Content-Type: application/json
{
   "groupObject": {
        "groupName": "Project Managers"
    },
    "roleArray": [1, 3, 5],
    "userArray": [
       "16da7eac-af5d-11ec-921d-00ffd7e41936"
    ],
    "parentId": 0,
    "isDel": false
}

Example Error Request:

POST /updateGroups/3
Content-Type: application/json
{
   "groupObject": {
        "groupName": ""
    },
    "roleArray": [1, 3, 5],
    "userArray": [
       "16da7eac-af5d-11ec-921d-00ffd7e41936"
    ],
    "parentId": 0,
    "isDel": false
}

Example Error Response:

{
    "error": true,
    "code": "DNX_ADM_030",
    "message": "Missing name (groupName)"
}

GET `/getListOfChildGroups/:parentId`

Description: Retrieves all child groups that belong to the specified parent group, identified by parentId.

Param	Type	Required	Description
parentId	number	Yes	ID of the parent group whose child groups are to be fetched (path parameter)

Response:

[
    {
        "id": 2,
        "name": "adada",
        "parent_id": 1,
        "is_deleted": 0,
        "client_id": null
    },
    {
        "id": 3,
        "name": "Project Managers",
        "parent_id": 1,
        "is_deleted": 0,
        "client_id": 1
    }
]

Example Request:

GET /getListOfChildGroups/1

Example Error Request:

GET /getListOfChildGroups/

Example Error Response:

[]

GET `/getGroupRoles/:groupId`

Description: Retrieves all roles associated with the specified group, identified by groupId.

Param	Type	Required	Description
groupId	number	Yes	ID of the group whose roles are to be fetched (path parameter)

Response:

[
    {
        "id": 25,
        "group_id": 3,
        "role_id": 1,
        "client_id": 1
    },
    {
        "id": 26,
        "group_id": 3,
        "role_id": 3,
        "client_id": 1
    },
    {
        "id": 27,
        "group_id": 3,
        "role_id": 5,
        "client_id": 1
    }
]]

Example Request:

GET /getGroupRoles/3

Example Error Request:

GET /getGroupRoles/

Example Error Response:

[]

GET `/getGroupUsers/:groupId`

Description: Retrieves all users associated with the specified group, identified by groupId.

Param	Type	Required	Description
groupId	number	Yes	ID of the group whose users are to be fetched (path parameter)

Response:

[
    {
        "id": 7,
        "group_id": 3,
        "user_detail_id": "16da7eac-af5d-11ec-921d-00ffd7e41936",
        "client_id": 1,
        "user_profile_id": 13
    }
]

Example Request:

GET /getGroupUsers/3

Example Error Request:

GET /getGroupUsers/h

Example Error Response:

[]

GET `/getSelectedRoleByUserDetail/:id`

Description: Retrieves the selected role for a given user detail record, identified by id. The request also uses the authenticated user’s userId from the server context.

Param	Type	Required	Description
id	string	Yes	User detail ID whose selected role is to be retrieved (path parameter)
userId	string	Yes	Authenticated user ID (retrieved from server context)

Response:

[
    {
        "ID": 89,
        "ROLE_NAME": "tt1231"
    },
    {
        "ID": 90,
        "ROLE_NAME": "rr1234"
    },
    {
        "ID": 358,
        "ROLE_NAME": "superSuperAdmin"
    }
]

Example Request:

GET getSelectedRoleByUserDetail/16da7eac-af5d-11ec-921d-00ffd7e41936

Example Error Request:

GET /getSelectedRoleByUserDetail/h

Example Error Response:

[]

POST `/getRole`

Description: Retrieves a paginated list of role names filtered by an optional search string for the authenticated user.

Param	Type	Required	Description
pageNo	number	No	Page number for pagination
pageSize	number	No	Number of roles to return per page
filterValue	string	No	Optional search string to filter role names
userId	string	Yes	User profile ID of the authenticated user (from server context)

Response:

{
    "data": [
        {
            "ID": 98,
            "ROLE_NAME": "New Admin",
            "ROLE_TYPE": "no",
            "UPDATED_DATE": null
        },
        {
            "ID": 82,
            "ROLE_NAME": "admin",
            "ROLE_TYPE": "no",
            "UPDATED_DATE": null
        }
    ],
    "totalRecords": 2
}

Error Codes:

Code	Message
DNX_ADM_021	Missing userId

Example Request:

POST /getRole
Content-Type: application/json
userId="13""
{
  "pageNo": 1,
  "pageSize": 10,
  "filterValue": "admin"
}

Example Error Request:

POST /getRole
userId=""
Content-Type: application/json
{
  "pageNo": 1,
  "pageSize": 10,
  "filterValue": "admin"
}

Example Error Response:

{
    "error": true,
    "code": "DNX_ADM_021",
    "message": "Missing userId"
}

POST `/saveRole`

Description: Creates or updates a role for the specified user and client. The role details are passed as a JSON string in the obj parameter, which is parsed on the server.

Param	Type	Required	Description
userId	string	Yes	User profile ID of the user for whom the role is being saved or updated
clientId	string	Yes	Client ID (retrieved from server context)
roleDetails	string (JSON)	Yes	Role details as a JSON string (will be parsed on server)

Response:

{
    "success": true,
    "message": "done."
}

Error Codes:

Code	Message
DNX_ADM_013	Missing obj
DNX_ADM_021	Missing userId
DNX_ADM_024	Missing clientId

Example Request:

POST /saveRole
Content-Type: application/json
{
  "userId": 13,
  "roleDetails": "[{\"ROLENAME\":\"tt1231\",\"ID\":\"89\",\"ROLE_TYPE\":\"no\"}]"
}

Example Error Request:

POST /saveRole
Content-Type: application/json
{
  "userId": 13,
  "roleDetails": ""
}

Example Error Response:

{
    "error": true,
    "code": "DNX_ADM_013",
    "message": "Missing obj"
}

GET `/getSelectedRole/:id`

Description: Retrieves the role details for the specified user, identified by id.

Param	Type	Required	Description
id	string	Yes	User profile Id (path parameter)

Response:

[
    {
        "ROLE_NAME": "tt1231",
        "ID": 89,
        "ROLE_TYPE": "no"
    }
]

Example Request:

GET getSelectedRole/13

Example Error Request:

GET /getSelectedRole/h

Example Error Response:

[]

GET `/getConfigforSelectedRole/:roleId`

Description: Retrieves the configuration details for the specified role, including menu mappings, restricted tables and columns, data sources, data filters, granted roles, role type, granted reports, and granted organizations.

Param	Type	Required	Description
roleId	string	Yes	Role ID whose configuration is to be fetched (path parameter)

Response:

[
    {
        "menu": [
            {
                "id": 13,
                "role_id": 98,
                "menu_id": 17,
                "client_id": 1,
                "status": 1,
                "is_deleted": 0,
                "type": "user",
                "created_date": null,
                "created_by": null,
                "updated_date": null,
                "updated_by": null,
                "address": null,
                "pincode": null,
                "phone_number": null,
                "is_primary_client_user": 1,
                "is_last_logged_in_client": 1,
                "user_detail_id": "16da7eac-af5d-11ec-921d-00ffd7e41936",
                "last_login_datetime": null,
                "last_login_location": "VA",
                "last_login_country": "US",
                "date": null
            }
        ]
    },
    {
        "table": []
    },
    {
        "column": []
    },
    {
        "ds": [
            {
                "data_source_id": 1
            },
            {
                "data_source_id": 14
            }
        ]
    },
    {
        "restricted_data": []
    },
    {
        "grantedRoles": [1,2,3, 4,5,6,7]
    },
    {
        "roleType": [
            {
                "role_name": "New Admin",
                "role_type": "no"
            }
        ]
    },
    {
        "grantedReports": []
    },
    {
        "grantOrganizations": []
    }
]

Example Request:

GET /getConfigforSelectedRole/98

Example Error Request:

GET /getConfigforSelectedRole/h

Example Error Response (Missing roleId):

[
    {
        "menu": []
    },
    {
        "table": []
    },
    {
        "column": []
    },
    {
        "ds": []
    },
    {
        "restricted_data": []
    },
    {
        "grantedRoles": []
    },
    {
        "roleType": []
    },
    {
        "grantedReports": []
    },
    {
        "grantOrganizations": []
    }
]

GET `/getRolesListBasedOnContextID`

Description: Retrieves the list of roles associated with the current client, identified by clientId from the request context.

Context / Headers:

Key	Type	Required	Description
clientId	string	Yes	Client ID retrieved from `httpContext`

Response:

[
    {
        "ID": 1,
        "ROLE_NAME": "NSM",
        "UPDATED_DATE": null
    },
    {
        "ID": 2,
        "ROLE_NAME": "NORTH RSM",
        "UPDATED_DATE": null
    },
]

Example Request:

GET /getRolesListBasedOnContextID

Example Error Response:

{
    "error": true,
    "code": "DNX_ADM_024",
    "message": "Missing clientId"
}

GET `/saveSharedUser/:obj/:widgetId`

Description: Shares a dashboard widget with multiple users by updating shared user mappings, project design mappings, and role-dashboard mappings. The obj parameter is a JSON array of user profile IDs (stringified) to share the widget with. The widgetId specifies the dashboard widget being shared.

Param	Type	Required	Description
obj	string (JSON Array)	Yes	JSON stringified array of user profile IDs to share the widget with
widgetId	string	Yes	Dashboard widget ID to be shared
userId	string	Yes	Current logged-in user ID (from server context)
clientId	string	Yes	Client ID (from server context)

Response:

{
  "success": true,
  "message": "done."
}

Error Codes:

Code	Message
DNX_ADM_016	Missing widgetId
DNX_ADM_021	Missing userId
DNX_ADM_024	Missing ClientId
DNX_ADM_013	Missing obj or obj not valid JSON array

Example Request:

GET/saveSharedUser/%5B25%2C15%2C19%5D/00bbe160-2486-483e-84fd-3b0fa09c6d4a

Example Error Response:

{
  "error": true,
  "code": "DNX_ADM_016",
  "message": "Missing widgetId"
}

POST `/getUserList`

Description: Retrieves a paginated list of users filtered by various criteria such as user details, client context, and status. Supports filtering and pagination parameters in the request body.

Param	Type	Required	Description
pageNo	number	No	Page number for pagination
pageSize	number	No	Number of items per page
filterValue	string	No	Search or filter string to narrow down users
checkStatus	boolean	No	Status flag to filter users
currentUser	string	Yes	Boolean value to check current user
userId	string	Yes	User profile ID of the requester (from server context)
clientId	string	Yes	Client ID (from server context)

Response:

{
    "data": [
        {
            "ID": 13,
            "EMAIL": "john.doe@tekizma.com",
            "FIRST_NAME": "john",
            "MIDDLE_NAME": "",
            "LAST_NAME": "doe",
            "Status": 1,
            "USERNAME": "john",
            "user_detail_id": "16da7eac-af5d-11ec-921d-00ffd7e41936",
            "USER_ID": "5ebc12b062bd5e0c701db8ce",
            "displayText": "john.doe@tekizma.com (doe,john)"
        }
    ],
    "totalRecords": 1
}

Error Codes:

Code	Message
DNX_ADM_021	Missing userId
DNX_ADM_024	Missing clientId

Example Request:

POST /getUserList
userId="12"
clientId="1"
Content-Type: application/json
{
  "pageNo": 1,
  "pageSize": 10,
  "filterValue": "john",
  "checkStatus": true,
  "currentUser": true
}

Example Error Request:

POST /getUserList
userId=""
Content-Type: application/json
{
  "pageNo": 1,
  "pageSize": 10,
  "filterValue": "john",
  "checkStatus": true,
  "currentUser": true
}

Example Error Response:

{
    "error": true,
    "code": "DNX_ADM_021",
    "message": "Missing userId"
}

POST `/findUsernameAndEmailAlreadyPresent`

Description: Checks if the given username and/or email already exist in the system.

Param	Type	Required	Description
obj	object	Yes	Object containing username or email to check for existence

Response:

true

Error Codes:

Code	Message
DNX_ADM_013	Missing obj

Example Request:

POST /findUsernameAndEmailAlreadyPresent
Content-Type: application/json
{
  "obj": {
    "columnName":"userName",
    "columnValue":"john"
    }
}

Example Error Request:

POST /findUsernameAndEmailAlreadyPresent
Content-Type: application/json
{
  "obj":""
}

Example Error Response:

{
    "error": true,
    "code": "DNX_ADM_013",
    "message": "Missing obj"
}

GET `/getClientIdAndDomainIdByUserProfileId`

Description: Retrieves the client ID and domain ID associated with the authenticated user.

Param	Type	Required	Description
userId	string	Yes	User profile ID (from server context)
clientId	string	Yes	Client ID (from server context)

Response:

{
    "success": true,
    "clientId": "1",
    "domainId": 3
}

Error Codes:

Code	Message
DNX_ADM_021	Missing userId
DNX_ADM_024	Missing clientId

Example Request:

GET /getClientIdAndDomainIdByUserProfileId

Example Error Response:

{
  "error": true,
  "code": "DNX_ADM_021",
  "message": "Missing userId"
}

GET `/getUserOwnerInfo`

Description: Checks user info is present for the user using userId and clientId retrieved from the server context.

Param	Type	Required	Description
userId	string	Yes (from server context)	User profile ID of the currently authenticated user
clientId	string	Yes (from server context)	Client ID of the currently authenticated user

Response:

true

Error Codes:

Code	Message
DNX_ADM_021	Missing userId
DNX_ADM_024	Missing clientId

Example Request:

GET /getUserOwnerInfo

Example Error Response:

{
  "error": true,
  "code": "DNX_ADM_021",
  "message": "Missing userId"
}

POST `/getUserProfileInformation`

Description: Retrieves detailed profile information for the currently authenticated user, including user profile data, roles, groups, and owner information.

Param	Type	Required	Description
userId	string	Yes (from server context)	User profile ID of the currently authenticated user
clientId	string	Yes (from server context)	Client ID of the currently authenticated user
loginType	string	Yes (from properties)	Login type configured for the application

Response:

[
    {
        "company_name": "tekizma",
        "owner_user_id": 13,
        "status": 1,
        "address": null,
        "pincode": null,
        "phone_number": null,
        "is_primary_client_user": 1,
        "user_detail_id": "16da7eac-af5d-11ec-921d-00ffd7e41936",
        "id": 13,
        "user_name": "john",
        "first_name": "john",
        "last_name": "doe",
        "email": "john.doe@tekizma.com",
        "user_id": "5ebc12b062bd5e0c701db8ce",
        "ownerInfo": "john.doe@tekizma.com",
        "roles": "aa , AccessRole , New Admin , admin ,
        "groups": "Project Managers"
    }
]

Error Codes:

Code	Message
DNX_ADM_021	Missing userId
DNX_ADM_024	Missing clientId

Example Request:

GET /getUserProfileInformation

Example Error Response:

{
  "error": true,
  "code": "DNX_ADM_021",
  "message": "Missing userId"
}

POST `/getUserDataForEdit`

Description: Retrieves user data about default login page settings.

Param	Type	Required	Description
userId	string	Yes	User ID for which data is to be fetched

Response:

[
 Dashboard
]

Error Codes:

Code	Message
DNX_ADM_021	Missing userId

Example Request:

POST /getUserDataForEdit
Content-Type: application/json
{
  "userId": "123"
}

Example Error Response:

{
  "error": true,
  "code": "DNX_ADM_021",
  "message": "Missing userId"
}

Tekizma Reporting API Documentation

GET /getClientsList

POST /getClientsOfClient

POST /creatingUser

GET /updateUser/:obj

POST /deleteUser

GET /getClientsBasedOnUserDetailId/:userDetailId

POST /getSettings

GET /getDomainByName/:name

POST /createClient

POST /updateClient

POST /retrieveClientDetails

POST /updateClientTable

POST /getUserRoleDataIfSuperOwner

GET /getClientsByUserDetailId/:userDetailId

POST /getListOfGroups

POST /saveGroups

POST /updateGroups/:groupId

GET /getListOfChildGroups/:parentId

GET /getGroupRoles/:groupId

GET /getGroupUsers/:groupId

GET /getSelectedRoleByUserDetail/:id

POST /getRole

POST /saveRole

GET /getSelectedRole/:id

GET /getConfigforSelectedRole/:roleId

GET /getRolesListBasedOnContextID

GET /saveSharedUser/:obj/:widgetId

POST /getUserList

POST /findUsernameAndEmailAlreadyPresent

GET /getClientIdAndDomainIdByUserProfileId

GET /getUserOwnerInfo

POST /getUserProfileInformation

POST /getUserDataForEdit

GET `/getClientsList`

POST `/getClientsOfClient`

POST `/creatingUser`

GET `/updateUser/:obj`

POST `/deleteUser`

GET `/getClientsBasedOnUserDetailId/:userDetailId`

POST `/getSettings`

GET `/getDomainByName/:name`

POST `/createClient`

POST `/updateClient`

POST `/retrieveClientDetails`

POST `/updateClientTable`

POST `/getUserRoleDataIfSuperOwner`

GET `/getClientsByUserDetailId/:userDetailId`

POST `/getListOfGroups`

POST `/saveGroups`

POST `/updateGroups/:groupId`

GET `/getListOfChildGroups/:parentId`

GET `/getGroupRoles/:groupId`

GET `/getGroupUsers/:groupId`

GET `/getSelectedRoleByUserDetail/:id`

POST `/getRole`

POST `/saveRole`

GET `/getSelectedRole/:id`

GET `/getConfigforSelectedRole/:roleId`

GET `/getRolesListBasedOnContextID`

GET `/saveSharedUser/:obj/:widgetId`

POST `/getUserList`

POST `/findUsernameAndEmailAlreadyPresent`

GET `/getClientIdAndDomainIdByUserProfileId`

GET `/getUserOwnerInfo`

POST `/getUserProfileInformation`

POST `/getUserDataForEdit`