test content
","isAccessRestricted":true,"jsonSchemaResult":{},"thumbnail":"","serviceProviderId":"","customerId":"","siteId":""}}},"400":{"description":"Invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/blog/filter":{"post":{"tags":["Blog"],"description":"Gets blog list with filtering, sorting and pagination. It allows hierarchical level searching. It can be filtered using specified hierarchy or it uses the logged in user hierarchy. This gives the option to get additional entity fields in the response. Also provides configuration meta data about entity.","required":true,"parameters":[{"in":"body","name":"body","description":"Blog filtering and sorting","required":true,"schema":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"object","required":["columnName","type","filter"],"properties":{"columnName":{"type":"string"},"type":{"type":"string","enum":["distinctList","date","number","StringConditionFilter"]},"filter":{"type":"object","description":"This object can be any one of the type DistinctListFilter, DateFilter, NumberFilter or StringConditionFilter. Schema for the types has been given in models."}}},"example":[]},"sortOrder":{"type":"array","items":{"type":"object","properties":{"columnName":{"type":"string","description":"name of the field to sort"},"isAscending":{"type":"boolean","description":"false for descending order and true for ascending order"}}},"description":"To sort the result","example":[]},"primaryColumns":{"type":"array","items":{"type":"string"},"description":"To get additional fields in result","example":[]},"hierarchyLevel":{"type":"string","description":"To specify hierarchy level(e.g. serviceprovider, customer, site, device, sensor, root)","example":""},"hierarchyId":{"type":"string","description":"To get result for the specific hierarchy","example":""},"nPerPage":{"type":"number","description":"Page size of result","example":"50"},"pageNumber":{"type":"number","description":"Page number of result","example":"1"},"isConfigDetailRequired":{"type":"boolean","description":"To get configuration metadata, set the value to true","example":"false"},"getConfig":{"type":"boolean","description":"To get device config data only, set the value to true","example":"false"},"getChildOrParent":{"type":"boolean","description":"Additionally to get parent/child data, set the value to true","example":"false"}}}}],"responses":{"200":{"description":"Success","examples":{"application/json":{"dataResult":[{"_id":"62d76c65104ef771f6a11f0c","uniqueId":"62d76c65104ef771f6a11f0cas1209ji","title":"Blog 1","description":"description 1","accessLevel":"serviceprovider","isPublished":true,"publishedOn":1658285307,"createdBy":"developer-1@dev.de","createdOn":1658285307,"modifiedBy":"","modifiedOn":1658285307},{"_id":"62d76f78104ef771f6a11f0e","uniqueId":"156c67kiokio04ef771f6a11f0cas1209ji","title":"Blog 2","description":"description 2","accessLevel":"serviceprovider","isPublished":true,"publishedOn":1658285307,"createdBy":"developer-1@dev.de","createdOn":1658285307,"modifiedBy":"","modifiedOn":1658285307}],"totalRecordsCount":15}},"schema":{"type":"object","properties":{"dataResult":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"uniqueId":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"accessLevel":{"type":"string"},"isPublished":{"type":"boolean"},"publishedOn":{"type":"number"},"createdBy":{"type":"string"},"modifiedBy":{"type":"string"},"createdOn":{"type":"number"},"modifiedOn":{"type":"number"}}}}}}},"204":{"description":"No Content"},"400":{"description":"Invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/blog/{id}":{"get":{"tags":["Blog"],"description":"Get blog by Id","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"Success","examples":{"application/json":{"_id":"62ea2a8328c7c9","uniqueId":"afd49a39338dc","accessLevel":"site","createdBy":"developer-1@dev.de","createdOn":1659513475763,"modifiedBy":"developer-1@dev.de","modifiedOn":1659514047995,"title":"new blog","description":"desc","content":"test content
","isAccessRestricted":true,"jsonSchemaResult":{},"thumbnail":"","serviceProviderId":"","customerId":"","siteId":""}}},"400":{"description":"Invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"put":{"tags":["Blog"],"description":"Update an existing blog","required":true,"parameters":[{"name":"id","in":"path","required":true,"type":"string"},{"in":"body","name":"body","description":"To update a blog, provide the existing Id","required":true,"schema":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"content":{"type":"string"},"thumbnail":{"type":"string"},"jsonSchemaResult":{"type":"object"},"isAccessRestricted":{"type":"boolean"}}}}],"responses":{"200":{"description":"Success","examples":{"application/json":{"_id":"62ea2a8328c7c9","uniqueId":"afd49a39338dc","accessLevel":"site","createdBy":"developer-1@dev.de","createdOn":1659513475763,"modifiedBy":"developer-1@dev.de","modifiedOn":1659514047995,"title":"new blog","description":"desc","content":"test content
","isAccessRestricted":true,"jsonSchemaResult":{},"thumbnail":"","serviceProviderId":"","customerId":"","siteId":""}}},"400":{"description":"Invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"patch":{"tags":["Blog"],"description":"Patch to publish the blog","required":true,"parameters":[{"name":"id","in":"path","required":true,"type":"string"},{"in":"body","name":"body","description":"To publish the blog","required":true,"schema":{"type":"object","properties":{"isPublished":{"type":"boolean"}}}}],"responses":{"200":{"description":"Success","examples":{"application/json":{"isSuccess":true}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"delete":{"tags":["Blog"],"description":"Delete a blog by Id","parameters":[{"name":"id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"Success","examples":{"application/json":{"isSuccess":true}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/schedule":{"get":{"tags":["Schedule"],"parameters":[{"name":"entityId","in":"query","required":true,"type":"string","description":"Hierarchy level id like Site, Customer or Service provider ID."}],"description":"Get list of schedule associated with a hierarchy level id like Site, Customer or Service provider ID.","required":true,"responses":{"200":{"description":"Success","examples":{"application/json":{"errorCode":0,"errorMessage":"Details on error if any.","message":{"schedules":[{"id":"8a81fdd581cf1102820521f1bb08c5","entries":[{"id":"8a81fdd581cf1102018205251908c6","entryType":"DAY_OF_WEEK","startDate":1730116540,"endDate":1730116540,"dayOfWeek":"MONDAY","startTime":"09:00","endTime":"17:00","autoDelete":false,"autoDeleteAt":1730116540,"specialDayId":"","notes":"","_links":{"schedule":{"href":"http://talos.evalink.io/api/schedule-service/schedules/8a81fdd581cf110201820521bb08c5"}}}],"timeZone":"Europe/Berlin","name":"TEST","updatedAt":1657943696144}],"specialDays":[{"id":"8a809592716fa50171cb419a2e016c","name":"Weihnachten","month":"12","date":"25"}]}}},"schema":{"type":"object","properties":{"errorCode":{"type":"number","example":0,"description":"Zero if no error and negative number if some error."},"errorMessage":{"type":"string","example":"Invaid Account or ServiceProvider Details","description":"Details on error if any. If no error this field will not be there."},"message":{"type":"object","properties":{"schedules":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"8a81fdd581cf110201820525231908c6","description":"schedule ID."},"entries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"8a81fdd581cf110201820525231908c6","description":"Entry ID."},"entryType":{"type":"string","example":"DAY_OF_WEEK","enum":["DATE","DAY_OF_WEEK","SPECIAL_DAY","DATE_MULTIPLE","DATE_RANGE"],"description":"Type of entry."},"startDate":{"type":"string","example":"2022-07-13","description":"Start date for DATE_RANGE and DATE_MULTIPLE."},"endDate":{"type":"string","example":"2022-07-20","description":"End date for DATE_RANGE and DATE_MULTIPLE."},"dayOfWeek":{"type":"string","example":"MONDAY","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"description":"Day Of the week"},"startTime":{"type":"string","example":"09:21","description":"Start time."},"endTime":{"type":"string","example":"17:00","description":"End time."},"autoDelete":{"type":"boolean","example":false,"description":"Auto Delete enabled or not. This entry will be deleted in 24 hours automatically."},"autoDeleteAt":{"type":"number","example":1658389879907,"description":"Auto Delete time in milliseconds. By the time this entry will be deleted. Auto populated value."},"specialDayId":{"type":"string","example":"32ew21fwff23jkh3h313","description":"Special day ID."},"notes":{"type":"string","example":"Some text.","description":"Description about this entry."}}}},"timeZone":{"type":"string","example":"Europe/Berlin","description":"Clint side time zone. Auto populated value from which zone the new schedule is created. Can not be updated."},"name":{"type":"string","example":"TEST SCHEDULE","description":"Name of the schedule."},"updatedAt":{"type":"number","example":1658389879907,"description":"Updated time in milliseconds. Auto populated value."}}}},"specialDays":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"32ew21fwff23jkh3h313","description":"Special day ID."},"name":{"type":"string","example":"Neujahr","description":"Special day name."},"month":{"type":"string","example":"12","description":"Special day month."},"date":{"type":"string","example":"26","description":"Special day day."}}}}}}}}},"400":{"description":"Invalid input","examples":{"application/json":{"errorCode":"ERR001","errorDesc":"Invalid Request"}}},"403":{"description":"Forbidden"}}},"patch":{"tags":["Schedule"],"parameters":[{"name":"scheduleId","in":"query","required":true,"type":"string","description":"Schedule id to PATCH."},{"name":"hierarchyId","in":"query","required":true,"type":"string","description":"Hierarchy level id like Site, Customer or Service provider ID."},{"in":"body","name":"body","description":"Schedule payload","required":true,"schema":{"type":"object","properties":{"entries":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","example":"8a81fdd581cf110201820525231908c6","description":"Entry ID."},"entryType":{"type":"string","example":"DAY_OF_WEEK","enum":["DATE","DAY_OF_WEEK","SPECIAL_DAY","DATE_MULTIPLE","DATE_RANGE"],"description":"Type of entry."},"startDate":{"type":"string","example":"2022-07-13","description":"Start date for DATE_RANGE and DATE_MULTIPLE."},"endDate":{"type":"string","example":"2022-07-20","description":"End date for DATE_RANGE and DATE_MULTIPLE."},"dayOfWeek":{"type":"string","example":"MONDAY","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"description":"Day Of the week"},"startTime":{"type":"string","example":"09:21","description":"Start time."},"endTime":{"type":"string","example":"17:00","description":"End time."},"autoDelete":{"type":"boolean","example":false,"description":"Auto Delete enabled or not. This entry will be deleted in 24 hours automatically."},"autoDeleteAt":{"type":"number","example":1658389879907,"description":"Auto Delete time in milliseconds. By the time this entry will be deleted. Auto populated value."},"specialDayId":{"type":"string","example":"32ew21fwff23jkh3h313","description":"Special day ID."},"notes":{"type":"string","example":"Some text.","description":"Description about this entry."}}}},"name":{"type":"string","example":"TEST SCHEDULE","description":"Name of the schedule."}}}}],"description":"Patch schedule by schedule ID","required":true,"responses":{"200":{"description":"Success","examples":{"application/json":{"errorCode":0,"errorMessage":"Success"}}},"400":{"description":"Invalid input","examples":{"application/json":{"errorCode":"ERR001","errorDesc":"Invalid Request"}}},"403":{"description":"Forbidden"}}}},"/contact/all":{"get":{"tags":["Contact"],"parameters":[{"name":"hierarchyId","in":"query","required":true,"type":"string","description":"Hierarchy level id like Site, Customer or Service provider ID."}],"description":"Get list of contacts associated with a hierarchy level id like Site, Customer or Service provider ID.","required":true,"responses":{"200":{"description":"Success","examples":{"application/json":{"errorCode":0,"message":[{"id":"8a81b56781c990bb0181d22466bb007e","name":"Axxon test","description":"Site Contact - Automatically created","email":null,"codeword":null,"available":true,"type":"MANAGED","phones":[]},{"id":"8a81fc4581c9909401822538dbc70653","name":"John","description":"nxgen user contact","email":"test@nx.com","codeword":"NXG","available":true,"type":"STANDARD","phones":[{"id":"8a81fc4581c9909401822538dbc70654","number":"+919842999112","phoneType":"MAIN","customType":null}]}]}},"schema":{"type":"object","properties":{"errorCode":{"type":"number","example":0,"description":"Zero if no error and negative number if some error."},"errorMessage":{"type":"string","example":"Invaid Account or ServiceProvider Details","description":"Details on error if any. If no error this field will not be there."},"message":{"type":"object","properties":{"name":{"type":"string","example":"John","description":"Name of the contact person."},"description":{"type":"string","example":"nxgen user contact","description":"Description about the contact person"},"email":{"type":"string","example":"test@xxx.com","description":"Email of the contact person."},"codeword":{"type":"string","example":"NXG","description":"Code word."},"available":{"type":"boolean","example":true},"type":{"type":"string","enum":["STANDARD","MANAGED"],"example":"STANDARD","description":"It is a read only property. STANDARD is a editable contact and MANAGED is a Readonly contact."},"phones":{"type":"array","items":{"type":"object","required":[],"properties":{"id":{"type":"string","example":"8a81fc4581c99094018214f258a3047a","description":"Unique ID of the contact."},"number":{"type":"string","example":"+919842719112","description":"Mobile/Phone number."},"phoneType":{"type":"string","enum":["MAIN","MOBILE","HOME","WORK","CUSTOM"],"example":"MAIN","description":"Type of the contact number. Only one allowed in each type mentioned in enum except CUSTOM. There can be any muber of CUSTOM type added to the contact list. MAIN type must be there in order to insert other phone type. "},"customType":{"type":"string","example":"Personal","description":"Description for CUSTOM type."}}}}}}}}},"400":{"description":"Invalid input","examples":{"application/json":{"errorCode":"ERR001","errorDesc":"Invalid Request"}}},"403":{"description":"Forbidden"}}}},"/contact":{"post":{"tags":["Contact"],"parameters":[{"name":"hierarchyId","in":"query","required":true,"type":"string","description":"Hierarchy level id like Site, Customer or Service provider ID in which contact is created."},{"in":"body","name":"body","description":"Contact payload","required":true,"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"John","description":"Name of the contact person. Name is unique."},"description":{"type":"string","example":"nxgen user contact","description":"Description about the contact person"},"email":{"type":"string","example":"test@nx.com","description":"Email of the contact person."},"codeword":{"type":"string","example":"NXG","description":"Code word."},"available":{"type":"boolean","example":true},"type":{"type":"string","enum":["STANDARD"],"example":"STANDARD","description":"STANDARD is a editable contact."},"phones":{"type":"array","items":{"type":"object","required":[],"properties":{"number":{"type":"string","example":"+919842999112","description":"Mobile/Phone number."},"phoneType":{"type":"string","enum":["MAIN","MOBILE","HOME","WORK","CUSTOM"],"example":"MAIN","description":"Type of the contact number. Only one allowed in each type mentioned in enum except CUSTOM. There can be any muber of CUSTOM type added to the contact list. MAIN type must be there in order to insert other phone type. "},"customType":{"type":"string","example":"Personal","description":"Description for CUSTOM type."}}}}}}}],"description":"Add a new contact.","required":true,"responses":{"200":{"description":"Success","examples":{"application/json":{"errorCode":0,"errorMessage":"Success","id":"8a81fc4581c99094018224c3d431"}}},"400":{"description":"Invalid input","examples":{"application/json":{"errorCode":"ERR001","errorDesc":"Invalid Request"}}},"403":{"description":"Forbidden"}}},"patch":{"tags":["Contact"],"parameters":[{"name":"contactId","in":"query","required":true,"type":"string","description":"Contact ID in which patch is required."},{"name":"hierarchyId","in":"query","required":true,"type":"string","description":"Hierarchy ID in which the contact is associated with. Example site, customer or service provider ID."},{"in":"body","name":"body","description":"Contact payload","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"John","description":"Name of the contact person.Name is unique."},"description":{"type":"string","example":"nxgen user contact","description":"Description about the contact person"},"email":{"type":"string","example":"test@xxx.com","description":"Email of the contact person."},"codeword":{"type":"string","example":"NXG","description":"Code word."},"available":{"type":"boolean","example":true},"phones":{"type":"array","items":{"type":"object","required":[],"properties":{"id":{"type":"string","example":"8a81fc4581c99094018214f258a3047a","description":"Unique ID of the contact."},"number":{"type":"string","example":"+919842719112","description":"Mobile/Phone number."},"phoneType":{"type":"string","enum":["MAIN","MOBILE","HOME","WORK","CUSTOM"],"example":"MAIN","description":"Type of the contact number. Only one allowed in each type mentioned in enum except CUSTOM. There can be any muber of CUSTOM type added to the contact list. MAIN type must be there in order to insert other phone type. "},"customType":{"type":"string","example":"Personal","description":"Description for CUSTOM type."}}}}}}}],"description":"Patch a contact by contact ID","required":true,"responses":{"200":{"description":"Success","examples":{"application/json":{"errorCode":0,"errorMessage":"Success"},"schema":{"type":"object","properties":{"name":{"type":"string","example":"John","description":"Name of the contact person.Name is unique."},"description":{"type":"string","example":"nxgen user contact","description":"Description about the contact person"},"email":{"type":"string","example":"test@xxx.com","description":"Email of the contact person."},"codeword":{"type":"string","example":"NXG","description":"Code word."},"available":{"type":"boolean","example":true},"phones":{"type":"array","items":{"type":"object","required":[],"properties":{"id":{"type":"string","example":"8a81fc4581c99094018214f258a3047a","description":"Unique ID of the contact."},"number":{"type":"string","example":"+919842719112","description":"Mobile/Phone number."},"phoneType":{"type":"string","enum":["MAIN","MOBILE","HOME","WORK","CUSTOM"],"example":"MAIN","description":"Type of the contact number. Only one allowed in each type mentioned in enum except CUSTOM. There can be any muber of CUSTOM type added to the contact list. MAIN type must be there in order to insert other phone type. "},"customType":{"type":"string","example":"Personal","description":"Description for CUSTOM type."}}}}}}}},"400":{"description":"Invalid input","examples":{"application/json":{"errorCode":"ERR001","errorDesc":"Invalid Request"}}},"403":{"description":"Forbidden"}}},"delete":{"tags":["Contact"],"parameters":[{"name":"contactId","in":"query","required":true,"type":"string","description":"Contact ID required to be deleted."},{"name":"hierarchyId","in":"query","required":true,"type":"string","description":"Hierarchy ID in which the contact is associated with. Example site, customer or service provider ID."}],"description":"Delete a contact by contact ID","required":true,"responses":{"200":{"description":"Success"},"204":{"description":"No Content"},"400":{"description":"Invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/integration":{"post":{"tags":["Integration"],"parameters":[{"in":"body","name":"body","description":"Add Integration","required":true,"schema":{"type":"object","required":["name","accessLevel","entityId"],"properties":{"name":{"type":"string"},"isActive":{"type":"boolean"},"type":{"type":"string"},"description":{"type":"string"},"internalProxy":{"type":"string"},"externalProxy":{"type":"string"},"vpnProxy":{"type":"string"},"protocolType":{"type":"string"},"userName":{"type":"string"},"password":{"type":"string"},"accessToken":{"type":"string"},"externalEndpoint":{"type":"string"},"accessLevel":{"type":"string"},"entityId":{"type":"string"},"integrationInput":{"type":"object"},"integrationOutput":{"type":"object"}}}}],"description":"Add a new integration to a specific hierarchy level","responses":{"200":{"description":"Success","examples":{"application/json":{"result":true}}},"400":{"description":"Invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/integration/filter":{"post":{"tags":["Integration"],"description":"Gets integration list with filtering, sorting and pagination. It allows hierarchical level searching. It can be filtered using specified hierarchy or it uses the logged in user hierarchy. This gives the option to get additional entity fields in the response. Also provides configuration meta data about entity.","required":true,"parameters":[{"in":"body","name":"body","description":"Integration filtering and sorting","required":true,"schema":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"object","required":["columnName","type","filter"],"properties":{"columnName":{"type":"string"},"type":{"type":"string","enum":["distinctList","date","number","StringConditionFilter"]},"filter":{"type":"object","description":"This object can be any one of the type DistinctListFilter, DateFilter, NumberFilter or StringConditionFilter. Schema for the types has been given in models."}}},"example":[]},"sortOrder":{"type":"array","items":{"type":"object","properties":{"columnName":{"type":"string","description":"name of the field to sort"},"isAscending":{"type":"boolean","description":"false for descending order and true for ascending order"}}},"description":"To sort the result","example":[]},"primaryColumns":{"type":"array","items":{"type":"string"},"description":"To get additional fields in result","example":[]},"hierarchyLevel":{"type":"string","description":"To specify hierarchy level(e.g. serviceprovider, customer, site, device, sensor, root)","example":""},"hierarchyId":{"type":"string","description":"To get result for the specific hierarchy","example":""},"nPerPage":{"type":"number","description":"Page size of result","example":"50"},"pageNumber":{"type":"number","description":"Page number of result","example":"1"},"isConfigDetailRequired":{"type":"boolean","description":"To get configuration metadata, set the value to true","example":"false"},"getConfig":{"type":"boolean","description":"To get device config data only, set the value to true","example":"false"},"getChildOrParent":{"type":"boolean","description":"Additionally to get parent/child data, set the value to true","example":"false"}}}}],"responses":{"200":{"description":"Success","examples":{"application/json":{"dataResult":[{"uniqueId":"644745a2be7af43fac26788f","accessLevel":"serviceprovider","isActive":true,"name":"Webhook For DEV","description":"desc"},{"uniqueId":"6447481dbe7af43fac267891","accessLevel":"serviceprovider","isActive":true,"name":"DC09 For DEV"},{"uniqueId":"644748ecbe7af43fac267892","accessLevel":"serviceprovider","isActive":true,"name":"External Integration Test"}],"totalRecordsCount":3}},"schema":{"type":"object","properties":{"dataResult":{"type":"array","items":{"type":"object","properties":{"uniqueId":{"type":"string"},"parentAccountId":{"type":"string"},"accessLevel":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"isActive":{"type":"boolean"},"createdBy":{"type":"string"},"modifiedBy":{"type":"string"},"createdOn":{"type":"number"},"modifiedOn":{"type":"number"}}}},"totalRecordsCount":{"type":"number"}}}},"204":{"description":"No Content"},"400":{"description":"Invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/integration?id={id}&isTemplates={isTemplates}":{"get":{"tags":["Integration"],"description":"Get Integration by Id","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"id","in":"query","required":false,"type":"string"},{"name":"isTemplates","in":"query","required":false,"type":"string"}],"responses":{"200":{"description":"Success","examples":{"application/json":{"data":{"_id":"62ea2a8328c7c9","uniqueId":"afd49a39338dc","accessLevel":"site","createdBy":"developer-1@dev.de","createdOn":1659513475763,"modifiedBy":"developer-1@dev.de","modifiedOn":1659514047995,"name":"External Integration","description":"desc","internalProxy":"","externalProxy":"","vpnProxy":"","protocolType":"","userName":"","password":"","accessToken":"","externalEndpoint":"","parentAccountId":"23424-324-3424","integrationInput":{},"integrationOutput":{},"serviceProviderId":"","customerId":"","siteId":""}}}},"400":{"description":"Invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"put":{"tags":["Integration"],"description":"Update an existing Integration","required":true,"parameters":[{"name":"id","in":"path","required":true,"type":"string"},{"in":"body","name":"body","description":"To update integration, provide the existing Id","required":true,"schema":{"type":"object","properties":{"name":{"type":"string"},"isActive":{"type":"boolean"},"type":{"type":"string"},"description":{"type":"string"},"internalProxy":{"type":"string"},"externalProxy":{"type":"string"},"vpnProxy":{"type":"string"},"protocolType":{"type":"string"},"userName":{"type":"string"},"password":{"type":"string"},"accessToken":{"type":"string"},"externalEndpoint":{"type":"string"},"integrationInput":{"type":"object"},"integrationOutput":{"type":"object"}}}}],"responses":{"200":{"description":"Success","examples":{"application/json":{"isSuccess":true}}},"400":{"description":"Invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"patch":{"tags":["Integration"],"description":"Patch to update the integration","required":true,"parameters":[{"name":"id","in":"path","required":true,"type":"string"},{"in":"body","name":"body","description":"To update the integration","required":true,"schema":{"type":"object","properties":{"isActive":{"type":"boolean"}}}}],"responses":{"200":{"description":"Success","examples":{"application/json":{"isSuccess":true}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"delete":{"tags":["Integration"],"description":"Delete integration by Id","parameters":[{"name":"id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"Success","examples":{"application/json":{"isSuccess":true}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/storage-service/clip":{"post":{"tags":["Storage-Service"],"parameters":[{"name":"file","in":"formData","type":"file","required":true,"description":"File to upload."},{"name":"sensorId","in":"formData","type":"string","required":false,"description":"Sensor ID"},{"name":"deviceId","in":"formData","type":"string","required":false,"description":"Device ID"}],"consumes":[" - multipart/form-data"],"description":"Upload Cip to Cloud Storage","responses":{"200":{"description":"Success","examples":{"application/json":{"id":"string","filepath":"string"}}},"400":{"description":"Invalid Input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"412":{"description":"No Content"},"500":{"description":"Internal Server Error"}}}},"/storage-service/clip?folderId={folderId}&hierarchyLevel={hierarchyLevel}&hierarchyId={hierarchyId}":{"get":{"tags":["Storage-Service"],"description":"Download Clip from S3","required":true,"parameters":[{"name":"folderId","in":"query","required":true,"type":"string","description":"FileUpload folder id"},{"name":"path","in":"query","required":false,"type":"string","description":"Local path to save dowanload"},{"name":"hierarchyLevel","in":"query","required":true,"type":"string","description":"hierarchyLevel"},{"name":"hierarchyId","in":"query","type":"string","required":true,"description":"hierarchyId"}],"responses":{"200":{"description":"Success","examples":{"application/json":{"externalUrl":"https://events-snapshots.s3-eu-central-1.amazonaws.com/event-clips/331ba86e5cbfaa6addf8c3ca369e48/Untitled%20design.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2B4BNPFBH2CVMGRH%2F20240122%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20240122T142622Z&X-Amz-Expires=3600&X-Amz-Signature=b4d134981420b682e17e452662c2ba7bd781371fe0bbfb94f22d39cd240b904f&X-Amz-SignedHeaders=host"}}},"400":{"description":"Invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/storage-service/clip/{id}":{"delete":{"tags":["Storage-Service"],"parameters":[{"name":"id","in":"path","required":true,"type":"string"}],"description":"Delete Cip from AWS S3","responses":{"200":{"description":"Success","examples":{"application/json":{"message":"File deleted successfully"}}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/storage-service/clip/filter":{"post":{"tags":["Storage-Service"],"description":"Gets Files list with filtering, sorting and pagination. It allows hierarchical level searching. It can be filtered using specified hierarchy or it uses the logged in user hierarchy. This gives the option to get additional entity fields in the response. Also provides configuration meta data about entity.","required":true,"parameters":[{"in":"body","name":"body","description":"Files filtering and sorting","required":true,"schema":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"object","required":["columnName","type","filter"],"properties":{"columnName":{"type":"string"},"type":{"type":"string","enum":["distinctList","date","number","StringConditionFilter"]},"filter":{"type":"object","description":"This object can be any one of the type DistinctListFilter, DateFilter, NumberFilter or StringConditionFilter. Schema for the types has been given in models."}}},"example":[]},"sortOrder":{"type":"array","items":{"type":"object","properties":{"columnName":{"type":"string","description":"name of the field to sort"},"isAscending":{"type":"boolean","description":"false for descending order and true for ascending order"}}},"description":"To sort the result","example":[]},"primaryColumns":{"type":"array","items":{"type":"string"},"description":"To get additional fields in result","example":[]},"hierarchyLevel":{"type":"string","description":"To specify hierarchy level(e.g. serviceprovider, customer, site, device, sensor, root)","example":""},"hierarchyId":{"type":"string","description":"To get result for the specific hierarchy","example":""},"nPerPage":{"type":"number","description":"Page size of result","example":"50"},"pageNumber":{"type":"number","description":"Page number of result","example":"1"},"isConfigDetailRequired":{"type":"boolean","description":"To get configuration metadata, set the value to true","example":"false"},"getConfig":{"type":"boolean","description":"To get device config data only, set the value to true","example":"false"},"getChildOrParent":{"type":"boolean","description":"Additionally to get parent/child data, set the value to true","example":"false"}}}}],"responses":{"200":{"description":"Success","examples":{"application/json":{"config":{"columns":[{"visibility":true,"columnName":"commercialName","DisplayName":"Device","isFilterable":true,"filterType":"stringCondition","sticky":true,"isRightBorder":true,"isMandatory":true,"isNotDraggable":true}],"defaultNPerPage":50,"defaultFilterCondition":[],"defaultSortingOrder":[{"columnName":"dateTime","isAscending":false}],"maxVisibleColumnCount":6,"exportLimitNPerPage":500},"dataResult":[{"_id":"65b8ae63dc4355286864f6bc","timeStamp":1706602076710,"userEmail":"admin@web02.io","fileName":"Screenshot 2023-11-20 115021 - Copy (2).png","mimetype":"image/png","size":1219944,"folder":"dc79cb2b0907bea776a3fa437b96e53a","signedUrl":"https://events-snapshots.s3-eu-central-1.amazonaws.com/event-clips/dc79cb2b0907bea776a3fa437b96e53a/Screenshot%202023-11-20%20115021%20-%20Copy%20%282%29.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2B4BNPFBH2CVMGRH%2F20240202%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20240202T072929Z&X-Amz-Expires=3600&X-Amz-Signature=6e0cb0744cd378c74ac2d0bd9199eb82ef278a9d93b4c110b4091efa174df021&X-Amz-SignedHeaders=host"},{"_id":"65bb437ec8c2e356b822beed","timeStamp":1706771321894,"userEmail":"dinesh@nxgen.io","fileName":"vlc-record-2023-12-14-16h34m44s-In The End.mp4","mimetype":"video/mp4","size":6478,"folder":"c206997e6fb05b1ecd131305eb6fa371","signedUrl":"https://events-snapshots.s3-eu-central-1.amazonaws.com/event-clips/c206997e6fb05b1ecd131305eb6fa371/vlc-record-2023-12-14-16h34m44s-In%20The%20End.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2B4BNPFBH2CVMGRH%2F20240202%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20240202T072929Z&X-Amz-Expires=3600&X-Amz-Signature=1680e057f9ec11ca787888859df6ef52863c924c81dc94b9c8e5b016c563ddc8&X-Amz-SignedHeaders=host"}],"totalRecordsCount":2,"totalConsumedStorage":1226422,"filteredBy":[],"sortedBy":[{"columnName":"dateTime","isAscending":false}],"dispatchedAll":false,"isDefaultProjectionMutated":false,"isDefaultFilterMutated":false,"isDefaultSortingMutated":false}},"schema":{"type":"object","properties":{"config":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","properties":{"visibility":{"type":"boolean"},"columnName":{"type":"string"},"DisplayName":{"type":"string"},"isFilterable":{"type":"boolean"},"filterType":{"type":"string"},"sticky":{"type":"boolean"},"isRightBorder":{"type":"boolean"},"isMandatory":{"type":"boolean"},"isNotDraggable":{"type":"boolean"}}}},"defaultNPerPage":{"type":"number"},"defaultFilterCondition":{"type":"array","items":{}},"defaultSortingOrder":{"type":"array","items":{"type":"object","properties":{"columnName":{"type":"string"},"isAscending":{"type":"boolean"}}}},"maxVisibleColumnCount":{"type":"number"},"exportLimitNPerPage":{"type":"number"}}},"dataResult":{"type":"array","items":{"type":"object","properties":{"_id":{"type":"string"},"timeStamp":{"type":"number"},"userEmail":{"type":"string"},"fileName":{"type":"string"},"mimetype":{"type":"string"},"size":{"type":"number"},"type":{"type":"string"},"folder":{"type":"string"},"signedUrl":{"type":"string"}}}},"totalRecordsCount":{"type":"number"},"totalConsumedStorage":{"type":"number"},"filteredBy":{"type":"array","items":{}},"sortedBy":{"type":"array","items":{"type":"object","properties":{"columnName":{"type":"string"},"isAscending":{"type":"boolean"}}}},"dispatchedAll":{"type":"boolean"},"isDefaultProjectionMutated":{"type":"boolean"},"isDefaultFilterMutated":{"type":"boolean"},"isDefaultSortingMutated":{"type":"boolean"}}}},"204":{"description":"No Content"},"400":{"description":"Invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/analytics/detect":{"post":{"tags":["Analytics"],"parameters":[{"name":"body","in":"body","required":true,"description":"Analytics Request Parameters","schema":{"type":"object","properties":{"analytics":{"type":"string"},"version":{"type":"string"},"routeName":{"type":"string"},"meta":{"type":"object","properties":{"useDeviceMetadataBoxes":{"type":"boolean"},"useObjectDetector":{"type":"boolean"},"useMotionDetection":{"type":"boolean"},"useLicensePlateDetection":{"type":"boolean"},"useFaceRecognition":{"type":"boolean"},"personConfidenceThreshold":{"type":"number"},"carConfidenceThreshold":{"type":"number"},"animalConfidenceThreshold":{"type":"number"},"licensePlateConfidenceThreshold":{"type":"number"},"faceConfidenceThreshold":{"type":"number"},"motionThreshold":{"type":"integer"},"motionMinBBoxWidth":{"type":"integer"},"motionMinBBoxHeight":{"type":"integer"},"modality":{"type":"string"},"roi":{"type":"array","items":{"type":"array","items":{"type":"integer"}}},"useHistogramEqualization":{"type":"boolean"},"saveDebugImages":{"type":"boolean"},"carMinArea":{"type":"integer"},"personMinArea":{"type":"integer"},"animalMinArea":{"type":"integer"},"licensePletMinArea":{"type":"integer"},"faceMinArea":{"type":"integer"}}},"frames":{"type":"array","items":{"type":"object","properties":{"imageUrl":{"type":"string"},"meta":{"type":"object","properties":{"deviceMetadataBoxes":{"type":"array","items":{"type":"object","properties":{"top":{"type":"integer"},"left":{"type":"integer"},"bottom":{"type":"integer"},"right":{"type":"integer"}}}}}}}}}}}}],"consumes":["application/json"],"description":"AI Analytics Service","responses":{"200":{"description":"Success","examples":{"application/json":{"dataResult":[{"eventid":"","personConfidenceThreshold":0.5,"carConfidenceThreshold":0.5,"animalConfidenceThreshold":0.5,"hasPerson":true,"hasCar":true,"hasAnimal":false,"full_frame_detections":[{"x":1289,"y":189,"width":235,"height":543,"frameIdx":1,"confidence":0.99912816,"label":"person"},{"x":6,"y":316,"width":440,"height":369,"frameIdx":1,"confidence":0.9997342,"label":"car"},{"x":8,"y":317,"width":436,"height":368,"frameIdx":2,"confidence":0.9997941,"label":"car"}],"device_bboxes":[],"motion_locations":[]}],"totalRecordsCount":15}}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/analytics/schedule":{"post":{"tags":["Analytics"],"parameters":[{"name":"body","in":"body","required":true,"description":"Analytics Request Parameters","schema":{"type":"object","required":["action","spid","hierarchyIds","hierarchyLevel"],"properties":{"type":{"type":"string"},"action":{"type":"string"},"spid":{"type":"string"},"hierarchyIds":{"type":"array","items":{"type":"string"}},"hierarchyLevel":{"type":"string"},"expression":{"type":"string"}}}}],"consumes":["application/json"],"description":"config Schedule","responses":{"200":{"description":"Success"},"204":{"description":"No Content"},"401":{"description":"Unauthorized"}}}},"/analytics/manage":{"post":{"tags":["Analytics"],"parameters":[{"name":"body","in":"body","required":true,"description":"Analytics Request Parameters","schema":{"type":"object","required":["type","oldExpression"],"properties":{"type":{"type":"string"},"action":{"type":"string"},"oldExpression":{"type":"string"},"newExpression":{"type":"string"},"spid":{"type":"string"},"hierarchyLevel":{"type":"string"},"hierarchyIds":{"type":"array","items":{"type":"string"}}}}}],"consumes":["application/json"],"description":"remove Schedule","responses":{"200":{"description":"Success"},"204":{"description":"No Content"},"401":{"description":"Unauthorized"}}}},"/analytics/update":{"post":{"tags":["Analytics"],"parameters":[{"name":"body","in":"body","required":true,"description":"Analytics Request Parameters","schema":{"type":"object","properties":{"entityType":{"type":"string"},"entityId":{"type":"string"},"serviceProviderId":{"type":"string"},"analyticType":{"type":"string"},"oldExpression":{"type":"string"},"newExpression":{"type":"string"},"isActive":{"type":"boolean"},"overwriteCustomSchedule":{"type":"string"},"analyticAction":{"type":"string"},"runOnce":{"type":"boolean"}}}}],"consumes":["application/json"],"description":"Update Schedule","responses":{"200":{"description":"Success","examples":{"application/json":{"isSuccess":true}}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"}}}},"/serviceRequests/forms":{"get":{"tags":["Service Requests"],"description":"Get JSON to create dynamic form for service requests","responses":{"200":{"description":"Success","examples":{"application/json":{"categories":[{"name":"service_requests.tower","subCategories":[{"name":"service_requests.new_tower","status":[{"name":"service_requests.pending","icon":"pending","color":"#FF0000"},{"name":"service_requests.in_progress","icon":"pending-actions","color":"#FFA500"},{"name":"service_requests.completed","icon":"check_circle","color":"#00FF00"}],"fields":[{"name":"service_requests.location","type":"text","required":true},{"name":"service_requests.description","type":"textarea","required":false},{"name":"service_requests.image","type":"image","required":true}]}]}]}}},"400":{"description":"Invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/serviceRequests":{"post":{"tags":["Service Requests"],"description":"Add a service requests","parameters":[{"name":"body","in":"body","required":true,"schema":{"type":"object","properties":{"category":{"type":"string","example":"service_requests.tower"},"subCategory":{"type":"string","example":"service_requests.tower_location_change.name"},"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"project_address"},"label":{"type":"string","example":"service_requests.new_tower.project_address"},"type":{"type":"string","example":"text"},"value":{"type":"string","example":"#21, 1st Floor"},"required":{"type":"boolean","example":true}}}},"allAvailableStatus":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"icon":{"type":"string"},"color":{"type":"string"}}},"example":[{"name":"pending","label":"service_requests.status.pending","icon":"pending","color":"#606060"},{"name":"completed","label":"service_requests.status.completed","icon":"completed","color":"#00FF00"}]}}}}],"responses":{"200":{"description":"Success","examples":{"application/json":{"result":"serviceRequestId"}}},"400":{"description":"Invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"get":{"tags":["Service Requests"],"description":"Get all the service requests raised by current user","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"number"}},{"name":"limit","in":"query","required":false,"schema":{"type":"number"}}],"responses":{"200":{"description":"Success","examples":{"application/json":{"data":[{"uniqueId":"b12847425fc6454bb2154ef4cc9b2ce9","category":"tower","subCategory":"new_tower","data":[{"name":"project_address","label":"service_requests.new_tower.project_address","type":"text","value":"#21, 1st Floor","required":true}],"status":"Pending","allAvailableStatus":[{"name":"pending","label":"Pending","icon":"pending","color":"#606060"}],"serviceProviderId":"e7f417cf4a434b5093a8173cdb50005f","userId":"70cb24d36f86424b802873af7e78c2d3","createdOn":1715174099197},{"uniqueId":"b06cfbd7f80a4f76843b6443cedadea4","category":"tower","subCategory":"new_tower","data":[{"name":"project_address","label":"service_requests.new_tower.project_address","type":"text","value":"#21, 1st Floor","required":true}],"status":"Pending","allAvailableStatus":[{"name":"pending","label":"Pending","icon":"pending","color":"#606060"}],"serviceProviderId":"e7f417cf4a434b5093a8173cdb50005f","userId":"70cb24d36f86424b802873af7e78c2d3","createdOn":1715173285960},{"uniqueId":"596ed03dde0a489382ddc1f6cc023f33","category":"tower","subCategory":"new_tower","data":[{"name":"project_address","label":"service_requests.new_tower.project_address","type":"text","value":"#21, 1st Floor","required":true}],"status":"Pending","allAvailableStatus":[{"name":"pending","label":"Pending","icon":"pending","color":"#606060"}],"serviceProviderId":"e7f417cf4a434b5093a8173cdb50005f","userId":"70cb24d36f86424b802873af7e78c2d3","createdOn":1715173282225}],"totalPages":1,"currentPage":1}}},"400":{"description":"Invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/serviceRequests/{serviceRequestId}":{"get":{"tags":["Service Requests"],"description":"Get a service requests with logs","parameters":[{"name":"serviceRequestId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"Success","examples":{"application/json":{"data":{"_id":"660d3d7fd6e88700127fd3a2","data":[{"name":"project_address","label":"service_requests.new_tower.project_address","type":"text","value":"#21, 1st Floor","required":true}],"uniqueId":"6f1917ae16fc4cf19fe9b7ea5fba8878","category":"tower","subCategory":"new_tower","status":"Completed","allAvailableStatus":[{"name":"pending","label":"Pending","icon":"pending","color":"#606060"},{"name":"Completed","icon":"check-circle","color":"#606060"}],"serviceProviderId":"e7f417cf4a434b5093a8173cdb50005f","userId":"691fb2115824540aceabdc421244sd","createdOn":1712143743532,"auditLogs":[{"_id":"660d3d7fd6e88700127fd3a3","action":"Insert","payload":{"status":"Pending"},"userEmail":"admin@web02.io","dateTime":"Wed, 03 Apr 2024 11:29:03 GMT","timeStamp":1712143743000,"actionStatus":"Success","userAction":"SERVICE REQUEST has been added successfully"},{"_id":"661696cecd94a74301c9a001","action":"Update","payload":{"status":"Completed"},"userEmail":"admin@web02.io","dateTime":"Wed, 10 Apr 2024 13:40:30 GMT","timeStamp":1712756430000,"actionStatus":"Success","userAction":"Marked as Completed"}]}}}},"400":{"description":"Invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"put":{"tags":["Service Requests"],"description":"Update a service requests","parameters":[{"name":"serviceRequestId","in":"path","required":true,"type":"string"},{"name":"body","in":"body","required":true,"schema":{"type":"object","properties":{"category":{"type":"string","example":"service_requests.tower"},"subCategory":{"type":"string","example":"service_requests.tower_location_change.name"},"data":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"project_address"},"label":{"type":"string","example":"service_requests.new_tower.project_address"},"type":{"type":"string","example":"text"},"value":{"type":"string","example":"#21, 1st Floor"},"required":{"type":"boolean","example":true}}}},"allAvailableStatus":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"label":{"type":"string"},"icon":{"type":"string"},"color":{"type":"string"}}},"example":[{"name":"pending","label":"service_requests.status.pending","icon":"pending","color":"#606060"},{"name":"completed","label":"service_requests.status.completed","icon":"completed","color":"#00FF00"}]}}}}],"responses":{"200":{"description":"Success","examples":{"application/json":{"result":"serviceRequestId"}}},"400":{"description":"Invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"delete":{"tags":["Service Requests"],"description":"Delete a service requests","parameters":[{"name":"serviceRequestId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"Success","examples":{"application/json":{"result":"serviceRequestId"}}},"400":{"description":"Invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/serviceRequests/filter":{"post":{"tags":["Service Request Tab"],"description":"Get service requests list with filtering, sorting and pagination. It allows hierarchical level searching. It can be filtered using specified hierarchy or it uses the logged in user hierarchy. This gives the option to get additional entity fields in the response. Also provides configuration meta data about entity.","required":true,"parameters":[{"in":"body","name":"body","description":"Service Requests filtering and sorting","required":true,"schema":{"type":"object","properties":{"filters":{"type":"array","items":{"type":"object","required":["columnName","type","filter"],"properties":{"columnName":{"type":"string"},"type":{"type":"string","enum":["distinctList","date","number","StringConditionFilter"]},"filter":{"type":"object","description":"This object can be any one of the type DistinctListFilter, DateFilter, NumberFilter or StringConditionFilter. Schema for the types has been given in models."}}},"example":[]},"sortOrder":{"type":"array","items":{"type":"object","properties":{"columnName":{"type":"string","description":"name of the field to sort"},"isAscending":{"type":"boolean","description":"false for descending order and true for ascending order"}}},"description":"To sort the result","example":[]},"primaryColumns":{"type":"array","items":{"type":"string"},"description":"To get additional fields in result","example":[]},"hierarchyLevel":{"type":"string","description":"To specify hierarchy level(e.g. serviceprovider, customer, site, device, sensor, root)","example":""},"hierarchyId":{"type":"string","description":"To get result for the specific hierarchy","example":""},"nPerPage":{"type":"number","description":"Page size of result","example":"50"},"pageNumber":{"type":"number","description":"Page number of result","example":"1"},"isConfigDetailRequired":{"type":"boolean","description":"To get configuration metadata, set the value to true","example":"false"},"getConfig":{"type":"boolean","description":"To get device config data only, set the value to true","example":"false"},"getChildOrParent":{"type":"boolean","description":"Additionally to get parent/child data, set the value to true","example":"false"}}}}],"responses":{"200":{"description":"Success","examples":{"application/json":{"config":{"columns":[{"visibility":true,"columnName":"commercialName","DisplayName":"Site","isFilterable":true,"filterType":"stringCondition","sticky":true,"isRightBorder":true,"isMandatory":true,"isNotDraggable":true}],"defaultNPerPage":50,"defaultFilterCondition":[],"defaultSortingOrder":[{"columnName":"dateTime","isAscending":false}],"maxVisibleColumnCount":6,"exportLimitNPerPage":500},"dataResult":[{"category":"tower","subCategory":"new_tower","uniqueId":"c772ac8dd22f4a9a8849c332afe3f188","userId":"d76dfac772ac8dcb7db87a6c772ac8d","createdOn":1655213317621},{"category":"tower","subCategory":"new_tower","uniqueId":"c772ac8dd22f4a9a8849c332afe3f188","userId":"d76dfac772ac8dcb7db87a6c772ac8d","createdOn":1655213317621}],"totalRecordsCount":3552,"filteredBy":[],"sortedBy":[{"columnName":"dateTime","isAscending":false}],"dispatchedAll":false,"isDefaultProjectionMutated":false,"isDefaultFilterMutated":false,"isDefaultSortingMutated":false}},"schema":{"type":"object","properties":{"config":{"type":"object","properties":{"columns":{"type":"array","items":{"type":"object","properties":{"visibility":{"type":"boolean"},"columnName":{"type":"string"},"DisplayName":{"type":"string"},"isFilterable":{"type":"boolean"},"filterType":{"type":"string"},"sticky":{"type":"boolean"},"isRightBorder":{"type":"boolean"},"isMandatory":{"type":"boolean"},"isNotDraggable":{"type":"boolean"}}}},"defaultNPerPage":{"type":"number"},"defaultFilterCondition":{"type":"array","items":{}},"defaultSortingOrder":{"type":"array","items":{"type":"object","properties":{"columnName":{"type":"string"},"isAscending":{"type":"boolean"}}}},"maxVisibleColumnCount":{"type":"number"},"exportLimitNPerPage":{"type":"number"}}},"dataResult":{"type":"array","items":{"type":"object","properties":{"category":{"type":"string"},"subCategory":{"type":"string"},"uniqueId":{"type":"string"},"userId":{"type":"string"},"status":{"type":"string"}}}},"totalRecordsCount":{"type":"number"},"filteredBy":{"type":"array","items":{}},"sortedBy":{"type":"array","items":{"type":"object","properties":{"columnName":{"type":"string"},"isAscending":{"type":"boolean"}}}},"dispatchedAll":{"type":"boolean"},"isDefaultProjectionMutated":{"type":"boolean"},"isDefaultFilterMutated":{"type":"boolean"},"isDefaultSortingMutated":{"type":"boolean"}}}},"204":{"description":"No Content"},"400":{"description":"Invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/serviceRequests/updateStatus/{serviceRequestId}":{"put":{"tags":["Service Request Tab"],"description":"Update a service requests","parameters":[{"name":"serviceRequestId","in":"path","required":true,"type":"string"},{"name":"body","in":"body","required":true,"schema":{"type":"object","properties":{"status":{"type":"string","example":"completed"}}}}],"responses":{"200":{"description":"Success","examples":{"application/json":{"result":"serviceRequestId"}}},"400":{"description":"Invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/status/sensor/{id}":{"patch":{"tags":["Status-View"],"parameters":[{"name":"id","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"type":"object","properties":{"payload":{"type":"object","required":true,"properties":{"status":{"type":"object","required":true,"properties":{"CAMERA_ISOLATE":{"type":"object","required":false,"properties":{"status":{"type":"string"},"event":{"type":"string"},"alarm":{"type":"boolean"},"statusType":{"type":"string"},"statusColor":{"type":"string"},"statusIcon":{"type":"string"},"statusText":{"type":"string"}}},"DISK_LOW":{"type":"object","required":false,"properties":{"status":{"type":"string"},"event":{"type":"string"},"alarm":{"type":"boolean"},"statusType":{"type":"string"},"statusColor":{"type":"string"},"statusIcon":{"type":"string"},"statusText":{"type":"string"}}},"HEALTH_FAIL":{"type":"object","required":false,"properties":{"status":{"type":"string"},"event":{"type":"string"},"alarm":{"type":"boolean"},"statusType":{"type":"string"},"statusColor":{"type":"string"},"statusIcon":{"type":"string"},"statusText":{"type":"string"}}},"conclusion":{"type":"object","required":true,"properties":{"goodState":{"type":"boolean"},"alertState":{"type":"string"},"statusColor":{"type":"string"}}}}}}}}}}],"description":"Update Sensor Status","responses":{"200":{"description":"Success"},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/status/device/{id}":{"patch":{"tags":["Status-View"],"parameters":[{"name":"id","in":"path","required":true,"type":"string"},{"in":"body","name":"body","required":true,"schema":{"type":"object","properties":{"payload":{"type":"object","required":true,"properties":{"status":{"type":"object","required":true,"properties":{"CAMERA_ISOLATE":{"type":"object","required":false,"properties":{"status":{"type":"string"},"event":{"type":"string"},"alarm":{"type":"boolean"},"statusType":{"type":"string"},"statusColor":{"type":"string"},"statusIcon":{"type":"string"},"statusText":{"type":"string"}}},"DISK_LOW":{"type":"object","required":false,"properties":{"status":{"type":"string"},"event":{"type":"string"},"alarm":{"type":"boolean"},"statusType":{"type":"string"},"statusColor":{"type":"string"},"statusIcon":{"type":"string"},"statusText":{"type":"string"}}},"HEALTH_FAIL":{"type":"object","required":false,"properties":{"status":{"type":"string"},"event":{"type":"string"},"alarm":{"type":"boolean"},"statusType":{"type":"string"},"statusColor":{"type":"string"},"statusIcon":{"type":"string"},"statusText":{"type":"string"}}},"conclusion":{"type":"object","required":true,"properties":{"goodState":{"type":"boolean"},"alertState":{"type":"string"},"statusColor":{"type":"string"}}}}}}}}}}],"description":"Update Device Status","responses":{"200":{"description":"Success"},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/folder":{"post":{"tags":["Folder"],"description":"Add folder, Add folder with nodes and add nodes","required":true,"parameters":[{"in":"body","name":"body","description":"Add a folder","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","description":"Name of the folder"},"sharedWithUser":{"type":"array","item":{"type":"string"},"description":"User unique ID list"},"sharedWithRole":{"type":"array","item":{"type":"string"},"description":"Role unique ID list"},"childNodes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}}},"description":"Array of uniqueIDs contains Camera uniqueId, Salvo view uniqueId, Device uniqueID, Folder uniqueId"},"parentFolderId":{"type":"string","description":"Parent folder ID."}}}}],"responses":{"200":{"description":"Success","examples":{"application/json":{"uniqueId":"a4cfa7155aff40248f490deff75c1770","label":"folder 1.1.1","key":"a4cfa7155aff40248f490deff75c1770","data":{"type":"folder"},"iconImg":"","config":"null","children":[{"uniqueId":"afcf4aaa7155aff40248f490def1770","label":"folder 1.1.1.1","key":"afcf4aaa7155aff40248f490def1770","parentFolderId":"a4cfa7155aff40248f490deff75c1770","data":{"type":"folder"},"iconImg":"","isActive":true,"config":"null","children":[]},{"uniqueId":"3369348d03d2481097f341d6e2aad9a8","key":"3369348d03d2481097f341d6e2aad9a8","label":"AZ Site","data":{"type":"device"},"iconImg":"","isActive":true,"config":"null"},{"uniqueId":"eeb78a119e2a470bada695518753e7b6","key":"eeb78a119e2a470bada695518753e7b6","label":"Hoofdtribune Vak E-F1-F2","data":{"type":"sensor"},"iconImg":"","isActive":true,"config":"null"},{"uniqueId":"feeeeeeqrg333452rfww442de","key":"feeeeeeqrg333452rfww442de","label":"Test view","data":{"type":"salvoView"},"iconImg":"","config":{"views":{"type":"16","gridPosition":[{"positionNumber":0,"sensorId":"rfefe3454"},{"positionNumber":1,"sensorId":"rfefe3454"},{"positionNumber":2,"sensorId":"rfefe3454"},{"positionNumber":3,"sensorId":"rfefe3454"}]}}}]}}},"400":{"description":"Invalid input"},"401":{"description":"Unauthorized"}}}},"/folder/getAllFolders":{"post":{"tags":["Folder"],"description":"Gets folders with filtering, sorting and pagination for tree view","required":true,"parameters":[{"in":"body","name":"body","description":"Get Folders","required":true,"schema":{"type":"object","properties":{"folderId":{"type":"string","description":"Parent folder ID."},"skip":{"type":"string","descripdtion":"Parent folder ID."},"limit":{"type":"string","description":"Parent folder ID."},"searchString":{"type":"string","description":"search string."}}}}],"responses":{"200":{"description":"Success","examples":{"application/json":[{"uniqueId":"a4cfa7155aff40248f490deff75c1770","label":"folder 1.1.1","key":"a4cfa7155aff40248f490deff75c1770","data":{"type":"folder"},"iconImg":"","config":"null","children":[{"uniqueId":"afcf4aaa7155aff40248f490def1770","label":"folder 1.1.1.1","key":"afcf4aaa7155aff40248f490def1770","parentFolderId":"a4cfa7155aff40248f490deff75c1770","data":{"type":"folder"},"iconImg":"","isActive":true,"config":"null","children":[{"uniqueId":"3369348d03d2481097f341d6e2aad9a8","key":"3369348d03d2481097f341d6e2aad9a8","label":"AZ Site","data":{"type":"device"},"iconImg":"","isActive":true,"config":"null"},{"uniqueId":"eeb78a119e2a470bada695518753e7b6","key":"eeb78a119e2a470bada695518753e7b6","label":"Hoofdtribune Vak E-F1-F2","data":{"type":"sensor"},"iconImg":"","isActive":true,"config":"null"}]},{"uniqueId":"3369348d03d2481097f341d6e2aad9a8","key":"3369348d03d2481097f341d6e2aad9a8","label":"AZ Site","data":{"type":"device"},"iconImg":"","isActive":true,"config":"null"},{"uniqueId":"eeb78a119e2a470bada695518753e7b6","key":"eeb78a119e2a470bada695518753e7b6","label":"Hoofdtribune Vak E-F1-F2","data":{"type":"sensor"},"iconImg":"","isActive":true,"config":"null"},{"uniqueId":"feeeeeeqrg333452rfww442de","key":"feeeeeeqrg333452rfww442de","label":"Test view","data":{"type":"salvoView"},"iconImg":"","config":{"views":{"type":"4","gridPosition":[{"positionNumber":0,"sensorId":"rfefe3454"},{"positionNumber":1,"sensorId":"rfefe3454"},{"positionNumber":2,"sensorId":"rfefe3454"},{"positionNumber":3,"sensorId":"rfefe3454"}]}}}]}]},"schema":{"type":"object","properties":{"dataResult":{"type":"array","items":{"type":"object","properties":{"uniqueId":{"type":"string"},"label":{"type":"string"},"key":{"type":"string"},"data":{"type":"object"},"iconImg":{"type":"string"},"config":{"type":"object"},"children":{"type":"array","items":{"type":"object","properties":{"uniqueId":{"type":"string"},"label":{"type":"string"},"key":{"type":"string"},"data":{"type":"object"},"iconImg":{"type":"string"},"config":{"type":"object"},"children":{"type":"array","items":{}}}}}}}}}}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}}}},"/folder/addNodes":{"post":{"tags":["Folder"],"description":"Add nodes to an existing folder","required":true,"parameters":[{"in":"body","name":"body","description":"To add nodes to an existing folder","required":true,"schema":{"type":"object","properties":{"folderId":{"type":"string"},"childNodes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}}}}}}}],"responses":{"200":{"description":"Success","examples":{"application/json":{"result":true}}},"400":{"description":"Invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/folder/getList":{"get":{"tags":["Folder"],"description":"Gets folders list","responses":{"200":{"description":"Success","examples":{"application/json":[{"label":"folder 1","key":"a4cfa7155aff40248f490deff75c1770"},{"label":"folder 2","key":"ea4cfa7155aff40248f490deff75c1770"},{"label":"folder 3","key":"fa4cfa7155aff40248f490deff75c1770"},{"label":"folder 4","key":"ad4cfa7155aff40248f490deff75c1770"}]}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}}}},"/folder/bulkUpdateNodeIndex":{"post":{"tags":["Folder"],"description":"Update Folder index","responses":{"200":{"description":"Success","examples":{"application/json":[{"label":"folder 1","key":"a4cfa7155aff40248f490deff75c1770"},{"label":"folder 2","key":"ea4cfa7155aff40248f490deff75c1770"},{"label":"folder 3","key":"fa4cfa7155aff40248f490deff75c1770"},{"label":"folder 4","key":"ad4cfa7155aff40248f490deff75c1770"}]}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}}}},"/folder/moveFolderAndNodes":{"post":{"tags":["Folder"],"parameters":[{"in":"body","name":"body","description":"Move Folders","required":true,"schema":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"fromParentFolderId":{"type":"string"},"toParentFolderId":{"type":"string"},"fromIndex":{"type":"number"},"toIndex":{"type":"number"}}}}],"description":"Move Folder","responses":{"200":{"description":"Success"},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"404":{"description":"Not Found"}}}},"/reports/execute":{"post":{"tags":["Report"],"description":"Trigger a report or get sample data to be used in the template","parameters":[{"name":"body","in":"body","required":true,"schema":{"type":"object","properties":{"jobId":{"type":"string"},"startTime":{"type":"number","example":171929292000},"endTime":{"type":"number","example":1719300069000},"onlySampleData":{"type":"boolean","example":true},"cronSchedule":{"type":"string","example":"0 4 * * *"},"jobConfig":{"type":"object","properties":{"any":{"type":"string","example":"any"}}}}}}],"responses":{"200":{"description":"Success","examples":{"application/json":{"data":{"response":[{"site":"Muster HQ BLR","count":5,"events":[{"key":"camera.health.fail","value":2},{"key":"camera.health.normal","value":3}],"siteId":"0896302cceb04a059fa6aff014e51ac6","sensors":[{"name":"5N/A","deviceType":"camera","manafacturer":"HIKVISION","s3ImagePath":"","event":"camera.health.fail","associatedDeviceName":"Network Video Recorder","eventTime":1719964871485},{"name":"IPCamera 04","deviceType":"camera","manafacturer":"HIKVISION","s3ImagePath":"https://nxg-reference-img-upload-test.s3-eu-central-1.amazonaws.com/0896302cceb04a059fa6aff014e51ac6/df0c6f6d4e5e4e9f8e6732121f14b5ee/64d478a78a9a4400ba27876ef71cf84e.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2B4BNPFBH2CVMGRH%2F20240703%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20240703T082324Z&X-Amz-Expires=604800&X-Amz-Signature=67128d2e4353f760891b4f294dcfc1f1b09b44a8b87cac7fe14497b11ac1c51e&X-Amz-SignedHeaders=host","event":"camera.health.fail","associatedDeviceName":"Network Video Recorder","eventTime":1719964872557}]}]},"serviceProvider":{"uniqueId":"e7f417cf4a434b5093a8173cdb50005f","email":"admin@web02.io","persona":{"address":{},"contact":{},"profile":{"business":[],"photos":["https://nxg-reference-img-upload-test.s3-eu-central-1.amazonaws.com/e4299bcb77bc4a6780f0473ff03f72fd/e7f417cf4a434b5093a8173cdb50005f.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA2B4BNPFBH2CVMGRH%2F20240703%2Feu-central-1%2Fs3%2Faws4_request&X-Amz-Date=20240703T082324Z&X-Amz-Expires=86400&X-Amz-Signature=77f79aee130a8e5083cf88ff9befb0714f5fd2526c115a27db6bbe096ed1799f&X-Amz-SignedHeaders=host"],"tags":[],"followers":[],"s3ImagePath":"e4299bcb77bc4a6780f0473ff03f72fd/e7f417cf4a434b5093a8173cdb50005f.png"}},"name":"NXG Web 02","description":""},"report":{"name":"Health Check Failure Reports","description":"This report provides information about the cameras which are not operational.","type":"HealthReport","isActive":true}}}},"400":{"description":"Invalid input"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/reports":{"post":{"tags":["Report"],"description":"Add a report","parameters":[{"name":"body","in":"body","required":true,"schema":{"type":"object","properties":{"name":{"type":"string","example":"Health Check Failure Reports"},"reportTemplateId":{"type":"string","example":"882f3c0d83ce4251bf52cdba5ec132f5"},"description":{"type":"string","example":"This report provides information about the cameras which are not operational."},"template":{"type":"string","example":""},"healthTemplate":{"type":"string","enum":["Basic","Plus","Advanced"],"example":"Plus","description":"Health report tier. On create/update for Health templates, send as body.template (Basic|Plus|Advanced). Persisted/returned as healthTemplate. HTML EJS remains in template."},"cronSchedule":{"type":"string","example":"0 4 * * *"},"hierarchyId":{"type":"string","example":"890f3c0d83ce4251bf52cdba5ec132f5"},"isActive":{"type":"boolean","example":true},"userIds":{"type":"array","items":{"type":"string"},"example":[]},"roleIds":{"type":"array","items":{"type":"string"},"example":[]},"emailIds":{"type":"array","items":{"type":"string"},"example":["dev@nxgen.io"]},"emailSubject":{"type":"string","example":"{{reportName}}"},"emailBody":{"type":"string","example":"Dear Customer,Hello
How are you?