main
WebService functions for CHILI Publisher
The following operations are supported. For a formal definition, please review the Service Description.
-
ApiKeyClearHeaderFieldsForServerDownloads
Clear HTTP header key/value pairs for apiKey.
-
ApiKeyGetCurrentSettings
Return the current XML representation of the apiKey
-
ApiKeyKeepAlive
Call to keep the current apiKey alive (slide expiration back)
-
ApiKeySetHeaderFieldForServerDownloads
Add HTTP header key/value pairs for apiKey. When that API key is used to generate a PDF of a document that contains external assets, those key/value pairs are sent along in the header of the http request to download the high res assets.
-
ApiKeySetRequestHeaderForDomain
Add HTTP header key/value pairs for a domain on the apiKey. When that API key is used to generate a PDF of a document that contains external assets, those key/value pairs are sent along in the header of the http request to download the high res assets.
You can use wildcards for the domain. Be sure to first add the wildcards, adn then the specific ones.
-
ApiKeySetRequestWithCredentialsForDomain
Specify if client side requests to a domain needs to use the available credentials or not.
You can use wildcards for the domain. Be sure to first add the wildcards, adn then the specific ones.
- ApiKeyVerify
-
AssetGetImageInfo
Returns information about the underlying image
-
CsvFileCreate
Converts an XML to CSV format, and returns a download link
-
DataSourceAddSampleFile
Adds a new sample file to a DataSource
-
DataSourceDeleteSampleFile
Deletes a sample files assigned to a DataSource
-
DataSourceDownloadSpreadsheets
Downloads a list of spreadsheets for a datasource (if its type = 'google')
-
DataSourceDownloadURL
Returns the result of one of the external URLs for a DataSource
-
DataSourceFileGetXML
Converts an uploaded file to generic XML using the settings of a DataSource
-
DataSourceListSampleFiles
Get a list of the sample files assigned to a DataSource
-
DataSourceSalesForceGetXML
Downloads an XML representation of the selected salesforce Query
-
DataSourceSpreadsheetGetXML
Downloads an XML representation of the selected spreadsheet
-
DocumentCopyAnnotations
Duplicates annotations from one document to another
-
DocumentCopyDocumentEventActions
Duplicates Document Event Actions from one document to another
-
DocumentCopyVariableDefinitions
Duplicates variable definitions from one document to another
-
DocumentCreateAnimation
Generates a Animation.
-
DocumentCreateFromBlankDocTemplate
Creates a new document based on the settings in the "DocumentTemplates" resource. This resource contains such settings as number of pages, dimensions, etc.
-
DocumentCreateFromChiliPackage
Creates a new document based on a zip file containing a CHILI package (usually generated by the InDesign Extension).
-
DocumentCreateFromODT
Creates a new document based on a Open Document Text file.
-
DocumentCreateFromPDF
Creates a new document based on a PDF file
-
DocumentCreateHTML
Generates the HTML package of the doucment.
-
DocumentCreateIDML
Generates the IDML package of the doucment.
-
DocumentCreateImages
Generates a zip containing images of all the pages in the document.
-
DocumentCreateImagesAndPDF
Generates a zip containing the PDF and images of all the pages in the document.
-
DocumentCreateODF
Generates the ODF package of the doucment.
-
DocumentCreatePDF
Generates a PDF of the document.
-
DocumentCreatePackage
Generates a CHILI Package of the document.
- DocumentCreateTempAnimation
-
DocumentCreateTempFolding
Generates Temp Folding output XML
-
DocumentCreateTempHTML
Generates the HTML package of the doucment, based on document XML which hasn't been saved yet (but is being edited in the editor, for example)
-
DocumentCreateTempIDML
Generates the IDML package of the doucment, based on document XML which hasn't been saved yet (but is being edited in the editor, for example)
-
DocumentCreateTempImages
Generates Images of all the pages in the document, based on document XML which hasn't been saved yet (but is being edited in the editor, for example)
-
DocumentCreateTempImagesAndPDF
Generates a zip file with PDF and images of all the pages in the document, based on document XML which hasn't been saved yet (but is being edited in the editor, for example)
-
DocumentCreateTempODF
Generates the ODF package of the doucment, based on document XML which hasn't been saved yet (but is being edited in the editor, for example)
-
DocumentCreateTempPDF
Generates a PDF of the document, based on document XML which hasn't been saved yet (but is being edited in the editor, for example)
-
DocumentCreateTempPackage
Generates a CHILI Package of the document, based on document XML which hasn't been saved yet (but is being edited in the editor, for example)
-
DocumentGetAnnotations
Returns information on the annotations contained in a document
-
DocumentGetDefaultSettings
Returns default settings for an editor session. This function is used by CHILI Editor to retrieve a series of informations in one call.
-
DocumentGetDocumentEventActions
Returns the definitions of the Document Event Actions contained in a document
-
DocumentGetEditorURL
Returns a URL for editing (or viewing) of the specified document, with arguments to determine how the interface will be constructed
-
DocumentGetFoldingViewerURL
Returns a URL for viewing of a document's Folding representation
-
DocumentGetHTMLEditorURL
Returns a URL for editing (or viewing) of the specified document, with arguments to determine how the interface will be constructed
-
DocumentGetHTMLFoldingViewerURL
Returns a URL for viewing of a document's Folding representation
-
DocumentGetHTMLPreload
Returns an XML representation of the resources that need to be preloaded
-
DocumentGetHTMLPreloadURL
Returns a URL for preloading the specified document, with arguments to determine how the interface will be constructed
-
DocumentGetHTMLThreeDModelViewerURL
Returns a URL for viewing of a document's ThreeDModel representation
-
DocumentGetInfo
Returns general information on a document in an XML format which is easier to parse than the full document XML.
-
DocumentGetIpadXML
Called by the iPad Reader to get a description of a document
-
DocumentGetPreflightResults
Returns information on the preflight results which were present in the document on the last save
-
DocumentGetThreeDModelViewerURL
Returns a URL for viewing of a document's ThreeDModel representation
-
DocumentGetUsedAssets
Returns information on the assets contained in a document
-
DocumentGetVariableDefinitions
Returns the definitions of the variables contained in a document
-
DocumentGetVariableValues
Returns the values of the variables contained in a document
-
DocumentProcessServerSide
Processes the document server-side.
Either an itemID or resourceXML need to be provided. If an itemID (document ID) is provided, the CLI reads the document from the CHILI DAM and saves it to the CHILI DAM.
If a resourceXML is provided, the provided XML is loaded by the CLI. The result is saved to the temp folder.
-
DocumentSetAnnotations
Inserts annotations into a document
-
DocumentSetAssetDirectories
Save new Asset Directory locations (doc., user, user group) for the document. Empty strings will be ignored (so the existing value will be retained). To clear an asset directory, provide the string 'empty' as the argument
-
DocumentSetConstraints
Applies constraints to a document.
The constraints are configured in the "DocumentConstraints" Resource (usually through the backoffice). These contain settings to configure naming conventions (and general settings) for the application of constraints.
The naming conventions are used to update the document (you will see the constraints in the DocumentConstraints, Page Settings, Layer Settings and Frame Constraints panel items in CHILI Editor)
-
DocumentSetDataSource
Sets a datasource on a document
-
DocumentSetDocumentEventActions
Applies Document Event Action definitions to a document
-
DocumentSetVariableDefinitions
Applies variable definitions to a document
-
DocumentSetVariableValues
Sets the values of variables in a document
-
DownloadAssets
Download an Asset from the server
-
DownloadDatasourceSample
Download a Datasource from the server
-
DownloadExternal
Download an external resource
-
DownloadFolding
Download a Folding from the server
-
DownloadFontPreview
Download a Font Preview from the server
-
DownloadIcons
Download Icons from the server
-
DownloadLoginBackground
Download a Login Background from the server
-
DownloadReflectionMap
Download a Reflection Map from the server
-
DownloadTempFile
Download a temporary asset file from the server
-
DownloadURL
Download a URL from the server. This function is used by CHILI Editor to prevent security issues (eg: crossdomain.xml files which aren't present on the target server)
- DynamicAssetProviderGetTempAsset
-
EditsGetFromURL
Downloads an external XML file containing information on edits, and converts it for use in CHILI Editor
-
EnvironmentAdd
Creates a new environment, with the specified name
-
EnvironmentCopy
Copies an existing environment. A new environment is created and all files are copied
-
EnvironmentDelete
Deletes a complete environment, including it's files on disk
-
EnvironmentGetColorProfiles
Returns a list of the Color Profiles available for the environment.
-
EnvironmentGetCurrent
Returns a description of the current environment
-
EnvironmentGetDiskUsage
Provide a list of resources/folders, and have the same XML structure returned including the folder sizes
-
EnvironmentGetLoginSettings
Gets initial settings for the specified environment. This function is called before the user has logged in, so it does not require an API Key (and therefore also only returns the most basic information required for a login screen)
-
EnvironmentGetReflectionMaps
Returns a list of the Reflection Masks in the enviroment
-
EnvironmentGetSettings
Returns the settings of the specified environment
-
EnvironmentList
Returns a list of available environments for the current user
-
EnvironmentSaveSettings
Saves the settings of an environment
-
FoldingSettingCreatePackage
Returns a ZIP with all the needed recources and the settings file with fixed references.
-
FontGetIncludedGlyphs
Returns an XML document containing ranges of glyphs (and their availibility) in the font
-
GenerateApiKey
Generates an apiKey for subsequent calls to the other webservice functions. Use SetWorkingEnvironment to use your user account (if it is an administrator) to access different environments. Date formatting was changed from version 1.2. The timezone can be checked by calling GetServerDate api method.
-
GenerateApiKeyOAuth
Generates an apiKey for subsequent calls to the other webservice functions. Date formatting was changed from version 1.2. The timezone can be checked by calling GetServerDate api method.
-
GenerateApiKeyWithSettings
Generates an apiKey for subsequent calls to the other webservice functions. Use SetWorkingEnvironment to use your user account (if it is an administrator) to access different environments. Date formatting was changed from version 1.2. The timezone can be checked by calling GetServerDate api method.
-
GetServerDate
Returns the date of the server. The formatting was changed from version 1.2
-
GoogleCreateAuthorizationUrl
Returns an URL so Google OAuth 2.0 can be performed.
-
HealthCheckExecute
Executes a Health Check, and returns an XML string with the found warnings/errors
-
IconSetAddIcon
Ads an icon (png) to an IconSet Resource Item
-
IconSetDeleteIcon
Removes an icon from an IconSet Resurce Item
-
IconSetGetIcons
Describes the icons which are present in an Icon Set (and optionally also includes all non-present icon definitions)
-
InterfaceGetInitialSettings
Function used by CHILI Editor to retrieve a number of settings of the current Environment in one call.
-
LanguageGetCombinedStrings
Get the (combined) strings for a Language. This includes the values of the parent language for non-translated strings.
-
LanguageGetCsvURL
Returns a urlInfo XML for the CSV file of the language (which is created on the fly)
-
LanguageGetUnicodeTextURL
Returns a urlInfo XML for the txt file (tab-delimited) of the language (which is created on the fly)
-
LanguageImportCsv
Uploads a CSV file (of the same format as exported using LanguageGetCsvURL) and imports it into a language.
Strings outside of the 'Custom' section are not created, only updated.
-
LanguageImportUnicodeText
Uploads a txt file (tab-delimited, of the same format as exported using LanguageGetUnicodeTextURL) and imports it into a language.
Strings outside of the 'Custom' section are not created, only updated.
-
LanguageSaveStrings
Saves the string library for a language
-
LanguagesGetList
Returns a list of the available languages in the environment (optionally including system languages, on which environment languages can be based)
-
LockApiKey
Locks an API key
(this can be checked by other web service functions)
-
MobileFeedGetDocumentList
Returns an XML description of the documents available in a Mobile Feed
-
MobileFeedGetDocumentXML
Returns an XML description of the documents available in a Mobile Feed
-
ODTGetStyles
Returns an XML description of the styles contained in the ODT. Used for parsing an ODT document and create the style conversion table.
-
ODTGetTextFlow
Returns an XML description of the styles contained in the ODT. Used for parsing an ODT document and create the style conversion table.
-
ProfilingClearSnapshot
Clears the current profiling snapshot
-
ProfilingSaveSnapshot
Saves a profiling SnapShot
-
ResourceFolderAdd
Adds a folder to a Resource (if it is of type directory_object or directory_file
-
ResourceFolderCopy
Copies a Resource folder to a new location in the Resource's tree
-
ResourceFolderDelete
Removes a folder from a Resource tree (if it is of type directory_object or directory_file
-
ResourceFolderMove
Moves a Resource folder to a new location in the Resource's tree
-
ResourceGetHistory
Returns the history of a Resource
-
ResourceGetTree
Returns the tree structure of the Resource (if the type of the resource is "directory_file" or "directory_object")
-
ResourceGetTreeLevel
Returns the tree structure of the Resource (if the type of the resource is "directory_file" or "directory_object"), with a maximum number of sub-folders included. Use '1' to get the files and folders without any files inside the folders
-
ResourceItemAdd
Adds a ResourceItem to the specified Resource, and returns its definition XML
-
ResourceItemAddFromURL
Adds a ResourceItem by downloading the underlying file from an external URL
-
ResourceItemAddFromURLWithModificationDate
Adds a ResourceItem by downloading the underlying file from an external URL
-
ResourceItemAddPreviewOverride
Adds an override file to the ResourceItem, which is used to generate previews
-
ResourceItemAddWithPreview
Adds a ResourceItem to a Resource, and returns its definition XML.
To prevent previews from being generated automatically while you intend to supply an override file, this function allows you to pass both at the same time.
-
ResourceItemCopy
Copies a ResourceItem, and returns the definition XML of the new item.
-
ResourceItemDelete
Deletes a ResourceItem
-
ResourceItemGetByIdOrPath
Returns a ResourceItem based on its ID (checked first) or path in the Resource's tree (or, if the resource is of type list, its name)
-
ResourceItemGetByName
Gets the definition XML of a ResourceItem based on its name. For Resources of type directory_object or directory_list, the first found item (being the oldest) is returned
-
ResourceItemGetByPath
Returns a ResourceItem based on its path in the Resource's tree
-
ResourceItemGetCacheInfo
Returns XML describing the state of the cache (previews, ...) of the ResourceItem
-
ResourceItemGetCustomMetaData
Returns metadata of the object
-
ResourceItemGetDefinitionXML
Returns the definition XML of a ResourceItem
-
ResourceItemGetHistory
Returns the history of a ResourceItem
-
ResourceItemGetPrivateInfo
Returns XML describing the state of the private data (previewErrors, fileinfo, ...) of the ResourceItem
-
ResourceItemGetTransformedURL
Returns a url pointing to the preview (in the specified type and for the specified page, and with the provided Transformation effects) of the ResourceItem
-
ResourceItemGetTransformedURLWithDebugInfo
Returns a url pointing to the preview (in the specified type and for the specified page, and with the provided Transformation effects) of the ResourceItem, similar to ResourceItemGetTransformedURL. But the current function also includes information which can be used to debug the generated preview (file size, dimensions, ...)
-
ResourceItemGetURL
Returns a url pointing to the preview (in the specified type and for the specified page) of the ResourceItem
-
ResourceItemGetURLForAnonymousUser
Returns a url pointing to the preview (in the specified type and for the specified page) of the ResourceItem.
The URL contains an apiKey for the Anonymous user (which does not expire, and has highly limited privileges).
-
ResourceItemGetURLWithDebugInfo
Returns a url pointing to the preview (in the specified type and for the specified page) of the ResourceItem, similar to ResourceItemGetURL. But the current function also includes information which can be used to debug the generated preview (file size, dimensions, ...)
-
ResourceItemGetXML
Returns the underlying XML of the object (for a Resource of type directory_object), or the definition XML for other types
-
ResourceItemMove
Moves a Resource Item to a new location in the Resource's tree
-
ResourceItemRemovePreviewOverride
Deletes the preview override files for a ResourceItem
-
ResourceItemReplaceFile
Replaces the underlying file of a Resource Item of type directory_file, and returns its definition XML.
-
ResourceItemReplaceFileWithPreviewOverride
Replaces the underlying file of a Resource Item of type directory_file, and returns its definition XML.
To prevent previews from being generated automatically while you intend to supply an override file, this function allows you to pass both at the same time.
-
ResourceItemResetPreviews
Deletes all generated previews of the ResourceItem, and resets any "error" switches
-
ResourceItemSave
Saves the definition XML or the underlying object XML of a Resource Item (depending on the Resource's type)
-
ResourceItemSaveCustomMetaData
Saves metadata of specified resource item
-
ResourceItemsAddFromZip
Adds ResourceItems to the specified Resource, based on a ZIP file
-
ResourceLibraryGetSettings
Returns the settings of the specified Library (a top-level directory in the Resource's tree)
-
ResourceLibrarySaveSettings
Saves the settings of the specified Library (a top-level directory in the Resource's tree)
-
ResourceList
Returns a list of the available Resources.
-
ResourceSearch
Search for items in the resource
-
ResourceSearchByIDs
Search for items in the resource, based on a list of IDs
-
ResourceSearchInFolder
Search for items in the resource
-
ResourceSearchPaged
Search for items in the resource, and returns a paged result list
-
ResourceSearchPagedWithSorting
Search for items in the resource, and returns a sorted paged result list.
When using paging, you can either specify a page number or a an item id.
-
ServerDeleteAllSaveSystemFileInfos
Removes all previously saved server info sets
-
ServerDeleteSavedSystemInfoXML
Deletes a previously saved server information set
- ServerGetLicenseInfo
-
ServerGetLoggingSettings
Returns the server logging settings
-
ServerGetSavedSystemInfoList
Returns a list of previously saved system info XML files
-
ServerGetSavedSystemInfoXML
Returns XML which was previously generated using ServerGetSystemInfo and saved using ServerSaveSystemInfoXML
-
ServerGetSettings
Returns the server settings
-
ServerGetSystemInfo
Returns information on the server CHILI is installed on. If 'extended' information is requested, the gathering of the information will take longer, and require more server resources
-
ServerLicenseRequest
Handles server licensing requests
-
ServerLogClear
Removes all current log files
-
ServerSaveLoggingSettings
Saves the server logging settings
-
ServerSaveSettings
Saves the server settings
-
ServerSaveSystemInfoXML
Saves the provided xml to the system info repository
-
SetAssetDirectories
Applies values to the Asset Directories which can be entered also per document in the Document Settings panel. These values are applied to the apiKey, and override any values entered manually inside a document.
To clear an existing value, provide the string 'empty'. An empty string ('') indicates that nothing changes for that argument.
-
SetAutomaticPreviewGeneration
If set to false, previews for new items are not automatically generated all at once (to prevent file locks while you still plan on working on the new item, for example)
-
SetContentAdministration
Toggles content administration privileges for the current apiKey.
This privilege influences the possibility to manage the content of a document in the CHILI Editor including more advanced settings (eg Constraints). Inside the editor, various items have settings referencing "Administrators". This means a user which has workspace or content administration privileges, depending on the context.
-
SetNextResourceItemID
Set the GUID for the next item in the queue.
It will be used when adding items via "ResourceItemAdd" or equivalents
-
SetUserLanguage
Applies a language for the editor to the current apiKey session
-
SetWorkingEnvironment
Sets the working environment as a property of the generated apiKey.
All subsequent calls to the WebServices will operate inside that environment.
This function can only be called if the user you have logged in with (using GenerateApiKey) is part of the top-level "Admin" environment.
-
SetWorkspaceAdministration
Toggles workspace administration privileges for the current apiKey.
This privilege influences the possibility to manage the workspace in the CHILI Editor. Inside the editor, various items have settings referencing "Administrators". This means a user which has workspace administration privileges.
By toggling the privilege, you can have a single CHILI user (potentially with "Environment Administrator" privileges) to log in the webservices (using GenerateApiKey) for all of your own users.
NOTE: for backward compatibility, setting workspace administration to false also sets content administration to false. This can be switched on again using the SetContentAdministration function if applicable.
-
SwitchServerFlowGetCheckPoints
Returns a list of the submit points of a flow
-
SwitchServerFlowGetElementsJobCount
Returns a list of the jobs existing inside a Switch FLow
-
SwitchServerFlowGetFullConfig
Returns the full configuration of the Flow
-
SwitchServerFlowGetJobs
Returns a list of the submit points of a flow
-
SwitchServerFlowGetSubmitPoints
Returns a list of the submit points of a flow
-
SwitchServerFlowSubmitFileToFolder
Submit a file to an input folder of a Switch Flow
-
SwitchServerFlowSubmitFileToSubmitPoint
Submit a file to a Submit Point in a Switch Flow
-
SwitchServerGetFlowList
Returns a list of the Flows available in a Switch Server
-
SwitchServerTestConnection
Tests whether a connection can be made to the Switch application located at 'url'
-
TaskGetEditorCliLog
Returns the current log of Editor_CLI (for tasks of type documentSaveXml)
-
TaskGetStatus
Returns an XML description of the status of a task
-
TaskGetStatusAndRemoveIfCompleted
Returns an XML description of the status of a task. If the task has completed, it will be removed from the Log directory of the Queue
-
TaskRemoveFromLog
Removes (deletes) a Task file from the Log directory
-
TasksGetList
Returns a list of tasks
-
TasksGetQueueOverview
Returns an overview of the status of the various Windows Services which are monitoring the Queue
-
TasksGetStatusses
Returns the status of multiple tasks simultaneously
-
ThreeDModelCreatePackage
Returns a ZIP with all the needed recources and the settings file with fixed references.
-
UploadExternalAsset
Adds an asset to an External Asset Library
-
XinetExecutePortalDICall
Executes a command by calling the specified Xinet Server's portalDI application
-
XinetSetCurrentCredentials
All calls to Xinet WebNative are called from a XinetSetting object, which includes user credentials. If you want to simulate being another user, though, you can call the XinetSetCurrentCredentials function. This applies a new user/pw, and saves it in the apiKey. All subsequent calls to Xinet performed under this apiKey will run under this Xinet User Account. Set the userName to an empty string to re-use the global setting.
-
XinetTestConnection
Tests whether a connection can be made to the portalDI application located at 'url'