{"info":{"_postman_id":"340f3a7e-ed84-416a-9756-178375ae03b7","name":"Sunbrid Form API(s) (1.0)","description":"

Download OpenAPI specification: Download

\n\n

The dynamic functionality of UI/logic can be achieved by using these forms configuration. So any adoptor can define these form as per their use-case. Wihtout doing any change in the code of sunbird, the changes of the form will reflect in the UI/logic.

\n

Sunbird-Portal and Mobile is heavy using these form API's which are exposed by Sunbird-Portal backend.

\n

Authentication

\n

bearer

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Security Scheme TypeAPI Key
Header parameter name:Authorization
\n

userToken

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Security Scheme TypeAPI Key
Header parameter name:x-authenticated-user-token
\n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"}],"owner":"25186239","collectionId":"340f3a7e-ed84-416a-9756-178375ae03b7","publishedId":"2s93Y2TNAw","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-04-20T06:43:46.000Z"},"item":[{"name":"Create","item":[{"name":"Create Form","id":"334c039f-aaee-402c-b1d3-927b2f761d2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{Authorization}}"}]},"isInherited":false},"method":"POST","header":[{"key":"sec-ch-ua","value":"\"Google Chrome\";v=\"111\", \"Not(A:Brand\";v=\"8\", \"Chromium\";v=\"111\"","type":"text"},{"key":"ts","value":"2023-04-10T18:26:14+05:30","type":"text"},{"key":"X-msgid","value":"1436a7ae-36ea-4d1d-bfeb-13312303bcd6","type":"text"},{"key":"X-Org-code","value":"0137541424673095687","type":"text"},{"key":"X-Source","value":"web","type":"text"},{"key":"X-Session-ID","value":"c880519f-3ad6-4793-9a41-b54c53ed529a","type":"text"},{"key":"X-Request-ID","value":"1436a7ae-36ea-4d1d-bfeb-13312303bcd6","type":"text"},{"key":"sec-ch-ua-platform","value":"\"macOS\"","type":"text"},{"key":"X-Channel-Id","value":"0137541424673095687","type":"text"},{"key":"X-App-Id","value":"dev.sunbird.portal","type":"text"},{"key":"X-App-Version","value":"5.2.0","type":"text"},{"key":"sec-ch-ua-mobile","value":"?0","type":"text"},{"key":"User-Agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Referer","value":"https://dev.sunbirded.org/","type":"text"},{"key":"X-Device-ID","value":"aadb6a334472c7c01cf282c90c3e9981","type":"text"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"type\": \"contentcategory-test2\",\n \"subType\": \"global-test2\",\n \"action\": \"create\",\n \t\"component\": \"portal\",\n \"data\": {\n \"templateName\": \"defaultTemplate\",\n \"action\": \"search\",\n \"fields\": [\n {\n \"code\": \"date\",\n \"visible\": true,\n \"editable\": true,\n \"displayProperty\": \"Editable\",\n \"dataType\": \"text\",\n \"renderingHints\": {\n \"semanticColumnWidth\": \"four\"\n },\n \"description\": \"Date\",\n \"index\": 7,\n \"label\": \"Date \",\n \"required\": false,\n \"name\": \"Attempted On\",\n \"inputType\": \"date\"\n }\n ]\n }\n }\n}"},"url":"{{host}}/api/data/v1/form/create","urlObject":{"path":["api","data","v1","form","create"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"00dd6458-be55-46b5-a261-26b22f518f7d","name":"200 SUCCESS. \"The Create Form Data\" operation was successful !","originalRequest":{"method":"POST","header":[{"key":"sec-ch-ua","value":"\"Google Chrome\";v=\"111\", \"Not(A:Brand\";v=\"8\", \"Chromium\";v=\"111\"","type":"text"},{"key":"ts","value":"2023-04-10T18:26:14+05:30","type":"text"},{"key":"X-msgid","value":"1436a7ae-36ea-4d1d-bfeb-13312303bcd6","type":"text"},{"key":"X-Org-code","value":"0137541424673095687","type":"text"},{"key":"X-Source","value":"web","type":"text"},{"key":"X-Session-ID","value":"c880519f-3ad6-4793-9a41-b54c53ed529a","type":"text"},{"key":"X-Request-ID","value":"1436a7ae-36ea-4d1d-bfeb-13312303bcd6","type":"text"},{"key":"sec-ch-ua-platform","value":"\"macOS\"","type":"text"},{"key":"X-Channel-Id","value":"0137541424673095687","type":"text"},{"key":"X-App-Id","value":"dev.sunbird.portal","type":"text"},{"key":"X-App-Version","value":"5.2.0","type":"text"},{"key":"sec-ch-ua-mobile","value":"?0","type":"text"},{"key":"User-Agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Referer","value":"https://dev.sunbirded.org/","type":"text"},{"key":"X-Device-ID","value":"aadb6a334472c7c01cf282c90c3e9981","type":"text"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"type\": \"contentcategory-test\",\n \"subType\": \"global-test\",\n \"action\": \"search\",\n \"framework\": \"*\",\n\t\t\"rootOrgId\": \"*\",\n \t\"component\": \"portal\",\n \"data\": {\n \"templateName\": \"defaultTemplate\",\n \"action\": \"search\",\n \"fields\": [\n {\n \"code\": \"date\",\n \"visible\": true,\n \"editable\": true,\n \"displayProperty\": \"Editable\",\n \"dataType\": \"text\",\n \"renderingHints\": {\n \"semanticColumnWidth\": \"four\"\n },\n \"description\": \"Date\",\n \"index\": 7,\n \"label\": \"Date \",\n \"required\": false,\n \"name\": \"Attempted On\",\n \"inputType\": \"date\"\n }\n ]\n }\n }\n}"},"url":"https://dev.sunbirded.org/api/data/v1/form/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 13 Apr 2023 11:04:52 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"244"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit-hour","value":"30000"},{"key":"X-RateLimit-Remaining-hour","value":"29998"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Powered-By","value":"Express"},{"key":"ETag","value":"W/\"f4-8WWtGOXrtO6MCrrpevzgLUlRgqw\""},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Kong-Upstream-Latency","value":"6"},{"key":"X-Kong-Proxy-Latency","value":"9"},{"key":"Via","value":"kong/0.14.1"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.form.create\",\n \"params\": {\n \"resmsgid\": \"bb6c9650-5a04-44e8-9077-452ef7aa5cdf\",\n \"msgid\": \"6f64bd31-cf55-4f80-9f13-d19a799fe6fa\",\n \"status\": \"successful\"\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"created\": \"OK\"\n },\n \"ts\": \"2023-04-13T11:04:52.333Z\",\n \"ver\": \"1.0\"\n}"},{"id":"de091b4e-8c7a-45fc-9997-2aa9480a94b7","name":"200 SUCCESS. \"The Create Form Data\" operation was successful !","originalRequest":{"method":"POST","header":[{"key":"sec-ch-ua","value":"\"Google Chrome\";v=\"111\", \"Not(A:Brand\";v=\"8\", \"Chromium\";v=\"111\"","type":"text"},{"key":"ts","value":"2023-04-10T18:26:14+05:30","type":"text"},{"key":"X-msgid","value":"1436a7ae-36ea-4d1d-bfeb-13312303bcd6","type":"text"},{"key":"X-Org-code","value":"0137541424673095687","type":"text"},{"key":"X-Source","value":"web","type":"text"},{"key":"X-Session-ID","value":"c880519f-3ad6-4793-9a41-b54c53ed529a","type":"text"},{"key":"X-Request-ID","value":"1436a7ae-36ea-4d1d-bfeb-13312303bcd6","type":"text"},{"key":"sec-ch-ua-platform","value":"\"macOS\"","type":"text"},{"key":"X-Channel-Id","value":"0137541424673095687","type":"text"},{"key":"X-App-Id","value":"dev.sunbird.portal","type":"text"},{"key":"X-App-Version","value":"5.2.0","type":"text"},{"key":"sec-ch-ua-mobile","value":"?0","type":"text"},{"key":"User-Agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Referer","value":"https://dev.sunbirded.org/","type":"text"},{"key":"X-Device-ID","value":"aadb6a334472c7c01cf282c90c3e9981","type":"text"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"type\": \"contentcategory-test1\",\n \"subType\": \"global-test1\",\n \"action\": \"search\",\n \"framework\": \"12345\",\n\t\t\"rootOrgId\": \"123456\",\n \t\"component\": \"portal\",\n \"data\": {\n \"templateName\": \"defaultTemplate\",\n \"action\": \"search\",\n \"fields\": [\n {\n \"code\": \"date\",\n \"visible\": true,\n \"editable\": true,\n \"displayProperty\": \"Editable\",\n \"dataType\": \"text\",\n \"renderingHints\": {\n \"semanticColumnWidth\": \"four\"\n },\n \"description\": \"Date\",\n \"index\": 7,\n \"label\": \"Date \",\n \"required\": false,\n \"name\": \"Attempted On\",\n \"inputType\": \"date\"\n }\n ]\n }\n }\n}"},"url":"{{host}}/api/data/v1/form/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 13 Apr 2023 11:11:34 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"244"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit-hour","value":"30000"},{"key":"X-RateLimit-Remaining-hour","value":"29988"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Powered-By","value":"Express"},{"key":"ETag","value":"W/\"f4-8R0pnl577ZEbhK3OTWvyfIZnU6U\""},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Kong-Upstream-Latency","value":"7"},{"key":"X-Kong-Proxy-Latency","value":"159"},{"key":"Via","value":"kong/0.14.1"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.form.create\",\n \"params\": {\n \"resmsgid\": \"6b4d7060-1850-43f7-be92-c8e7f54a5cd5\",\n \"msgid\": \"095bef64-dacb-4281-819a-f2dbea957b95\",\n \"status\": \"successful\"\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"created\": \"OK\"\n },\n \"ts\": \"2023-04-13T11:11:34.894Z\",\n \"ver\": \"1.0\"\n}"},{"id":"fdce32c0-2a54-4f9b-9d65-235489a2fe6b","name":"200 SUCCESS. \"The Create Form Data\" operation was successful !","originalRequest":{"method":"POST","header":[{"key":"sec-ch-ua","value":"\"Google Chrome\";v=\"111\", \"Not(A:Brand\";v=\"8\", \"Chromium\";v=\"111\"","type":"text"},{"key":"ts","value":"2023-04-10T18:26:14+05:30","type":"text"},{"key":"X-msgid","value":"1436a7ae-36ea-4d1d-bfeb-13312303bcd6","type":"text"},{"key":"X-Org-code","value":"0137541424673095687","type":"text"},{"key":"X-Source","value":"web","type":"text"},{"key":"X-Session-ID","value":"c880519f-3ad6-4793-9a41-b54c53ed529a","type":"text"},{"key":"X-Request-ID","value":"1436a7ae-36ea-4d1d-bfeb-13312303bcd6","type":"text"},{"key":"sec-ch-ua-platform","value":"\"macOS\"","type":"text"},{"key":"X-Channel-Id","value":"0137541424673095687","type":"text"},{"key":"X-App-Id","value":"dev.sunbird.portal","type":"text"},{"key":"X-App-Version","value":"5.2.0","type":"text"},{"key":"sec-ch-ua-mobile","value":"?0","type":"text"},{"key":"User-Agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Referer","value":"https://dev.sunbirded.org/","type":"text"},{"key":"X-Device-ID","value":"aadb6a334472c7c01cf282c90c3e9981","type":"text"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"type\": \"contentcategory-test2\",\n \"subType\": \"global-test2\",\n \"action\": \"create\",\n \t\"component\": \"portal\",\n \"data\": {\n \"templateName\": \"defaultTemplate\",\n \"action\": \"search\",\n \"fields\": [\n {\n \"code\": \"date\",\n \"visible\": true,\n \"editable\": true,\n \"displayProperty\": \"Editable\",\n \"dataType\": \"text\",\n \"renderingHints\": {\n \"semanticColumnWidth\": \"four\"\n },\n \"description\": \"Date\",\n \"index\": 7,\n \"label\": \"Date \",\n \"required\": false,\n \"name\": \"Attempted On\",\n \"inputType\": \"date\"\n }\n ]\n }\n }\n}"},"url":"{{host}}/api/data/v1/form/create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 13 Apr 2023 12:02:26 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"244"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit-hour","value":"30000"},{"key":"X-RateLimit-Remaining-hour","value":"29999"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Powered-By","value":"Express"},{"key":"ETag","value":"W/\"f4-oSRYsbpW3cFCl9SQMH3zLEwTDY0\""},{"key":"set-cookie","value":"connect.sid=s%3AVIN255h_e6UoiZEc3UvqqM1rZguFYF-N.YZrrREC3iEeA93dSroKD1GB4fxxt3ZKTUF6ocO5Enow; Path=/; Expires=Thu, 13 Apr 2023 12:32:26 GMT; HttpOnly"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Kong-Upstream-Latency","value":"21"},{"key":"X-Kong-Proxy-Latency","value":"133"},{"key":"Via","value":"kong/0.14.1"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.form.create\",\n \"params\": {\n \"resmsgid\": \"b7ffac8f-60f0-4e3e-8435-2ebcad3ccdf3\",\n \"msgid\": \"b162e159-b737-48bb-b721-b0064d001f87\",\n \"status\": \"successful\"\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"created\": \"OK\"\n },\n \"ts\": \"2023-04-13T12:02:26.806Z\",\n \"ver\": \"1.0\"\n}"},{"id":"86f99b6f-11f5-4295-b50c-6ee2ccccd4fb","name":"400 BAD REQUEST. \"Create Form Data\" operation failed. You may have missed input for a mandatory parameter.","originalRequest":{"method":"POST","header":[{"key":"sec-ch-ua","value":"\"Google Chrome\";v=\"111\", \"Not(A:Brand\";v=\"8\", \"Chromium\";v=\"111\"","type":"text"},{"key":"ts","value":"2023-04-10T18:26:14+05:30","type":"text"},{"key":"X-msgid","value":"1436a7ae-36ea-4d1d-bfeb-13312303bcd6","type":"text"},{"key":"X-Org-code","value":"0137541424673095687","type":"text"},{"key":"X-Source","value":"web","type":"text"},{"key":"X-Session-ID","value":"c880519f-3ad6-4793-9a41-b54c53ed529a","type":"text"},{"key":"X-Request-ID","value":"1436a7ae-36ea-4d1d-bfeb-13312303bcd6","type":"text"},{"key":"sec-ch-ua-platform","value":"\"macOS\"","type":"text"},{"key":"X-Channel-Id","value":"0137541424673095687","type":"text"},{"key":"X-App-Id","value":"dev.sunbird.portal","type":"text"},{"key":"X-App-Version","value":"5.2.0","type":"text"},{"key":"sec-ch-ua-mobile","value":"?0","type":"text"},{"key":"User-Agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Referer","value":"https://dev.sunbirded.org/","type":"text"},{"key":"X-Device-ID","value":"aadb6a334472c7c01cf282c90c3e9981","type":"text"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"type\": \"\",\n \"subType\": \"\",\n \"action\": \"search\",\n \"framework\": \"*\",\n\t\t\"rootOrgId\": \"*\",\n \t\"component\": \"portal\",\n \"data\": {\n \"templateName\": \"defaultTemplate\",\n \"action\": \"search\",\n \"fields\": [\n {\n \"code\": \"date\",\n \"visible\": true,\n \"editable\": true,\n \"displayProperty\": \"Editable\",\n \"dataType\": \"text\",\n \"renderingHints\": {\n \"semanticColumnWidth\": \"four\"\n },\n \"description\": \"Date\",\n \"index\": 7,\n \"label\": \"Date \",\n \"required\": false,\n \"name\": \"Attempted On\",\n \"inputType\": \"date\"\n }\n ]\n }\n }\n}"},"url":"{{host}}/api/data/v1/form/create"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 13 Apr 2023 11:06:06 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"355"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit-hour","value":"30000"},{"key":"X-RateLimit-Remaining-hour","value":"29996"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Powered-By","value":"Express"},{"key":"ETag","value":"W/\"163-xdC+1g7rR9s11Ed9vA3pUUM7B9g\""},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Kong-Upstream-Latency","value":"8"},{"key":"X-Kong-Proxy-Latency","value":"25"},{"key":"Via","value":"kong/0.14.1"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.form.create\",\n \"params\": {\n \"resmsgid\": \"599e9213-997e-429e-b45a-154d1026e7cf\",\n \"msgid\": \"28924801-e93f-4d6d-9114-bc02a3176241\",\n \"status\": \"failed\",\n \"err\": \"ERR_CREATE_FORM_DATA\",\n \"errmsg\": [\n \"\\\"type\\\" is not allowed to be empty\",\n \"\\\"subType\\\" is not allowed to be empty\"\n ]\n },\n \"responseCode\": \"CLIENT_ERROR\",\n \"result\": {},\n \"ts\": \"2023-04-13T11:06:06.547Z\",\n \"ver\": \"1.0\"\n}"},{"id":"784b4132-e6cd-42a1-87a1-0f8339c2176a","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[{"key":"sec-ch-ua","value":"\"Google Chrome\";v=\"111\", \"Not(A:Brand\";v=\"8\", \"Chromium\";v=\"111\"","type":"text"},{"key":"ts","value":"2023-04-10T18:26:14+05:30","type":"text"},{"key":"X-msgid","value":"1436a7ae-36ea-4d1d-bfeb-13312303bcd6","type":"text"},{"key":"X-Org-code","value":"0137541424673095687","type":"text"},{"key":"X-Source","value":"web","type":"text"},{"key":"X-Session-ID","value":"c880519f-3ad6-4793-9a41-b54c53ed529a","type":"text"},{"key":"X-Request-ID","value":"1436a7ae-36ea-4d1d-bfeb-13312303bcd6","type":"text"},{"key":"sec-ch-ua-platform","value":"\"macOS\"","type":"text"},{"key":"X-Channel-Id","value":"0137541424673095687","type":"text"},{"key":"X-App-Id","value":"dev.sunbird.portal","type":"text"},{"key":"X-App-Version","value":"5.2.0","type":"text"},{"key":"sec-ch-ua-mobile","value":"?0","type":"text"},{"key":"User-Agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Referer","value":"https://dev.sunbirded.org/","type":"text"},{"key":"X-Device-ID","value":"aadb6a334472c7c01cf282c90c3e9981","type":"text"}],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"type\": \"\",\n \"subType\": \"\",\n \"action\": \"search\",\n \"framework\": \"*\",\n\t\t\"rootOrgId\": \"*\",\n \t\"component\": \"portal\",\n \"data\": {\n \"templateName\": \"defaultTemplate\",\n \"action\": \"search\",\n \"fields\": [\n {\n \"code\": \"date\",\n \"visible\": true,\n \"editable\": true,\n \"displayProperty\": \"Editable\",\n \"dataType\": \"text\",\n \"renderingHints\": {\n \"semanticColumnWidth\": \"four\"\n },\n \"description\": \"Date\",\n \"index\": 7,\n \"label\": \"Date \",\n \"required\": false,\n \"name\": \"Attempted On\",\n \"inputType\": \"date\"\n }\n ]\n }\n }\n}"},"url":"{{host}}/api/data/v1/form/create"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 13 Apr 2023 11:08:44 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"27"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"}],"_postman_id":"334c039f-aaee-402c-b1d3-927b2f761d2b"}],"id":"e046cdfb-132f-4237-a3bc-4907e7646048","description":"

This API is used to create a form with default fields using meta data

\n\n
AUTHORIZATIONS:
\n

bearer

\n
HEADER PARAMETERS
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Authorization (Required*)string
To make use of any User API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.
Content-Type (Required*)string
The Content Type entity is the media type of the resource. Possible media types can be:-

Application/json
Multipart/form-data
Application/x-www-form-urlencoded
\n
REQUEST BODY SCHEMA: application/json
\n

The body refers to the format of the request.

\n\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MetaDataDescription
requestobject
type (Required *)varchar
Represents the type of form being created
Ex: content, user, forum, app, program-dashboard, config
subtype (Required *)varchar
Represents the sub-category of form being created
Ex: course, collection, textbook, resource, login
action (Required *)varchar
Represents the user action on the form
Ex: filter, create, get, save, review , search
componentvarchar
Represents the consumption platform for the form
Ex: portal, mobile
root_org ( Required *)varchar
Represents the form accesabilty to all (*) or specific
framework (Required *)varchar
Represents the form accesabilty to all (*) or specific
created_ontimestamp
last_modified_ontimestamp
\n
","_postman_id":"e046cdfb-132f-4237-a3bc-4907e7646048"},{"name":"Update","item":[{"name":"Update Form","id":"64ca466e-3cf3-441c-8da7-026dd3804453","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"type\": \"\",\n \"subType\": \"\",\n \"action\": \"search\",\n \"framework\": \"*\",\n\t\t\"rootOrgId\": \"*\",\n \t\"component\": \"portal\",\n \"data\": {\n \"templateName\": \"defaultTemplate\",\n \"action\": \"search\",\n \"fields\": [\n {\n \"code\": \"date\",\n \"visible\": true,\n \"editable\": true,\n \"displayProperty\": \"Editable\",\n \"dataType\": \"text\",\n \"renderingHints\": {\n \"semanticColumnWidth\": \"four\"\n },\n \"description\": \"InvoiceDate\",\n \"index\": 8,\n \"label\": \"Date \",\n \"required\": false,\n \"name\": \"Attempted On\",\n \"inputType\": \"date\"\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/data/v1/form/update","description":"
RESPONSE SCHEMA: application/json
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MetaDataDescription
id (Required*)string
Represents the ID of the request which was made
ver (Required*)string
Represents the version of the API which was used
ets (Required*)integer
Represents the EPOCH (UTC) timestamp in milliseconds since EPOCH
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MetaDataDescription
params (Required*)object
msgid (Required*)string
Represents the ID of the message sent
resmsgid (Required*)string
Represents the ID of the response message
status (Required*)string
Enum: \"success\" \"error\"
responseCodestring
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
MetaDataDescription
resultobject
responseobject
rootOrgIdstring
keystring
statusstring
\n
","urlObject":{"path":["api","data","v1","form","update"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"b1d1721a-c68a-4a2f-9e7d-565b5626344e","name":"200 SUCCESS. \"The Update Form Data\" operation was successful !","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"type\": \"contentcategory-test\",\n \"subType\": \"global-test\",\n \"action\": \"search\",\n \"framework\": \"*\",\n\t\t\"rootOrgId\": \"*\",\n \t\"component\": \"portal\",\n \"data\": {\n \"templateName\": \"defaultTemplate\",\n \"action\": \"search\",\n \"fields\": [\n {\n \"code\": \"date\",\n \"visible\": true,\n \"editable\": true,\n \"displayProperty\": \"Editable\",\n \"dataType\": \"text\",\n \"renderingHints\": {\n \"semanticColumnWidth\": \"four\"\n },\n \"description\": \"InvoiceDate\",\n \"index\": 8,\n \"label\": \"Date \",\n \"required\": false,\n \"name\": \"Attempted On\",\n \"inputType\": \"date\"\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://dev.sunbirded.org/api/data/v1/form/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 13 Apr 2023 12:27:42 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-RateLimit-Limit-hour","value":"30000"},{"key":"X-RateLimit-Remaining-hour","value":"29999"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Powered-By","value":"Express"},{"key":"ETag","value":"W/\"14e-VPQhxk4gHYsfRgW0l1eV7C+s5r8\""},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Kong-Upstream-Latency","value":"16"},{"key":"X-Kong-Proxy-Latency","value":"16"},{"key":"Via","value":"kong/0.14.1"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.form.update\",\n \"params\": {\n \"resmsgid\": \"9e2f4f7b-2ea2-4481-a350-1b48a3ff9465\",\n \"msgid\": \"d093862a-79df-469d-9f30-3dc49bc354dc\",\n \"status\": \"successful\"\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"response\": [\n {\n \"rootOrgId\": \"*\",\n \"key\": \"contentcategory-test.global-test.search.portal\",\n \"status\": \"SUCCESS\"\n }\n ]\n },\n \"ts\": \"2023-04-13T12:27:42.025Z\",\n \"ver\": \"1.0\"\n}"},{"id":"b6f9f977-549b-443a-ae94-696f118ad524","name":"500 Internal Server Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"type\": \"contentcategory-test\",\n \"subType\": \"global-test\",\n \"action\": \"search\",\n \"data\": {\n \"templateName\": \"defaultTemplate\",\n \"action\": \"search\",\n \"fields\": [\n {\n \"code\": \"date\",\n \"visible\": true,\n \"editable\": true,\n \"displayProperty\": \"Editable\",\n \"dataType\": \"text\",\n \"renderingHints\": {\n \"semanticColumnWidth\": \"four\"\n },\n \"description\": \"InvoiceDate\",\n \"index\": 9,\n \"label\": \"InvDate\",\n \"required\": false,\n \"name\": \"Attempted On\",\n \"inputType\": \"date\"\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/data/v1/form/update"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 13 Apr 2023 12:32:24 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"335"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit-hour","value":"30000"},{"key":"X-RateLimit-Remaining-hour","value":"29996"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Powered-By","value":"Express"},{"key":"ETag","value":"W/\"14f-VByhx5zo5FTJT2ilu0KGcK5F2cc\""},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Kong-Upstream-Latency","value":"8"},{"key":"X-Kong-Proxy-Latency","value":"5"},{"key":"Via","value":"kong/0.14.1"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.form.update\",\n \"params\": {\n \"resmsgid\": \"0422030c-d624-4842-990e-4a14e0437300\",\n \"msgid\": \"169977a1-1801-4b97-947c-d23b5f3dbf93\",\n \"status\": \"failed\",\n \"err\": \"ERR_UPDATE_FORM_DATA\",\n \"errmsg\": \"invalid request, no records found for the match to update!\"\n },\n \"responseCode\": \"CLIENT_ERROR\",\n \"result\": {},\n \"ts\": \"2023-04-13T12:32:24.589Z\",\n \"ver\": \"1.0\"\n}"},{"id":"ab938e61-1153-412f-a212-5d69ec4e4e56","name":"400 BAD REQUEST. \"Create Form Data\" operation failed. You may have missed input for a mandatory parameter.","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"type\": \"\",\n \"subType\": \"\",\n \"action\": \"search\",\n \"framework\": \"*\",\n\t\t\"rootOrgId\": \"*\",\n \t\"component\": \"portal\",\n \"data\": {\n \"templateName\": \"defaultTemplate\",\n \"action\": \"search\",\n \"fields\": [\n {\n \"code\": \"date\",\n \"visible\": true,\n \"editable\": true,\n \"displayProperty\": \"Editable\",\n \"dataType\": \"text\",\n \"renderingHints\": {\n \"semanticColumnWidth\": \"four\"\n },\n \"description\": \"InvoiceDate\",\n \"index\": 8,\n \"label\": \"Date \",\n \"required\": false,\n \"name\": \"Attempted On\",\n \"inputType\": \"date\"\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/data/v1/form/update"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 13 Apr 2023 12:33:33 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"355"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit-hour","value":"30000"},{"key":"X-RateLimit-Remaining-hour","value":"29995"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Powered-By","value":"Express"},{"key":"ETag","value":"W/\"163-68AUZYlbFXw5BC3czTl013X4wXQ\""},{"key":"set-cookie","value":"connect.sid=s%3A2hv5cmSY8yTEYespCQme3DMvA-2G94Sf.WSA%2F01NEAaDDCm7TQDUuvdbbnDE05eS%2BEogUA3YqSSo; Path=/; Expires=Thu, 13 Apr 2023 13:03:33 GMT; HttpOnly"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Kong-Upstream-Latency","value":"89"},{"key":"X-Kong-Proxy-Latency","value":"15"},{"key":"Via","value":"kong/0.14.1"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.form.update\",\n \"params\": {\n \"resmsgid\": \"052e76fa-6927-4246-b0aa-efaeeb328a29\",\n \"msgid\": \"bb8c6bdc-f391-44c5-888f-071899232781\",\n \"status\": \"failed\",\n \"err\": \"ERR_UPDATE_FORM_DATA\",\n \"errmsg\": [\n \"\\\"type\\\" is not allowed to be empty\",\n \"\\\"subType\\\" is not allowed to be empty\"\n ]\n },\n \"responseCode\": \"CLIENT_ERROR\",\n \"result\": {},\n \"ts\": \"2023-04-13T12:33:33.514Z\",\n \"ver\": \"1.0\"\n}"},{"id":"df25aa55-4f2d-4672-bd15-7b4097787a7e","name":"401 Unauthorized","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"request\": {\n \"type\": \"\",\n \"subType\": \"\",\n \"action\": \"search\",\n \"framework\": \"*\",\n\t\t\"rootOrgId\": \"*\",\n \t\"component\": \"portal\",\n \"data\": {\n \"templateName\": \"defaultTemplate\",\n \"action\": \"search\",\n \"fields\": [\n {\n \"code\": \"date\",\n \"visible\": true,\n \"editable\": true,\n \"displayProperty\": \"Editable\",\n \"dataType\": \"text\",\n \"renderingHints\": {\n \"semanticColumnWidth\": \"four\"\n },\n \"description\": \"InvoiceDate\",\n \"index\": 8,\n \"label\": \"Date \",\n \"required\": false,\n \"name\": \"Attempted On\",\n \"inputType\": \"date\"\n }\n ]\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{host}}/api/data/v1/form/update"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 13 Apr 2023 12:37:19 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"27"},{"key":"Connection","value":"keep-alive"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Unauthorized\"\n}"}],"_postman_id":"64ca466e-3cf3-441c-8da7-026dd3804453"}],"id":"65956922-f431-49b5-af92-9755bfa6256e","description":"

This API is used to update the form metadata as per the requirement or choice

\n\n","_postman_id":"65956922-f431-49b5-af92-9755bfa6256e"},{"name":"Read","item":[{"name":"Read Form","event":[{"listen":"test","script":{"exec":["pm.test(\"Response status code is 200\", function () {"," pm.expect(pm.response.code).to.equal(200);","});","","","pm.test(\"Id is a non-empty string\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData.id).to.be.a('string').and.to.have.lengthOf.at.least(1, \"Value should not be empty\");","});","","","pm.test(\"Params should have required fields - resmsgid, msgid, and status\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.params).to.exist.and.to.be.an('object');"," pm.expect(responseData.params.resmsgid).to.exist.and.to.be.a('string');"," pm.expect(responseData.params.msgid).to.exist.and.to.be.a('string');"," pm.expect(responseData.params.status).to.exist.and.to.be.a('string');","});","","","pm.test(\"Response code is a non-empty string\", function () {"," const responseData = pm.response.json();",""," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.responseCode).to.exist.and.to.be.a('string').and.to.have.lengthOf.at.least(1, \"Value should not be empty\");","});","","","pm.test(\"Result has the required fields\", function () {"," const responseData = pm.response.json();"," "," pm.expect(responseData).to.be.an('object');"," pm.expect(responseData.result).to.exist.and.to.be.an('object');"," pm.expect(responseData.result.form).to.exist.and.to.be.an('object');"," pm.expect(responseData.result.ts).to.exist.and.to.be.a('string');"," pm.expect(responseData.result.ver).to.exist.and.to.be.a('string');","});"],"type":"text/javascript"}}],"id":"d0442bb5-8599-434c-93a0-1bd9d965e443","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"sec-ch-ua","value":"\"Google Chrome\";v=\"111\", \"Not(A:Brand\";v=\"8\", \"Chromium\";v=\"111\"","type":"text"},{"key":"ts","value":"2023-04-10T18:26:14+05:30","type":"text"},{"key":"X-msgid","value":"1436a7ae-36ea-4d1d-bfeb-13312303bcd6","type":"text"},{"key":"X-Org-code","value":"0137541424673095687","type":"text"},{"key":"X-Source","value":"web","type":"text"},{"key":"X-Session-ID","value":"c880519f-3ad6-4793-9a41-b54c53ed529a","type":"text"},{"key":"X-Request-ID","value":"1436a7ae-36ea-4d1d-bfeb-13312303bcd6","type":"text"},{"key":"sec-ch-ua-platform","value":"\"macOS\"","type":"text"},{"key":"X-Channel-Id","value":"0137541424673095687","type":"text"},{"key":"X-App-Id","value":"dev.sunbird.portal","type":"text"},{"key":"X-App-Version","value":"5.2.0","type":"text"},{"key":"sec-ch-ua-mobile","value":"?0","type":"text"},{"key":"User-Agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Referer","value":"https://dev.sunbirded.org/","type":"text"},{"key":"X-Device-ID","value":"aadb6a334472c7c01cf282c90c3e9981","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"api.form.read\",\n \"ver\": \"v1\",\n \"ets\": 0,\n \"params\": {\n \"msgid\": null,\n \"did\": null\n },\n \"request\": {\n \"type\": \"user\",\n \"subType\": \"exclusion\",\n \"action\": \"onboarding\",\n \"component\": \"portal\",\n \"framework\": \"*\",\n \"rootOrgId\": \"0126796199493140480\"\n }\n}"},"url":"{{host}}/api/data/v1/form/read\n","urlObject":{"path":["api","data","v1","form","read\n"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"dbc55428-058c-43b6-a4df-631a90551134","name":"200 SUCCESS. \"The Read Form Data\" operation was successful !","originalRequest":{"method":"POST","header":[{"key":"sec-ch-ua","value":"\"Google Chrome\";v=\"111\", \"Not(A:Brand\";v=\"8\", \"Chromium\";v=\"111\"","type":"text"},{"key":"ts","value":"2023-04-10T18:26:14+05:30","type":"text"},{"key":"X-msgid","value":"1436a7ae-36ea-4d1d-bfeb-13312303bcd6","type":"text"},{"key":"X-Org-code","value":"0137541424673095687","type":"text"},{"key":"X-Source","value":"web","type":"text"},{"key":"X-Session-ID","value":"c880519f-3ad6-4793-9a41-b54c53ed529a","type":"text"},{"key":"X-Request-ID","value":"1436a7ae-36ea-4d1d-bfeb-13312303bcd6","type":"text"},{"key":"sec-ch-ua-platform","value":"\"macOS\"","type":"text"},{"key":"X-Channel-Id","value":"0137541424673095687","type":"text"},{"key":"X-App-Id","value":"dev.sunbird.portal","type":"text"},{"key":"X-App-Version","value":"5.2.0","type":"text"},{"key":"sec-ch-ua-mobile","value":"?0","type":"text"},{"key":"User-Agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Referer","value":"https://dev.sunbirded.org/","type":"text"},{"key":"X-Device-ID","value":"aadb6a334472c7c01cf282c90c3e9981","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"api.form.read\",\n \"ver\": \"v1\",\n \"ets\": 0,\n \"params\": {\n \"msgid\": null,\n \"did\": null\n },\n \"request\": {\n \"type\": \"user\",\n \"subType\": \"exclusion\",\n \"action\": \"onboarding\",\n \"component\": \"portal\",\n \"framework\": \"*\",\n \"rootOrgId\": \"0126796199493140480\"\n }\n}"},"url":"https://dev.sunbirded.org/api/data/v1/form/read\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 10 Apr 2023 13:11:38 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-RateLimit-Limit-hour","value":"30000"},{"key":"X-RateLimit-Remaining-hour","value":"29995"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Powered-By","value":"Express"},{"key":"ETag","value":"W/\"219-AICQRODeDv9zbr1aG0EmvOyX7BQ\""},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Kong-Upstream-Latency","value":"14"},{"key":"X-Kong-Proxy-Latency","value":"67"},{"key":"Via","value":"kong/0.14.1"},{"key":"X-Proxy-Cache","value":"MISS"},{"key":"X-Proxy-Cache-Date","value":"Mon, 10 Apr 2023 13:11:38 GMT"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.form.read\",\n \"params\": {\n \"resmsgid\": \"0afa7b65-06b6-4320-a0e4-ddb2e202db65\",\n \"msgid\": \"cc69f3ef-2c06-45f0-836d-9f0c08529090\",\n \"status\": \"successful\"\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"form\": {\n \"type\": \"user\",\n \"subtype\": \"exclusion\",\n \"action\": \"onboarding\",\n \"component\": \"portal\",\n \"framework\": \"*\",\n \"data\": {\n \"templateName\": \"defaultTemplate\",\n \"action\": \"get\",\n \"fields\": [\n \"/certs/\",\n \"/signup/\",\n \"/recover/\",\n \"/sign-in/\",\n \"/get/dial/\"\n ]\n },\n \"created_on\": \"2023-03-30T12:52:21.188Z\",\n \"last_modified_on\": null,\n \"rootOrgId\": \"*\"\n }\n },\n \"ts\": \"2023-04-10T13:11:38.459Z\",\n \"ver\": \"1.0\"\n}"},{"id":"779bccde-4895-405b-ad78-fe07b52554e1","name":"200 SUCCESS. \"The Read Form Data\" operation was successful !","originalRequest":{"method":"POST","header":[{"key":"sec-ch-ua","value":"\"Google Chrome\";v=\"111\", \"Not(A:Brand\";v=\"8\", \"Chromium\";v=\"111\"","type":"text"},{"key":"ts","value":"2023-04-10T18:26:14+05:30","type":"text"},{"key":"X-msgid","value":"1436a7ae-36ea-4d1d-bfeb-13312303bcd6","type":"text"},{"key":"X-Org-code","value":"0137541424673095687","type":"text"},{"key":"X-Source","value":"web","type":"text"},{"key":"X-Session-ID","value":"c880519f-3ad6-4793-9a41-b54c53ed529a","type":"text"},{"key":"X-Request-ID","value":"1436a7ae-36ea-4d1d-bfeb-13312303bcd6","type":"text"},{"key":"sec-ch-ua-platform","value":"\"macOS\"","type":"text"},{"key":"X-Channel-Id","value":"0137541424673095687","type":"text"},{"key":"X-App-Id","value":"dev.sunbird.portal","type":"text"},{"key":"X-App-Version","value":"5.2.0","type":"text"},{"key":"sec-ch-ua-mobile","value":"?0","type":"text"},{"key":"User-Agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Referer","value":"https://dev.sunbirded.org/","type":"text"},{"key":"X-Device-ID","value":"aadb6a334472c7c01cf282c90c3e9981","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"api.form.read\",\n \"ver\": \"v1\",\n \"ets\": 0,\n \"params\": {\n \"msgid\": null,\n \"did\": null\n },\n \"request\": {\n \"type\": \"contentcategory-test\",\n \"subType\": \"global-test\",\n \"action\": \"search\",\n \"framework\": \"*\",\n \"rootOrgId\": \"*\",\n \"component\": \"portal\"\n }\n}"},"url":"{{host}}/api/data/v1/form/read\n"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 13 Apr 2023 12:40:43 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-RateLimit-Limit-hour","value":"30000"},{"key":"X-RateLimit-Remaining-hour","value":"29999"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Powered-By","value":"Express"},{"key":"ETag","value":"W/\"304-gFc29it5ZAYogZaU4sKbYkVC4VA\""},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Kong-Upstream-Latency","value":"9"},{"key":"X-Kong-Proxy-Latency","value":"7"},{"key":"Via","value":"kong/0.14.1"},{"key":"X-Proxy-Cache","value":"MISS"},{"key":"X-Proxy-Cache-Date","value":"Thu, 13 Apr 2023 12:40:43 GMT"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.form.read\",\n \"params\": {\n \"resmsgid\": \"eb2565cc-de21-4597-9881-efb49d987b09\",\n \"msgid\": \"ee043ef9-d347-4a6e-8fcd-9b99955e5067\",\n \"status\": \"successful\"\n },\n \"responseCode\": \"OK\",\n \"result\": {\n \"form\": {\n \"type\": \"contentcategory-test\",\n \"subtype\": \"global-test\",\n \"action\": \"search\",\n \"component\": \"portal\",\n \"framework\": \"*\",\n \"data\": {\n \"templateName\": \"defaultTemplate\",\n \"action\": \"search\",\n \"fields\": [\n {\n \"code\": \"date\",\n \"visible\": true,\n \"editable\": true,\n \"displayProperty\": \"Editable\",\n \"dataType\": \"text\",\n \"renderingHints\": {\n \"semanticColumnWidth\": \"four\"\n },\n \"description\": \"InvoiceDate\",\n \"index\": 8,\n \"label\": \"Date \",\n \"required\": false,\n \"name\": \"Attempted On\",\n \"inputType\": \"date\"\n }\n ]\n },\n \"created_on\": \"2023-04-13T11:08:21.260Z\",\n \"last_modified_on\": \"2023-04-13T12:35:52.143Z\",\n \"rootOrgId\": \"*\"\n }\n },\n \"ts\": \"2023-04-13T12:40:43.171Z\",\n \"ver\": \"1.0\"\n}"},{"id":"e0394d69-4f58-47ec-9fc5-c59bc28bc595","name":"400 BAD REQUEST. \"Read Form Data\" operation failed. You may have missed input for a mandatory parameter.","originalRequest":{"method":"POST","header":[{"key":"sec-ch-ua","value":"\"Google Chrome\";v=\"111\", \"Not(A:Brand\";v=\"8\", \"Chromium\";v=\"111\"","type":"text"},{"key":"ts","value":"2023-04-10T18:26:14+05:30","type":"text"},{"key":"X-msgid","value":"1436a7ae-36ea-4d1d-bfeb-13312303bcd6","type":"text"},{"key":"X-Org-code","value":"0137541424673095687","type":"text"},{"key":"X-Source","value":"web","type":"text"},{"key":"X-Session-ID","value":"c880519f-3ad6-4793-9a41-b54c53ed529a","type":"text"},{"key":"X-Request-ID","value":"1436a7ae-36ea-4d1d-bfeb-13312303bcd6","type":"text"},{"key":"sec-ch-ua-platform","value":"\"macOS\"","type":"text"},{"key":"X-Channel-Id","value":"0137541424673095687","type":"text"},{"key":"X-App-Id","value":"dev.sunbird.portal","type":"text"},{"key":"X-App-Version","value":"5.2.0","type":"text"},{"key":"sec-ch-ua-mobile","value":"?0","type":"text"},{"key":"User-Agent","value":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/111.0.0.0 Safari/537.36","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Accept","value":"application/json","type":"text"},{"key":"Referer","value":"https://dev.sunbirded.org/","type":"text"},{"key":"X-Device-ID","value":"aadb6a334472c7c01cf282c90c3e9981","type":"text"}],"body":{"mode":"raw","raw":"{\n \"id\": \"api.form.read\",\n \"ver\": \"v1\",\n \"ets\": 0,\n \"params\": {\n \"msgid\": null,\n \"did\": null\n },\n \"request\": {\n \"type\": \"\",\n \"subType\": \"\",\n \"action\": \"search\",\n \"framework\": \"*\",\n \"rootOrgId\": \"*\",\n \"component\": \"portal\"\n }\n}"},"url":"{{host}}/api/data/v1/form/read\n"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 13 Apr 2023 12:41:38 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"351"},{"key":"Connection","value":"keep-alive"},{"key":"X-RateLimit-Limit-hour","value":"30000"},{"key":"X-RateLimit-Remaining-hour","value":"29997"},{"key":"X-DNS-Prefetch-Control","value":"off"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"Strict-Transport-Security","value":"max-age=15552000; includeSubDomains"},{"key":"X-Download-Options","value":"noopen"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Powered-By","value":"Express"},{"key":"ETag","value":"W/\"15f-OHcnWlJLqoa+uaZcF+SxWb4siZw\""},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Kong-Upstream-Latency","value":"4"},{"key":"X-Kong-Proxy-Latency","value":"13"},{"key":"Via","value":"kong/0.14.1"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"api.form.read\",\n \"params\": {\n \"resmsgid\": \"5989ed82-d665-4313-85d2-21d81bdfb505\",\n \"msgid\": \"25302102-78b6-4854-a691-2a31490a6f79\",\n \"status\": \"failed\",\n \"err\": \"ERR_READ_FORM_DATA\",\n \"errmsg\": [\n \"\\\"type\\\" is not allowed to be empty\",\n \"\\\"subType\\\" is not allowed to be empty\"\n ]\n },\n \"responseCode\": \"CLIENT_ERROR\",\n \"result\": {},\n \"ts\": \"2023-04-13T12:41:38.961Z\",\n \"ver\": \"1.0\"\n}"}],"_postman_id":"d0442bb5-8599-434c-93a0-1bd9d965e443"}],"id":"1dcedb22-c605-43f6-82ee-c0b26f6c872f","description":"

This API is used to view and read the form data and other fields of the form

\n\n","_postman_id":"1dcedb22-c605-43f6-82ee-c0b26f6c872f"}]}