1"use strict";(globalThis.webpackChunkkanoa_software=globalThis.webpackChunkkanoa_software||[]).push([[15980],{97167(e,t,n){n.r(t),n.d(t,{assets:()=>a,contentTitle:()=>o,default:()=>m,frontMatter:()=>d,metadata:()=>r,toc:()=>c});const r=JSON.parse('{"id":"systemFunctions/item/updateItemPeriod","title":"system.kanoa.item.updateItemPeriod(periodInfo, userId)","description":"Update the item period. All periodInfo keys are required.","source":"@site/docs/systemFunctions/item/updateItemPeriod.md","sourceDirName":"systemFunctions/item","slug":"/systemFunctions/item/updateItemPeriod","permalink":"/systemFunctions/item/updateItemPeriod","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"id":"updateItemPeriod","title":"system.kanoa.item.updateItemPeriod(periodInfo, userId)","hide_table_of_contents":true},"sidebar":"tutorialSidebar","previous":{"title":"updateItemField","permalink":"/systemFunctions/item/updateItemField"},"next":{"title":"updateItemState","permalink":"/systemFunctions/item/updateItemState"}}');var s=n(74848),i=n(28453);const d={id:"updateItemPeriod",title:"system.kanoa.item.updateItemPeriod(periodInfo, userId)",hide_table_of_contents:!0},o=void 0,a={},c=[{value:"Parameters",id:"parameters",level:3},{value:"Returns",id:"returns",level:3},{value:"Example",id:"example",level:3}];function l(e){const t={code:"code",h3:"h3",hr:"hr",p:"p",pre:"pre",strong:"strong",...(0,i.R)(),...e.components};return(0,s.jsxs)(s.Fragment,{children:[(0,s.jsx)(t.p,{children:"Update the item period. All periodInfo keys are required."}),"\n",(0,s.jsx)(t.hr,{}),"\n",(0,s.jsx)(t.h3,{id:"parameters",children:"Parameters"}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"periodInfo"})," ",(0,s.jsx)(t.code,{children:"Dictionary"}),(0,s.jsx)("br",{})]}),"\n",(0,s.jsx)("table",{class:"dictionaryKeyTable",children:(0,s.jsxs)("tbody",{children:[(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:" - enabled"}),(0,s.jsx)("td",{children:"Boolean"}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:" - itemPeriodId"}),(0,s.jsx)("td",{children:"Integer"}),(0,s.jsx)("td",{})]}),(0,s.jsxs)("tr",{children:[(0,s.jsx)("td",{children:" - itemPeriodName"}),(0,s.jsx)("td",{children:"String"}),(0,s.jsx)("td",{})]})]})}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"userId"})," ",(0,s.jsx)(t.code,{children:"Integer"}),": Id of user executing the function",(0,s.jsx)("br",{})]}),"\n",(0,s.jsx)(t.hr,{}),"\n",(0,s.jsx)(t.h3,{id:"returns",children:"Returns"}),"\n",(0,s.jsxs)(t.p,{children:[(0,s.jsx)(t.strong,{children:"# of records modified"})," ",(0,s.jsx)(t.code,{children:"Integer"}),(0,s.jsx)("br",{})]}),"\n",(0,s.jsx)(t.hr,{}),"\n",(0,s.jsx)(t.h3,{id:"example",children:"Example"}),"\n",(0,s.jsx)(t.pre,{children:(0,s.jsx)(t.code,{className:"language-python",children:"periodInfo = {'itemPeriodId': 1, 'itemPeriodName': 'second', 'enabled': True}\nmodifiedRecords = system.kanoa.item.updateItemPeriod(periodInfo, 123)\n"})})]})}function m(e={}){const{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,s.jsx)(t,{...e,children:(0,s.jsx)(l,{...e})}):l(e)}},28453(e,t,n){n.d(t,{R:()=>d,x:()=>o});var r=n(96540);const s={},i=r.createContext(s);function d(e){const t=r.useContext(i);return r.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function o(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(s):e.components||s:d(e.components),r.createElement(i.Provider,{value:t},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.