Staging

.gitignore

@@ -78,3 +78,5 @@ gcp1.json
 
 dev-ops/report
 
+config.json
+

LICENSE

@@ -7,3 +7,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
+

README.md

@@ -1,3 +1,6 @@
+
+
+# entity-management
 <div align="center">
 
 # Entity Management
@@ -228,3 +231,4 @@ Several open source dependencies that have aided Mentoring's development:
 ![NodeJS](https://img.shields.io/badge/node.js-6DA55F?style=for-the-badge&logo=node.js&logoColor=white)
 ![MongoDB](https://img.shields.io/badge/MongoDB-%234ea94b.svg?style=for-the-badge&logo=mongodb&logoColor=white)
 ![Git](https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white)
+

deployment/ansible.yml

@@ -11,14 +11,12 @@
     #- debug: msg="{{ slurpfile['content'] | b64decode }}"
     #- debug: msg="the value of foo.txt is {{ contents }}"
     - name: Get vault credentials
-      shell: "curl --location --request GET '{{ vaultAddress }}elevate-entity-management' --header 'X-Vault-Token: {{ slurpfile['content'] | b64decode }}' | jq '.data' > '{{ project_path 
-}}/data2.json'"
+      shell: "curl --location --request GET '{{ vaultAddress }}elevate-entity-management' --header 'X-Vault-Token: {{ slurpfile['content'] | b64decode }}' | jq '.data' > '{{ project_path }}/data2.json'"
       register: credentials
     - debug: msg="{{ credentials }}"
 
     - name: Get gcp credentials
-      shell: "curl --location --request GET '{{ vaultAddress }}gcp' --header 'X-Vault-Token: {{ slurpfile['content'] | b64decode }}' | jq '.data.data' > '{{ project_path 
-}}/gcp.json'"
+      shell: "curl --location --request GET '{{ vaultAddress }}gcp' --header 'X-Vault-Token: {{ slurpfile['content'] | b64decode }}' | jq '.data.data' > '{{ project_path }}/gcp.json'"
 
     - name: Set some variable
       set_fact:
@@ -44,7 +42,10 @@
         update: yes
         version: "{{ gitBranch }}"
     - name: Update npm
-      shell: cd {{release_path}}/src && npm i && npm i redoc-cli 
+      shell: cd {{release_path}}/src && npm i && npm i redoc-cli
+
+    - name: Get config.json
+      shell: "curl --location --request GET '{{ vaultAddress }}projectSurveyEntityConfig' --header 'X-Vault-Token: {{ slurpfile['content'] | b64decode }}' | jq '.data.data' > '{{ release_path }}/config.json'"
 
     - name: Delete Old Folder 
       shell: rm -rf {{ current_path }} &&  cd {{ project_path }} && mkdir entity-management
@@ -84,4 +85,4 @@
 
     - name: debug info
       debug:
-         msg: "Pm2 log {{pm2Info}}"
+         msg: "Pm2 log {{pm2Info}}"

src/.env.sample

@@ -18,4 +18,9 @@ API_DOC_URL = "/entity-management/api-doc"
 IS_AUTH_TOKEN_BEARER=false
 
 AUTH_METHOD = native #or keycloak_public_key
-KEYCLOAK_PUBLIC_KEY_PATH = path to the pem/secret file
+KEYCLOAK_PUBLIC_KEY_PATH = path to the pem/secret file
+ADMIN_TOKEN_HEADER_NAME = admin-access-token                                        // admin access token header name
+ADMIN_ACCESS_TOKEN = ivopeiovcie-----------lvkkdvkdm                                // admin access token
+
+INTERFACE_SERVICE_URL = http://localhost:5000/interface-management                  // interface service url 
+USER_SERVICE_BASE_URL = user                                                        // user service base url

src/api-doc/api-doc.yaml

@@ -890,6 +890,25 @@ paths:
                     items:
                       type: object
                       properties:
+                        metaInformation:
+                          type: object
+                          properties:
+                            targetedEntityTypes:
+                              type: array
+                              items:
+                                type: object
+                                properties:
+                                  entityType:
+                                    type: string
+                                  entityTypeId:
+                                    type: string
+                                required:
+                                  - entityType
+                                  - entityTypeId
+                            externalId:
+                              type: string
+                            name:
+                              type: string
                         childHierarchyPath:
                           type: array
                           items:
@@ -898,6 +917,10 @@ paths:
                           type: string
                         updatedBy:
                           type: string
+                        orgIds:
+                          type: array
+                          items:
+                            type: string
                         _id:
                           type: string
                         deleted:
@@ -913,11 +936,10 @@ paths:
                               type: string
                             code:
                               type: string
-                        metaInformation:
-                          type: object
-                          properties:
-                            externalId:
-                              type: string
+                        userId:
+                          type: string
+                        tenantId:
+                          type: string
                         updatedAt:
                           type: string
                         createdAt:
@@ -930,25 +952,34 @@ paths:
                     message: ENTITY_ADDED
                     status: 200
                     result:
-                      - childHierarchyPath:
+                      - metaInformation:
+                          targetedEntityTypes:
+                            - entityType: state
+                              entityTypeId: 683953548f365ab56c8022e9
+                            - entityType: block
+                              entityTypeId: 6839535b8f365ab56c8022ed
+                          externalId: KA28
+                          name: Karnataka
+                        childHierarchyPath:
                           - district
-                          - beat
+                          - block
                           - cluster
                           - school
-                          - block
-                        createdBy: SYSTEM
-                        updatedBy: SYSTEM
-                        _id: 6634b0767411a605fdbaca71
+                        createdBy: '208'
+                        updatedBy: '208'
+                        orgIds:
+                          - ALL
+                        _id: 683996e732316a1ac4f6f150
                         deleted: false
-                        entityTypeId: 5f32d8228e0dc83124040567
-                        entityType: school
+                        entityTypeId: 683953808f365ab56c8022f5
+                        entityType: professional_role
                         registryDetails:
-                          locationId: entity123
-                          code: entity123
-                        metaInformation:
-                          externalId: entity123
-                        updatedAt: '2024-05-03T09:37:58.425Z'
-                        createdAt: '2024-05-03T09:37:58.425Z'
+                          locationId: KA28
+                          code: KA28
+                        userId: '208'
+                        tenantId: '24'
+                        updatedAt: '2025-05-30T11:30:47.909Z'
+                        createdAt: '2025-05-30T11:30:47.909Z'
                         __v: 0
         '400':
           description: Bad Request.
@@ -979,22 +1010,26 @@ paths:
                   type: string
                 name:
                   type: string
-                entityType:
-                  type: string
                 childHierarchyPath:
                   type: array
                   items:
                     type: string
+                targetedEntityTypes:
+                  type: array
+                  items:
+                    type: string
             examples:
               sampleBodyData:
                 value:
-                  externalId: entity123
-                  name: entityName
+                  externalId: KA28
+                  name: Karnataka
                   childHierarchyPath:
                     - district
-                    - beat
+                    - block
                     - cluster
                     - school
+                  targetedEntityTypes:
+                    - state
                     - block
   /v1/entities/details/{_id}?&language={code}:
     get:
@@ -1148,8 +1183,29 @@ paths:
                       metaInformation:
                         type: object
                         properties:
+                          targetedEntityTypes:
+                            type: array
+                            items:
+                              type: object
+                              properties:
+                                entityType:
+                                  type: string
+                                entityTypeId:
+                                  type: string
+                              required:
+                                - entityType
+                                - entityTypeId
                           externalId:
                             type: string
+                          name:
+                            type: string
+                      registryDetails:
+                        type: object
+                        properties:
+                          locationId:
+                            type: string
+                          code:
+                            type: string
                       childHierarchyPath:
                         type: array
                         items:
@@ -1158,6 +1214,10 @@ paths:
                         type: string
                       updatedBy:
                         type: string
+                      orgIds:
+                        type: array
+                        items:
+                          type: string
                       deleted:
                         type: boolean
                       _id:
@@ -1166,6 +1226,10 @@ paths:
                         type: string
                       entityType:
                         type: string
+                      userId:
+                        type: string
+                      tenantId:
+                        type: string
                       updatedAt:
                         type: string
                       createdAt:
@@ -1175,24 +1239,33 @@ paths:
               examples:
                 SuccessResponse:
                   value:
-                    message: ENTITY_UPDATATED
+                    message: ENTITY_UPDATED
                     status: 200
                     result:
                       metaInformation:
-                        externalId: SCH
-                        name: school
+                        targetedEntityTypes:
+                          - entityType: state
+                            entityTypeId: 683953548f365ab56c8022e9
+                          - entityType: block
+                            entityTypeId: 6839535b8f365ab56c8022ed
+                        externalId: KA28
+                        name: Karnataka
                       registryDetails:
-                        locationId: rajAPSTATEDummy4
-                        code: rajAPSTATEDummy4
+                        locationId: KA28
+                        code: KA28
                       childHierarchyPath: []
-                      createdBy: user123
-                      updatedBy: user123
+                      createdBy: '208'
+                      updatedBy: '208'
+                      orgIds:
+                        - ALL
                       deleted: false
-                      _id: 66ea64fa68cd063346a10365
-                      entityTypeId: 6672ce0fc05aa58f89ba12f1
-                      entityType: state
-                      updatedAt: '2024-09-18T10:07:39.407Z'
-                      createdAt: '2024-09-18T05:28:26.148Z'
+                      _id: 68395a55e5af17c215ce3408
+                      entityTypeId: 683953808f365ab56c8022f5
+                      entityType: professional_role
+                      userId: '208'
+                      tenantId: '24'
+                      updatedAt: '2025-05-30T11:32:35.296Z'
+                      createdAt: '2025-05-30T07:12:21.457Z'
                       __v: 0
         '400':
           description: Bad Request.
@@ -1216,26 +1289,34 @@ paths:
             schema:
               type: object
               properties:
-                metaInformation.externalId:
-                  type: string
+                metaInformation.targetedEntityTypes:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      entityType:
+                        type: string
+                      entityTypeId:
+                        type: string
+                    required:
+                      - entityType
+                      - entityTypeId
                 metaInformation.name:
                   type: string
                 childHierarchyPath:
                   type: array
                   items:
                     type: string
-                createdBy:
-                  type: string
-                updatedBy:
-                  type: string
             examples:
               sampleBodyData:
                 value:
-                  metaInformation.externalId: SCH
-                  metaInformation.name: school
+                  metaInformation.targetedEntityTypes:
+                    - entityType: state
+                      entityTypeId: 683953548f365ab56c8022e9
+                    - entityType: block
+                      entityTypeId: 6839535b8f365ab56c8022ed
+                  metaInformation.name: 'Karnataka '
                   childHierarchyPath: []
-                  createdBy: user123
-                  updatedBy: user123
   /v1/entities/mappingUpload:
     post:
       summary: This endpoint will map its childEntity to its parentEntity
@@ -1628,6 +1709,34 @@ paths:
                       - location: body
                         param: query
                         msg: required query
+    parameters:
+      - in: query
+        name: page
+        description: Page number for pagination
+        schema: &ref_4
+          type: number
+      - in: query
+        name: limit
+        description: Number of documents to return per page
+        schema: *ref_4
+      - in: query
+        name: search
+        description: Optional search string for text-based filtering
+        schema: &ref_5
+          type: string
+      - in: query
+        name: aggregateValue
+        description: Field path to be used for aggregation
+        schema: *ref_5
+      - in: query
+        name: aggregateStaging
+        description: Whether to apply aggregation stages in the pipeline
+        schema: &ref_6
+          type: boolean
+      - in: query
+        name: aggregateSort
+        description: Whether to apply sorting within the aggregation pipeline
+        schema: *ref_6
   /v1/entities/list/_id?page={page_no}&limit={page_limit}&type={entity_type}:
     get:
       summary: List entities based on entity id