{"id":36279,"date":"2024-08-21T13:59:37","date_gmt":"2024-08-21T12:59:37","guid":{"rendered":"https:\/\/developers.ila.cegid.com\/valuekeep\/\/"},"modified":"2024-12-26T18:11:15","modified_gmt":"2024-12-26T17:11:15","slug":"webapi-creating-a-meter","status":"publish","type":"valuekeep","link":"https:\/\/developers.ila.cegid.com\/en\/valuekeep\/development-en\/assets-en\/article\/webapi-creating-a-meter","title":{"rendered":"How to create or delete a meter?"},"content":{"rendered":"

Create Meter<\/h2>\n

This method allows to create a meter in a simplified manner.<\/span><\/span><\/p>\n

The method to be used when creating a meter:<\/span><\/span><\/p>\n

<\/div>\n
POST url\/api\/mytenant\/myorganization\/assetmanagementcore\/meters<\/span><\/div>\n
<\/div>\n
Json example for creating a meter:<\/span><\/div>\n
\n
\u00a0 {\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"meterKey\":\u00a0\"001\",\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"description\":\u00a0\"Contador\u00a0de\u00a0\u00e1gua\",\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"unitCost\":\u00a0{\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"amount\":\u00a0250.000000,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"baseAmount\":\u00a0250.000000,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"reportingAmount\":\u00a0250.000000,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"fractionDigits\":\u00a02,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"symbol\":\u00a0\"\u20ac\"\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0},\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"slidingWindowSize\":\u00a030,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"startValue\":\u00a0123.750000,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"startValueDecimalPlaces\":\u00a02,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"maxValue\":\u00a0999999,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"remarks\":\u00a0null,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"serial\":\u00a0null,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"meterType\":\u00a01,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"unit\":\u00a0\"LT\",\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"locationFunction\":\u00a0null,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"family\":\u00a0null,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"brand\":\u00a0null,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"brandModel\":\u00a0null,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"assetType\":\u00a01,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"location\":\u00a0\"ED01\",\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"equipment\":\u00a0null,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"tool\":\u00a0null,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"parentMeter\":\u00a0null,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"currency\":\u00a0\"EUR\",\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"averageCalculationMethod\":\u00a01,\r\n\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\"company\":\u00a0\"DEMO\"\r\n\r\n\u00a0\u00a0\u00a0\u00a0}<\/pre>\n<\/div>\n
This method allows to create a meter according to the parameters filled in:<\/span><\/span><\/p>\n
\n
    \n
  • MetertKey:<\/span><\/span><\/b> The meter’s key. If this parameter is not filled in, it assumes the defined sequential number.\u00a0<\/span><\/span><\/li>\n
  • Description:<\/span><\/span><\/b> Short description of the meter. This field is mandatory.<\/span><\/span><\/li>\n
  • UnitCost:<\/span><\/span><\/b> Unitary cost value.<\/span><\/span><\/li>\n
  • SlidingWindowSize:\u00a0<\/span><\/span><\/b>Moving window size.<\/span><\/span><\/li>\n
  • StartValue:\u00a0<\/span><\/span><\/b>Start value.<\/span><\/span><\/li>\n
  • StartValueDecimalPlaces:<\/span><\/span><\/b> Decimal places value.<\/span><\/span><\/li>\n
  • MaxValue:\u00a0<\/span><\/span><\/b>Maximum value.<\/span><\/span><\/li>\n
  • Remarks:<\/span><\/span><\/b>\u00a0Remarks.<\/span><\/span><\/li>\n
  • Serial:\u00a0<\/span><\/span><\/b>Meter serial number.<\/span><\/span><\/li>\n
  • MeterType:<\/span><\/span><\/b> Type of meter. (1- Reading meter type. 2- Increment meter type.) Mandatory field.<\/span><\/span><\/li>\n
  • Unit:<\/span><\/span><\/b> Meter unit. Mandatory field.<\/span><\/span><\/li>\n
  • LocationFunction:<\/span><\/span><\/b> The key of the location function.\u00a0<\/span><\/span><\/li>\n
  • Family:\u00a0<\/span><\/span><\/b>The family’s key.<\/span><\/span><\/li>\n
  • Brand:<\/span><\/span><\/b> The brand’s key.<\/span><\/span><\/li>\n
  • BrandModel:<\/span><\/span><\/b> The model’s key.<\/span><\/span><\/li>\n
  • AssetType:\u00a0<\/span><\/span><\/b>Asset type. (1-location; 2- equipment; 3- tool).<\/span><\/span><\/li>\n
  • Location:<\/span><\/span><\/b> The location’s key.<\/span><\/span><\/li>\n
  • Equipment:<\/span><\/span><\/b> The equipment key.<\/span><\/span><\/li>\n
  • Tool:<\/span><\/span><\/b> The tool’s key.<\/span><\/span><\/li>\n
  • ParentMeter:<\/span><\/span><\/b> The parent meter key.<\/span><\/span><\/li>\n
  • Currency:<\/span><\/span><\/b> The currency’s key.<\/span><\/span><\/li>\n
  • AverageCalculationMethod:\u00a0<\/span><\/span><\/b>Average calculation method. (0 – none; 1- moving average days; 2- moving average
    \nreading; 3- global).<\/span><\/span><\/li>\n
  • Company:<\/span><\/span><\/b> The company’s key.<\/span><\/span><\/li>\n<\/ul>\n
    When this method is executed successfully, it returns HttpStatusCode.OK.<\/span><\/p>\n<\/div>\n
    <\/div>\n
    <\/div>\n<\/div><\/section>\n
    Delete Meter<\/h2>\n
    This method allows you to delete a meter.<\/div>\n
    <\/div>\n
    The method to be used when deleting a meter:<\/div>\n
    <\/div>\n
    DELETE\u00a0 url\/api\/mytenant\/myorganization\/assetmanagement\/meters\/{{companyKey}}\/{{meterKey}}<\/div>\n
    <\/div>\n
    The parameters being replaced on the method are:<\/div>\n
      \n
    • companyKey: company key.<\/li>\n
    • meterKey: key of the meter you wish to delete.<\/li>\n<\/ul>\n
      When this method is executed successfully, it returns HttpStatusCode.204.<\/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":[917],"videos_tax":[],"post-type":[],"categoria-valuekeep":[943],"class_list":["post-36279","valuekeep","type-valuekeep","status-publish","format-standard","hentry","tag-meters","categoria-valuekeep-assets-en"],"_links":{"self":[{"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/valuekeep\/36279","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=36279"}],"version-history":[{"count":0,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/valuekeep\/36279\/revisions"}],"wp:attachment":[{"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/media?parent=36279"}],"wp:term":[{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/tags?post=36279"},{"taxonomy":"videos_tax","embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/videos_tax?post=36279"},{"taxonomy":"post-type","embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/post-type?post=36279"},{"taxonomy":"categoria-valuekeep","embeddable":true,"href":"https:\/\/developers.ila.cegid.com\/en\/wp-json\/wp\/v2\/categoria-valuekeep?post=36279"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}