pp108 : AppendXMLObject

AppendXMLObject


This Web service operation is used to append an XML Object.

SOAP Request

This API is used to append an XML Object to an already existing XML Object in the XMLStore. If the object doesn't exist, it creates an XML Object. 

<AppendXMLObject xmlns="http://schemas.cordys.com/1.0/xmlstore">
    <tuple key="/cordys/audit/artifacts/ann" version="organization">
        <new>
            <employee>
                <employeefield>test</employeefield>
            </employee>
        </new>
    </tuple>
</AppendXMLObject>

Request Parameters

Parameter

Description

new

Contains the new tuple values that need to be appended to the existing XML object.


SOAP Response

<AppendXMLObjectResponse xmlns="http://schemas.cordys.com/1.0/xmlstore" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <tuple key="/cordys/audit/artifacts/ann"
        lastModified="1237958951721" level="organization" name="ann"
        original="/cordys/audit/artifacts/ann" version="organization"
        xmlns="http://schemas.cordys.com/1.0/xmlstore" xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/"/>
</AppendXMLObjectResponse>

Parameter

Description

<tuple>

The <tuple> tag has an optional attribute 'version' which can contain isv or organization or user. This specifies the version of the XML Store content that is to be retrieved.

key

Relative path of the XML Object. If the relative path does not exist, the connector creates the specified path and specified XML Object

name

Name of the XML object

lastModified

LastModified value of the XML Object

level

Specifies the version (user/organization/isv) where the XML Object is created

version

This is an optional attribute, ' version '. It determines the version of the XML Store content that will be fetched. It can contain one of the following values:

  • isv
  • organization
  • user

original

Specifies the correct case of the key as stored in the file system



Note:
By default, the XML Object is searched in the current organization. If not found, it is then searched in ISV folder. If the user wants a particular version (user/isv/organization) of XML Object to be retrieved, then the version can be specified in the version attribute of <tuple>.