{"type":"doc","content":[{"type":"table","attrs":{"layout":"default","width":1292.0,"localId":"64a01f96-9b29-483a-8501-15bdc53ea0b9"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[210.0]},"content":[{"type":"paragraph","content":[{"text":"Function prototype","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1082.0]},"content":[{"type":"paragraph","content":[{"text":"library_form_set (session, form)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[210.0]},"content":[{"type":"paragraph","content":[{"text":"API Version","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1082.0]},"content":[{"type":"paragraph","content":[{"text":"All","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[210.0]},"content":[{"type":"paragraph","content":[{"text":"Supported interfaces","type":"text","marks":[{"type":"strong"},{"type":"link","attrs":{"href":"/wiki/spaces/WS/pages/3113517057"}}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1082.0]},"content":[{"type":"paragraph","content":[{"text":"SOAP, REST (Since API Version 2.7.32)","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Description","type":"text"}]},{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"excerpt","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"1763132b-925c-4309-874f-8db3d3c2160b"},"schemaVersion":{"value":"1"},"title":"Excerpt"}},"localId":"a7e05ec6-268f-439a-b9be-9b84a47c65ac"},"content":[{"type":"paragraph","content":[{"text":"Modifies the properties of a FORM TEMPLATE","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Required permissions","type":"text","marks":[{"type":"strong"}]},{"text":": The active user must have role PROGRAM EDITOR in the TEAM owner of the PROGRAM. Otherwise an INSUFFICIENT_PRIVILEGES error will be returned.","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1296.0,"localId":"e9e91bf5-c045-4aaf-9732-1d0049aaee4f"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[278.0]},"content":[{"type":"paragraph","content":[{"text":"Input parameters:","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1018.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"session","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": is the session token obtained in the ","type":"text"},{"text":"session_init()","type":"text","marks":[{"type":"link","attrs":{"href":"http://linkcare.atlassian.net/wiki/spaces/WS/pages/524509"}}]},{"text":" call","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"form","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": XML containing the properties to be changed ","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"name","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Name of the FORM TEMPLATE in the active session language","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"description","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":":Description of the FORM TEMPLATE in the active session language","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"form_code","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": null or a non-numeric string composed by letters, numbers or any of the symbols #.:_","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hidden","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Defines the visibility of the FORMs generated from this FORM TEMPLATE.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"0: Not hidden (always visible)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"1: Always hidden","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2: Hidden when TASK is closed: The FORM will be hidden when its parent TASK is closed","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"3: Hidden when TASK is open: The FORM will be hidden while its parent TASK is open","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"4: Hidden when FORM is closed: The FORM will be hidden when it is closed","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"access","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": (PUBLIC/PRIVATE)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"review","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": (true/false)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"nav_mode","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Navigation mode assigned to the FORM TEMPLATE. When an instance of this FORM TEMPLATES is created (a FORM), this value determines how the ITEMs of the FORM should be displayed. Possible values are:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"0 (default): Display all the ITEMs of the FORM as a continuous list of ITEMs.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"1 (step by step): Display the ITEMs of the FORM one by one instead of showing a complete list of ITEMS. Only one ITEM is displayed at the same time. When the value of the ITEM is introduced, then the next ITEM will be displayed.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"2 (step by step when FORM open): Similar to STEP_BY_STEP, but only when the FORM is open.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"3 (step by step when FORM closed): Similar to STEP_BY_STEP, but only when the FORM is closed","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"owner","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":":","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ref","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": reference to the owner TEAM of the FORM TEMPLATE","type":"text"}]}]}]}]}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[278.0]},"content":[{"type":"paragraph","content":[{"text":"Output parameters:","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[1018.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"result","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": empty","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ErrorMsg","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": If any error occurs, then this value contains a description of the error translated to the current language","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ErrorCode","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": If any error occurs, then this value contains any of the standard ","type":"text"},{"text":"ERROR CODES","type":"text","marks":[{"type":"link","attrs":{"href":"http://linkcare.atlassian.net/wiki/spaces/WS/pages/55967818/ERROR+CODES"}}]}]}]}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Request example","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"library_form_set( “LCAAAAAAAAAAAA”, \n\"\n\");","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Response","type":"text"}]},{"type":"paragraph","content":[{"text":"The response format is XML when the function has been invoked via the SOAP API, and JSON when it has been invoked via the REST API","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"appsplus-tabs-lite-macro","parameters":{"macroParams":{"data":{"value":"{\"theme\":\"Electric Blue\",\"features\":[\"titles\",\"active\",\"border\",\"rounded\",\"icons\",\"ripples\",\"fullscreen\"],\"padding\":10,\"height\":560,\"tabFont\":\"Atlassian\",\"tabSize\":15,\"tabBold\":true,\"tabItalic\":false,\"tabUnderline\":false,\"tabColor\":\"#ffffff\",\"tabColorBG\":\"#172b4d\",\"type\":\"scrollable\",\"opacity\":100,\"activeColor\":\"#ffffff\",\"activeColorBG\":\"#0052cc\",\"borderWidth\":1,\"borderColor\":\"#ebecf0\",\"radius\":5,\"hoverColor\":\"#ffffff\",\"hoverColorBG\":\"#0052cc\",\"iconSize\":\"medium\",\"iconInline\":true,\"iconPrimary\":\"#ffffff\",\"iconSecondary\":\"#172b4d\",\"separatorWidth\":1,\"separatorColor\":\"#42526E\",\"indicatorPercent\":5,\"indicatorColor\":\"#ff5630\",\"indicatorColorBG\":\"#0052cc\",\"hide\":false,\"vertical\":false,\"preload\":true,\"animate\":false,\"uuid\":\"M72b041l-9\",\"isNew\":false,\"loaded\":false,\"attachmentId\":\"att3215196177\"}"}},"macroMetadata":{"macroId":{"value":"0ff445bd-e190-45f8-9b92-00798adadd0b"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://tabs.appsplus.co/confluence/img/lite.png"}}],"title":"Tabs+ Lite for Confluence"}},"localId":"df2975af-3c8b-4486-a8e2-f0f97e9e83bf"}},{"type":"heading","attrs":{"level":1},"content":[{"text":"Return Error codes","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":1264.0,"localId":"46d1ca6c-4bad-47e2-b03a-1e40b43fc521"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[407.0]},"content":[{"type":"paragraph","content":[{"text":"ERROR CODE","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[857.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[407.0]},"content":[{"type":"paragraph","content":[{"text":"INVALID_TOKEN","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[857.0]},"content":[{"type":"paragraph","content":[{"text":"The session token provided is not valid","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[407.0]},"content":[{"type":"paragraph","content":[{"text":"INSUFFICIENT_PRIVILEGES","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[857.0]},"content":[{"type":"paragraph","content":[{"text":"The session user does not have the necessary privileges to modify the FORM TEMPLATE","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[407.0]},"content":[{"type":"paragraph","content":[{"text":"WORKPLAN.NOT_FOUND","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[857.0]},"content":[{"type":"paragraph","content":[{"text":"The WORKPLAN to which this FORM TEMPLATE belongs was not found","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[407.0]},"content":[{"type":"paragraph","content":[{"text":"TEMPLATE.NOT_PRESENT","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[857.0]},"content":[{"type":"paragraph","content":[{"text":"The requested FORM TEMPLATE was not found","type":"text"}]}]}]}]},{"type":"paragraph"}],"version":1}

Browser not supported