XML structures consumed or returned by the Web services 2.5 API.
This section describes the XML signatures that are consumed or returned by the Web services 2.5 API.
- Annotation Metadata Filter XML Structure
XML structure specifying the metadata values that will be used as a filter - Annotation Metadata XML Structure
The XML for metadata structure will be used for setting metadata of an annotation. Because the same metadata field can occur on multiple levels, the level needs to be specified. - Annotation ObjectList XML Structure
The XML structure containing a list of annotations (and replies). - Background Task Data Objects XML Structure
Describes XML structure for the data objects of the background tasks - Background Task Metadata Filter XML Structure
The XML structure for the Metadata Filter on background tasks. - Background Tasks
The XML structure containing a list of background tasks. - Baseline Information
A baseline is described using the following xml structure. - Baseline Freeze Report XML
Baseline Freeze Report XML Structure contains metadata and a logobject for each publication which references the baseline. - Baseline Modifications
This structure is used to make changes to a baseline. It provides the means to add (selected) objects to the baseline, modify the selected version an object, remove an object from the baseline, etc. - Baseline Object list
The XML structure containing a list of baselines. - Baseline Report
This structure is used when a baseline report is requested. This XML structure is an extension of the Baseline Information XML. It does not only contain the selected objects in the baseline, but also all objects that are referenced by the selected objects. These linked objects can be shown in a user-interface, so that users can select the correct versions for them in order to fill the baseline. The status of the object and its language level information is also present. - Configuration Object List
The XML structure containing the configuration/settings object - ContextEnrichment
A publication context can be extended with the information stored in another publication context. - Data Objects
The Data Objects XML is used for retrieving metadata of one or more Data Objects. - EDT Object list
The XML structure containing a list of EDT Objects - Error Report XML Structure
Error Report XML Structure contains a logobject with the exceptions per object - Event List
The XML structure containing a list of events. - Event Metadata Filter XML Structure
The XML structure for the Metadata Filter on events. - External Translation Job list XML Structure
The XML structure containing the data of the external translation jobs - Field Setup XML Structure
The outgoing XML structure with the field setup. - Field Tag Validations XML Structure
Contains the xml structure with the tags per field - Field Tags XML Structure
Contains the XML structure with the tags per field - FolderList
When the subfolders are retrieved from a folder, an XML structure with the metadata of the current folder and information about the subfolders is returned. - Folder Metadata XML
When the metadata is retrieved from a folder, the following XML structure with the metadata of the folder is returned. - Folders Metadata XML Structure
When the metadata is retrieved from multiple folders, the following XML structure is returned. - FolderQuery
The XML structure used to specify a query on a query folder. - Index term list
XML structure used to describe one or more index terms or synonyms. The structure is mainly based on the DocBook DTD. - Index Translation
XML structure is used for the index translation file and is based on the Index Term List XML with extra attributessrclangandlangon the root nodeindexterms. - Index
XML structure used for the generated back-of-the-book index of a publication or map. The structure is based mainly on the DocBook DTD. - LOV List XML Structure
Describes the XML structure containing the metadata of multiple List Of Values Objects. - LOV ValueList XML Structure
Describes the XML structure containing the metadata of the values of multiple List Of Values Objects. - MetaDataFilter
The metadata filter XML structure is used to specify metadata values that will be used as a filter. - Metadata
The XML for metadata structure will be used for setting metadata of an Content Manager object. Because the same metadata field can occur on multiple levels, the level needs to be specified. - ObjectList
The contents of an inbox, a folder in the repository, a call by a retrieve function or a query result consists of multiple Content Manager objects. These objects are presented in an XML object list structure. - ObjectLocationList XML Structure
The ObjectLocationList XML structure is used to hold a list of logical objects and their folder paths. - Output Format Object list
The XML structure containing a list of Output Format Objects. - Preferences XML structure
Preferences XML structure will be used for creating/updating/retrieving preferences of a Content Manager object. - ProductDefinition
In order to do conditional publishing a context that contains a product definition needs to be supplied. This product definition contains the features of the product for which the publication must be made. All conditions found in the objects are evaluated against this product definition using the Condition Filter component. - Publish Log Objects
The Publish Log Objects XML is used for retrieving metadata of one or more Publish Log Objects. - Publish Report XML
The Publish Report XML contains the report of the publish operation. The Report XML gives an overview of all warnings, errors and informational messages that occurred during the publish operation. - Publish Report Data Objects
The Publish Report Data Objects XML is used for retrieving metadata for a publish report. - Requested Annotation Metadata XML structure
Xml structure specifying which metadata needs to be retrieved for a given annotation - Requested Background Task Metadata XML structure
The XML structure for the Requested Metadata of a background task - Requested Event Metadata XML structure
The XML structure for the Requested Metadata of an event - Requested Metadata
Specifies which metadata needs to be retrieved for a given Content Manager object. - Resources
This is an example of the Content Manager error resource file. - Revision information ObjectList XML structure
The XML structure containing a list of language objects with the metadata and the revision information - SearchQuery
To specify full-text queries, an XML structure with the search criteria needs to be supplied. - Search Result XML Structure
The XML structure with the result of the full-text queries. - Settings XML Structure
XML structure used for the settings. - Translation Job container list incoming XML Structure
The incoming XML structure containing the data of the translation job containers - Translation Job container list outgoing XML Structure
The outgoing XML structure containing the data of the translation job containers - Translation Job item list XML Structure
The XML structure containing the data of the translation job items - TranslationJob ObjectList XML Structure
The XML structure containing a list of translation jobs. - Translation template list incoming XML Structure
The incoming XML structure containing the data of the translation templates. - Translation template list outgoing XML Structure
The outgoing XML structure containing the data of the translation templates. - Translation Job workflow list incoming XML Structure
The incoming XML structure containing the data of the translation job workflows - Translation Job workflow list outgoing XML Structure
The outgoing XML structure containing the data of the translation job workflows - Translation Statuses XML Structure
Describes the XML structure containing the statuses used during the translation flow. - User ObjectList XML Structure
The XML structure containing a list of users. - UserGroup ObjectList XML Structure
The XML structure containing a list of user groups. - UserRole ObjectList XML Structure
The XML structure containing a list of user roles.