{"type":"doc","content":[{"type":"table","attrs":{"layout":"default","localId":"64a01f96-9b29-483a-8501-15bdc53ea0b9"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"Function prototype","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[563.0]},"content":[{"type":"paragraph","content":[{"text":"library_resource_upload (session, upload_reference, resource_data)","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[197.0]},"content":[{"type":"paragraph","content":[{"text":"API Version","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[563.0]},"content":[{"type":"paragraph","content":[{"text":"2.6.20 and higher","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[197.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":[563.0]},"content":[{"type":"paragraph","content":[{"text":"SOAP, REST (from API 2.7.29)","type":"text"}]}]}]}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{},"macroMetadata":{"macroId":{"value":"533e0e76-35c9-4970-a136-7c2e96ad9c3f"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"f5219938-04ae-4919-b557-543c796cf00f"}},{"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":"fbe151fb-447d-48b6-8dc9-36f007b3e36f"},"content":[{"type":"paragraph","content":[{"text":"Allows to upload large resources slitting it in chunks to create a new LIBRARY RESOURCE object.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"The process to upload large objects in chunks is:","type":"text"}]},{"type":"orderedList","attrs":{"order":1},"content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Invoke ","type":"text"},{"text":"library_resource_upload()","type":"text","marks":[{"type":"code"}]},{"text":" passing NULL as the upload_reference. This will initialize a new temporary ","type":"text"},{"text":"LIBRARY RESOURCE OBJECT","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/WS/pages/580714692#LIBRARYRESOURCEOBJECT-XML_FORMAT"}}]},{"text":" and will return an upload_reference that can be used in subsequent calls","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Make succesive calls to ","type":"text"},{"text":"library_resource_upload()","type":"text","marks":[{"type":"code"}]},{"text":" indicating the ","type":"text"},{"text":"upload_reference","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" obtained in the previous step. Each call will append a new fragment to the resource","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"To finish the creation of the object, make a last call to ","type":"text"},{"text":"library_resource_upload()","type":"text","marks":[{"type":"code"}]},{"text":" with the same ","type":"text"},{"text":"upload_reference","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" and ","type":"text"},{"text":"resource_data","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" = NULL (or passing an empty byte content in ","type":"text"},{"text":"resource_data","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":"). In te response of this last call, a valid reference to the definitive ","type":"text"},{"text":"LIBRARY RESOURCE OBJECT","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/WS/pages/580714692#LIBRARYRESOURCEOBJECT-XML_FORMAT"}}]},{"text":" will be returned","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"The upload_reference generated in the first call is only valid for the current Session. Any attempt of using it from a different Session will generate an error.","type":"text"}]},{"type":"paragraph","content":[{"text":"If the upload of an object is not properly finished, then the temporary object created will be deleted by a system daemon after a predefined lapse of time since the creation date.","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"e9e91bf5-c045-4aaf-9732-1d0049aaee4f"},"content":[{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"Input parameters:","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[597.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":"upload_reference","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": is a temporary reference generated by a previous call to ","type":"text"},{"text":"library_resource_upload()","type":"text","marks":[{"type":"code"}]},{"text":". If NULL, then the function will create a new temporary LIBRARY RESOURCE object that can be modified in subsequent calls to append more bytes","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"resource_data","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": XML/JSON containing the information to be modified (see ","type":"text"},{"text":"LIBRARY RESOURCE OBJECT","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/WS/pages/580714692#LIBRARYRESOURCEOBJECT-XML_FORMAT"}}]},{"text":"). JSON format is supported since ","type":"text"},{"text":"API Version 2.7.29","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"paragraph","content":[{"text":"If a property of the LIBRARY RESOURCE is not specified in the ","type":"text"},{"text":"resource_data","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" parameter will not be modified. If you want to remove the value of a property, it must be specified with an empty value.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[163.0]},"content":[{"type":"paragraph","content":[{"text":"Output parameters:","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[597.0]},"content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"result","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":": Properties of the created/modifies LIBRARY RESOURCE. Note that:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ref","type":"text","marks":[{"type":"code"}]},{"text":": The meaning of this field varies depending on the parameters of the call:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"If ","type":"text"},{"text":"upload_reference","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" is null, then a new temporary LibraryResource object will be created and a reference to it will be returned. This reference can be used in subsequent calls to append more bytes to the resource","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"When the upload is closed by sending a NULL value for ","type":"text"},{"text":"resource_data","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":", a valid reference to the definitive ","type":"text"},{"text":"LIBRARY RESOURCE OBJECT","type":"text","marks":[{"type":"link","attrs":{"href":"/wiki/spaces/WS/pages/580714692#LIBRARYRESOURCEOBJECT-XML_FORMAT"}}]},{"text":" will be returned.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"length","type":"text","marks":[{"type":"code"}]},{"text":": indicates the total length of the object after appending data","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"upload_max_filesize","type":"text","marks":[{"type":"code"}]},{"text":": indicates the maximum size of the chunk than can be sent","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":"/wiki/spaces/WS/pages/55967818"}}]}]}]}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Request example","type":"text"}]},{"type":"paragraph","content":[{"text":"The following example initiates the upload of a large resource.","type":"text"}]},{"type":"paragraph","content":[{"text":"NOTE that the byte contents of each chunk must be Base64 encoded, but each fragment should be encoded separately. It is not valid to encode the full resource and split it after encoding because you can break the consistency of the encoded string.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"library_resource_upload(“LCAAAAAAAAAAAA\", null,\n \"\n Description of the resource\n png\n image.png\n code28\n aasdjasd98asduhasdkjhas\n \");","type":"text"}]},{"type":"paragraph","content":[{"text":"Note that the ","type":"text"},{"text":"resource_data","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" parameter can be expressed also in JSON format as shown in the following example.","type":"text"}]},{"type":"paragraph","content":[{"text":"In the next example we continue adding bytes to the resource that we initiated in the previous example.","type":"text"}]},{"type":"paragraph","content":[{"text":"Note that now we are specifying the ","type":"text"},{"text":"upload_reference","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" parameter with the reference obtained in the result response of the previous call. Note also that now it is only necessary to indicate the bytes that we want to append (the rest of field will be ignored, since they have been set in the first call to library_resource_update() ):","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"library_resource_upload(“LCAAAAAAAAAAAA\", \"a8asduasc89asc\",\n '{\n \"bytes\": \"aasdjasd98asduhasdkjhas\"\n }'\n);","type":"text"}]},{"type":"paragraph","content":[{"text":"And the last call to finalize the upload would be:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"library_resource_upload(“LCAAAAAAAAAAAA\", \"a8asduasc89asc\", null);","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\":\"att3327524896\"}"}},"macroMetadata":{"macroId":{"value":"8c1e5fb9-5609-4297-8e8f-2ac9480786a0"},"schemaVersion":{"value":"1"},"placeholder":[{"type":"icon","data":{"url":"https://tabs.appsplus.co/confluence/img/lite.png"}}],"title":"Tabs+ Lite for Confluence"}},"localId":"21d72de9-e3b2-482a-a678-845127a9c62e"}},{"type":"heading","attrs":{"level":1},"content":[{"text":"Return Error codes","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"46d1ca6c-4bad-47e2-b03a-1e40b43fc521"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"ERROR CODE","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"INVALID_TOKEN","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.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":[340.0]},"content":[{"type":"paragraph","content":[{"text":"INSUFFICIENT_PRIVILEGES","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"The session user does not have the necessary privileges to use the requested resource.","type":"text"}]},{"type":"paragraph","content":[{"text":"Normally this means that it is trying to generate a 'GLOBAL' scoped object but the Session user is not a System Administrator","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"WRONG_PARAMS","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"Any of the parameters supplied is invalid. The following situations will generate this error:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"upload_reference","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" = NULL and ","type":"text"},{"text":"resource_data","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" = null","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The value of ","type":"text"},{"text":"upload_reference","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" was not generated for this Session, or it is not a valid value","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"upload_reference","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" passed corresponds to an object that has already been closed","type":"text"}]}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"XML_ERROR","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"The format of the ","type":"text"},{"text":"resource_data","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" parameter is not a valid XML","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"INVALID_JSON","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"The format of the ","type":"text"},{"text":"resource_data","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" parameter is not a valid JSON","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"LIBRARY_RESOURCE.NOT_FOUND","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"upload_reference","type":"text","marks":[{"type":"strong"},{"type":"em"}]},{"text":" parameter references a temporary LIBRARY RESOURCE that does no longer exist","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"LIBRARY_RESOURCE.BASE64ENCODING_EXPECTED","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[340.0]},"content":[{"type":"paragraph","content":[{"text":"The bytes of the resource are expected to be Base64 encoded, but an invalid string has been supplied","type":"text"}]}]}]}]},{"type":"paragraph"}],"version":1}

Browser not supported