Skip to content

updated-api-doc #192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
VISHNUDAS-tunerlabs merged 1 commit into from
Oct 22, 2025
Merged

updated-api-doc #192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
209 changes: 23 additions & 186 deletions src/api-doc/Entity Management API's.postman_collection.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"info": {
"_postman_id": "f666ab31-a835-4f2d-995e-70d0a5b606e7",
"name": "Entity-Management API's",
"_postman_id": "10b257e6-6f3c-42e1-a60d-06dbc25abb85",
"name": "Entity-Management",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
"_exporter_id": "28589818"
"_exporter_id": "33513401"
},
"item": [
{
Expand Down Expand Up @@ -374,7 +374,7 @@
],
"body": {
"mode": "raw",
"raw": "{\n \"externalId\": \"entity123\",\n \"name\": \" block\",\n \"childHierarchyPath\": [],\n \"allowedRoles\": [\"role2\", \"role1\"],\n \"createdBy\": \"user123\",\n \"updatedBy\": \"user123\"\n}\n",
"raw": "{\n \"metaInformation.externalId\": \"KA28\",\n \"metaInformation.name\": \" Karnataka\",\n \"childHierarchyPath\": [\n \"district\",\n \"block\",\n \"cluster\",\n \"school\"\n ],\n \"allowedRoles\": [\n \"role2\",\n \"role1\"\n ],\n \"createdBy\": \"user123\",\n \"updatedBy\": \"user123\"\n}",
"options": {
"raw": {
"language": "json"
Expand Down Expand Up @@ -714,7 +714,7 @@
],
"body": {
"mode": "raw",
"raw": "{\n \"query\": {\n \"_id\": {\n \"$in\": [\n \"5fd1b52ab53a6416aaeefb1f\",\n \"5fd1b52ab53a6416aaeefb24\",\n \"5f33c3d85f637784791cd830\",\n \"5fd1b52ab53a6416aaeefb26\",\n \"5fd098e2e049735a86b748ae\"\n ]\n }\n },\n \"projection\": [\n \"_id\",\n \"metaInformation.name\"\n ]\n}",
"raw": "{\n \"query\": {\n \"_id\": {\n \"$in\": [\n \"5fd1b52ab53a6416aaeefb1f\",\n \"5fd1b52ab53a6416aaeefb24\",\n \"5f33c3d85f637784791cd830\",\n \"5fd1b52ab53a6416aaeefb26\",\n \"5fd098e2e049735a86b748ae\"\n ]\n },\n \"tenantId\": \"shikshalokam\"\n },\n \"projection\": [\n \"_id\",\n \"metaInformation.name\"\n ]\n}",
"options": {
"raw": {
"language": "json"
Expand Down Expand Up @@ -834,7 +834,7 @@
],
"body": {
"mode": "raw",
"raw": "{\n \"entityTypeId\": \"663335e2a766490014aead0a\",\n \"externalId\": \"entity44123\",\n \"name\": \"Arunachal Pradesh\",\n \"childHierarchyPath\" : [ \n \"district\", \n \"beat\", \n \"cluster\", \n \"school\", \n \"block\"\n ],\n \"allowedRoles\": [\"role1\", \"role2\"]\n \n}\n",
"raw": "{\n \"externalId\": \"KA280\",\n \"name\": \"Karnataka\",\n \"childHierarchyPath\": [],\n \"targetedEntityTypes\": [\n \"district\",\n \"block\",\n \"cluster\",\n \"school\"\n ]\n}",
"options": {
"raw": {
"language": "json"
Expand Down Expand Up @@ -872,9 +872,9 @@
}
],
"url": {
"raw": "{{baseUrl}}/entity-management/v1/entities/subEntityListBasedOnRoleAndLocation/entity123",
"raw": "{{baseUrl}}/entity-management/v1/entities/subEntityListBasedOnRoleAndLocation/KA28",
"host": ["{{baseUrl}}"],
"path": ["entity", "v1", "entities", "subEntityListBasedOnRoleAndLocation", "entity123"]
"path": ["entity", "v1", "entities", "subEntityListBasedOnRoleAndLocation", "KA28"]
}
},
"response": []
Expand Down Expand Up @@ -1021,174 +1021,6 @@
}
]
},
{
"name": "userRoleExtension",
"item": [
{
"name": "create",
"request": {
"method": "POST",
"header": [
{
"key": "internal-access-token",
"value": "8c3a94f0931e01a4940a"
},
{
"key": "content-type",
"value": "application/json"
},
{
"key": "x-auth-token",
"value": "{{userToken}}"
},
{
"key": "admin-auth-token",
"value": "{{adminAuthToken}}",
"type": "text"
},
{
"key": "tenantId",
"value": "{{tenantId}}",
"type": "text"
},
{
"key": "orgId",
"value": "{{orgId}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"userRoleId\": \"13\",\n \"title\": \"State Level Campaign Coordinator\",\n \"userType\": 1,\n \"entityTypes\": [\n {\n \"entityType\": \"district\",\n \"entityTypeId\": \"5f32d8228e0dc83104056e\"\n }\n ],\n \"code\": \"state_level_campaign_coordinator\"\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{baseUrl}}/entity-management/v1/userRoleExtension/create",
"host": ["{{baseUrl}}"],
"path": ["entity", "v1", "userRoleExtension", "create"]
}
},
"response": []
},
{
"name": "update",
"request": {
"method": "POST",
"header": [
{
"key": "internal-access-token",
"value": "8c3a94f0931e01a4940a"
},
{
"key": "content-type",
"value": "application/json"
},
{
"key": "x-auth-token",
"value": "{{userToken}}"
},
{
"key": "admin-auth-token",
"value": "{{adminAuthToken}}",
"type": "text"
},
{
"key": "tenantId",
"value": "{{tenantId}}",
"type": "text"
},
{
"key": "orgId",
"value": "{{orgId}}",
"type": "text"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"title\":\"DM\"\n}"
},
"url": {
"raw": "{{baseUrl}}/entity-management/v1/userRoleExtension/update/66a94c06fff8abb34f9d800f",
"host": ["{{baseUrl}}"],
"path": ["entity", "v1", "userRoleExtension", "update", "66a94c06fff8abb34f9d800f"]
}
},
"response": []
},
{
"name": "find",
"request": {
"method": "POST",
"header": [
{
"key": "content-type",
"value": "application/json"
},
{
"key": "internal-access-token",
"value": "{{internal_access_token}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"query\": {\n \"entityTypes.entityTypeId\": {\n \"$in\": [\n \"5f32d8228e0dc8312404056b\",\n \"5f32d8228e0dc8312404056c\",\n \"5f32d8228e0dc83124040567\",\n \"5f32d8228e0dc8312404056e\"\n ]\n }\n },\n \"projection\": [\n \"_id\", \"title\"\n ]\n}\n"
},
"url": {
"raw": "{{baseUrl}}/entity-management/v1/userRoleExtension/find",
"host": ["{{baseUrl}}"],
"path": ["entity", "v1", "userRoleExtension", "find"]
}
},
"response": []
},
{
"name": "delete",
"request": {
"method": "DELETE",
"header": [
{
"key": "content-type",
"value": "application/json"
},
{
"key": "x-auth-token",
"value": "{{userToken}}"
},
{
"key": "admin-auth-token",
"value": "{{adminAuthToken}}",
"type": "text"
},
{
"key": "tenantId",
"value": "{{tenantId}}",
"type": "text"
},
{
"key": "orgId",
"value": "{{orgId}}",
"type": "text"
},
{
"key": "internal-access-token",
"value": "{{internalToken}}",
"type": "text"
}
],
"url": {
"raw": "{{baseUrl}}/entity-management/v1/userRoleExtension/delete/66a94fc1fdf2d5dda4b689dc",
"host": ["{{baseUrl}}"],
"path": ["entity", "v1", "userRoleExtension", "delete", "66a94fc1fdf2d5dda4b689dc"]
}
},
"response": []
}
]
},
{
"name": "Admin",
"item": [
Expand Down Expand Up @@ -1268,7 +1100,7 @@
}
],
"url": {
"raw": "{{baseUrl}}/entity/v1/admin/deleteEntity/6825b78bcfa7cfe32cd835b6?allowRecursiveDelete=false",
"raw": "{{baseUrl}}/entity-management/v1/admin/deleteEntity/6825b78bcfa7cfe32cd835b6?allowRecursiveDelete=false",
"host": ["{{baseUrl}}"],
"path": ["entity", "v1", "admin", "deleteEntity", "6825b78bcfa7cfe32cd835b6"],
"query": [
Expand All @@ -1285,16 +1117,21 @@
},
{
"name": "healthCheck",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}entity/health",
"host": ["{{baseUrl}}entity"],
"path": ["health"]
"item": [
{
"name": "healthCheck",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}entity/health",
"host": ["{{baseUrl}}entity"],
"path": ["health"]
}
},
"response": []
}
},
"response": []
]
}
]
}
2 changes: 1 addition & 1 deletion src/api-doc/Entity-Management LOCAL postman_environment
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"values": [
{
"key": "baseUrl",
"value": "localhost:5001",
"value": "http://localhost:5000",
"type": "default",
"enabled": true
},
Expand Down
Loading