/
library_resource_set ()

library_resource_set ()

Owned by Pedro Jose Sanchez Luling
Last updated: Jul 04, 2023
2 min read

Function prototype

library_resource_set (session, resource_id, resource_data)

API Version

2.6.20 and higher

Supported interfaces

SOAP, REST (Since API Version 2.6.20)

Description

Modifies the contents of an existing LIBRARY RESOURCE object

Input parameters:

  • session: is the session token obtained in the session_init() call

  • resource_id: is a LIBRARY RESOURCE reference. If NULL, then the function will create a new LIBRARY resource, otherwise it will modify the existing LIBRARY RESOURCE identified by the parameter 'ref'

  • resource_data: XML/JSON containing the information to be modified (see LIBRARY RESOURCE OBJECT)

If a property of the LIBRARY RESOURCE is not specified in the resource_data parameter, it will not be modified. If you want to remove the value of a property, it must be specified with an empty value

Output parameters:

  • result: properties of the created/modified LIBRARY RESOURCE except the array of bytes

  • ErrorMsg: If any error occurs, then this value contains a description of the error translated to the current language

  • ErrorCode: If any error occurs, then this value contains any of the standard ERROR CODES

Request example

The function can be called expressing the resource_data parameter in XML format or JSON format. The following examples are the same. The only difference is the format of the resource_data parameter.

Remember that the byte contents of the resource must be Base64 encoded. Otherwise an error will be returned

library_resource_set(“LCAAAAAAAAAAAA”, 344, "<library_resource> <description>Description of the resource</description> <mime_type>png</mime_type> <filename>image.png</filename> <code>code28</code> <bytes>aasdjasd98asduhasdkjhas</bytes> <library_resource>");
library_resource_set(“LCAAAAAAAAAAAA”, 344, "{ "description": "Description of the resource", "mime_type": "png", "filename": "image.png", "code": "code28", "bytes": "aasdjasd98asduhasdkjhas" }");

Response

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

Return Error codes

ERROR CODE

 

ERROR CODE

 

INVALID_TOKEN

The session token provided is not valid

INSUFFICIENT_PRIVILEGES

The session user does not have the necessary privileges to use the requested resource.

Normally this means that it is trying to generate a 'GLOBAL' scoped object but the Session user is not a System Administrator

WRONG_PARAMS

Any of the parameters supplied is invalid. The following situations will generate this error:

  • resource_data = null

  • Any of the values provided in resource_data is not valid (e.g. an unsupported scope value)

XML_ERROR

The format of the resource_data parameter is not a valid XML

LIBRARY_RESOURCE.NOT_FOUND

The resource_id parameter is not an existing LIBRARY RESOURCE reference

LIBRARY_RESOURCE.BASE64ENCODING_EXPECTED

The bytes of the resource are expected to be Base64 encoded, but an invalid string has been supplied

Related content