| |
|---|
apiKey | The key which you generated using the GenerateApiKey WebService function. This is a required argument for most functions. |
fileOrData | One of: file path (accessible from all CHILI Server), which will be copied or moved base64 encoded contents of the file, which will be created on the server
|
folderPath | All paths given as arguments to the CHILI API are relative to the root of the Resource's tree.
The underlying file can be found on the server in CHILI_DATA_DIR\Environments\ENVIRONMENT_NAME\Resources\RESOURCE_NAME\FOLDER_PATH.
They can contain forward or back-slashes.
Paths are not case sensitive. |
itemID | The unique ID of the item to work with.
Each ResourceItem in CHILI has a unique ID, consisting of a GUID.
You can use the API to get the ID of the item using a number of functions. Eg: ResourceItemGetByPath ResourceItemGetByName ResourceItemSearch ResourceItemGetTree ...
|
itemName | The name for the ResourceItem.
For Resources of type 'directory_file' or 'directory_object' this corresponds to an actual file name on Windows (and any invalid characters will be replaced by '_'). |
libraryName | The name of the library.
This is created as an actual Windows Directory, so illegal characters are removed. |
loginResult | |
newItemName | The name for the ResourceItem.
For Resources of type 'directory_file' or 'directory_object' this corresponds to an actual file name on Windows (any invalid characters will be replaced by '_').
If the item already exists (and the WebService function does not provide a way to overwrite items), a number will be appended to the name to generate a unique name. The generated name is always returned in the result of the WebService function. |
newLibraryName | The name of the library.
This is created as an actual Windows Directory, so illegal characters are removed. |
okOrException | An XML document with DocumentElement 'ok' (<ok/>), or an exception |
previewType | A descriptor for the type of preview. Valid values are: thumbnail: a 100x100px, 72dpi, RGB png medium: a 400x400, 72dpi, RGB png full: a 72dpi, RGB png at the size of the original file swf, either the full png, or a compiled flash object (with preservation of vector information) pdfGeneration: an internal format, used for... PDF Generation
Alternatively, the ID of an Image Conversion Profile can be supplied
|
resourceItemXML | Definition XML of the ResourceItem |
resourceName | The name of the Resource on which to execute the function.
Most data in CHILI Publisher is stored as Resources (eg: Documents, Assets, Fonts).
A list of available resources, their names and their types can be retrieved using the ResourceList function. |
taskXML | An XML string describing the created task, containing its ID and other information. |
url | The URL needs to be accessible from all CHILI servers. Make sure that your firewall settings allow a connection and test the URL from the servers themselves. |
urlInfo | |
xmlString | A valid XML string |