{"id":36249,"date":"2024-08-21T13:59:19","date_gmt":"2024-08-21T12:59:19","guid":{"rendered":"https:\/\/developers.ila.cegid.com\/valuekeep\/\/"},"modified":"2024-12-26T16:04:26","modified_gmt":"2024-12-26T15:04:26","slug":"webapi-creating-a-monitoring","status":"publish","type":"valuekeep","link":"https:\/\/developers.ila.cegid.com\/en\/valuekeep\/development-en\/work-en\/article\/webapi-creating-a-monitoring","title":{"rendered":"How to create a monitoring?"},"content":{"rendered":"<section class=\"av_textblock_section \"  itemscope=\"itemscope\" itemtype=\"https:\/\/schema.org\/CreativeWork\" ><div class='avia_textblock  '   itemprop=\"text\" ><p class=\"MsoNormal\"><span lang=\"EN-US\">This method allows to create a monitoring in a simplified manner.<\/span><\/p>\n<p class=\"MsoNormal\"><span lang=\"EN-US\">The method to be used when creating a monitoring:<\/span><\/p>\n<p class=\"MsoNormal\"><span lang=\"EN-US\"><b>POST url\/api\/mytenant\/myorganization\/assetmanagementcore\/monitorings<\/b><\/span><\/p>\n<p class=\"MsoNormal\"><span lang=\"EN-US\">Json example for creating a monitoring:<\/span><\/p>\n<pre class=\"EnlighterJSRAW\" data-enlighter-language=\"json\">{\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"monitoringKey\":\u00a0\"0000000001\",\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"description\":\u00a0\"Temperature\u00a0Monitoring\",\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"averageWindow\":\u00a010,\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"remarks\":\u00a0null,\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"unit\":\u00a0\"C\",\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"locationFunction\":\u00a0null,\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"family\":\u00a0null,\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"brand\":\u00a0null,\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"brandModel\":\u00a0null,\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"assetType\":\u00a02,\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"location\":\u00a0null,\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"equipment\":\u00a0\"CH01\",\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"tool\":\u00a0null,\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"company\":\u00a0\"DEMO\"\r\n\u00a0\u00a0\u00a0\u00a0}<\/pre>\n<p class=\"MsoNormal\"><span lang=\"EN-US\">This method allows to create a monitoring according to the parameters filled in:<\/span><\/p>\n<ul>\n<li><b><span lang=\"EN-US\">MonitoringKey:\u00a0<\/span><\/b><span lang=\"EN-US\">The monitoring key. If this parameter is not filled in, it assumes the defined sequential number.\u00a0<\/span><\/li>\n<li><b><span lang=\"EN-US\">Description:<\/span><\/b><span lang=\"EN-US\"> Short description of the monitoring. This field is mandatory.<\/span><\/li>\n<li><b><span lang=\"EN-US\">AverageWindow:\u00a0<\/span><\/b><span lang=\"EN-US\">Value used to calculate the moving window value.<\/span><\/li>\n<li><b><span lang=\"EN-US\">Remarks:<\/span><\/b><span lang=\"EN-US\">\u00a0Remarks.<\/span><\/li>\n<li><b><span lang=\"EN-US\">Unit:<\/span><\/b><span lang=\"EN-US\"> Monitoring unit. Mandatory field.<\/span><\/li>\n<li><b><span lang=\"EN-US\">LocationFunction:\u00a0<\/span><\/b><span lang=\"EN-US\">The key of the location function.\u00a0<\/span><\/li>\n<li><b><span lang=\"EN-US\">Family:\u00a0<\/span><\/b><span lang=\"EN-US\">The family&#8217;s key.<\/span><\/li>\n<li><b><span lang=\"EN-US\">Brand:\u00a0<\/span><\/b><span lang=\"EN-US\">The brand&#8217;s key.<\/span><\/li>\n<li><b><span lang=\"EN-US\">BrandModel:<\/span><\/b><span lang=\"EN-US\"> The model&#8217;s key.<\/span><\/li>\n<li><b><span lang=\"EN-US\">AssetType:\u00a0<\/span><\/b><span lang=\"EN-US\">Asset type. (1-location; 2- equipment; 3- tool).<\/span><\/li>\n<li><b><span lang=\"EN-US\">Location<\/span><\/b><span lang=\"EN-US\">: The location&#8217;s key.<\/span><\/li>\n<li><b><span lang=\"EN-US\">Equipment:\u00a0<\/span><\/b><span lang=\"EN-US\">The equipment key.<\/span><\/li>\n<li><b><span lang=\"EN-US\">Tool<\/span><\/b><span lang=\"EN-US\">: The tool&#8217;s key.<\/span><\/li>\n<li><b><span lang=\"EN-US\">Company:<\/span><\/b><span lang=\"EN-US\"> The company&#8217;s key.<\/span><\/li>\n<\/ul>\n<p class=\"MsoNormal\"><span lang=\"EN-US\">When this method is executed successfully, it returns HttpStatusCode.OK.<\/span><\/p>\n<div><\/div>\n<\/div><\/section>\n","protected":false},"excerpt":{"rendered":"","protected":false},"featured_media":0,"menu_order":0,"comment_status":"open","ping_status":"open","template":"","format":"standard","tags":[905],"videos_tax":[],"post-type":[],"categoria-valuekeep":[941],"class_list":["post-36249","valuekeep","type-valuekeep","status-publish","format-standard","hentry","tag-monitorings","categoria-valuekeep-work-en"],"_links":{"self":[{"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/valuekeep\/36249","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/valuekeep"}],"about":[{"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/types\/valuekeep"}],"replies":[{"embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/comments?post=36249"}],"version-history":[{"count":0,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/valuekeep\/36249\/revisions"}],"wp:attachment":[{"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/media?parent=36249"}],"wp:term":[{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/tags?post=36249"},{"taxonomy":"videos_tax","embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/videos_tax?post=36249"},{"taxonomy":"post-type","embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/post-type?post=36249"},{"taxonomy":"categoria-valuekeep","embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/categoria-valuekeep?post=36249"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}