XML reponse body for object-based queries

Content Platform Tenant Management Help

Version
9.7.x
File Size
4269 KB
Audience
anonymous
Part Number
MK-95HCPH002-19

An XML response for an object-based query has this format:

<?xml version='1.0' encoding='UTF-8'?>
<queryResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="/static/xsd/query-result-6.0.xsd">
    <query>
        <expression>query-request-entry</expression>
    </query>
    <resultSet>
         <object
             changeTimeMilliseconds="change-time-in-milliseconds.index"
             version="version-id"
             urlName="object-url"
             operation="operation-type"
             Additional properties if specified in the objectProperties request entry
                or if the verbose request entry specifies true
         />
        Additional object entries
    </resultSet>
    <status
         totalResults="total-object-count"
         results="returned-object-count"
        message=""
         code="COMPLETE|INCOMPLETE" />
    The contentProperties entry below is included only if the request included a
    contentProperties entry with a vlaue of true.
    <contentProperties>
         <contentProperty>
             <expression>content-property-expression</expression>
             <name>content-property-name</name>
             <type>data-type</type>
             <multivalued>true|false</multivalued>
             <format>data-format</format>
         </contentProperty>
         Additional content properties
    </contentProperties>
    The facets entry below is included only if the request included a facets entry.
    <facets>
        One or more of the following facet entries depending on the properties specified
         in the facets request entry
         <facet
         property="hold">
         <frequency
             count="object-count"
             value="true" />
         <frequency
             count="object-count"
             value="false" />
         </facet>
         <facet
             property="namespace">
             <frequency
                 count="object-count"
                 value="namespace-name.tenant-name" />
            Up to 99 additional frequency entries
             </facet>
             <facet
                 property="retentionClass">
                 <frequency
                 count="object-count"
                 value="retention-class-name" />
            Up to 99 additional frequency entries
         </facet>
         <facet
             property="retention">
             <frequency
                 count="object-count"
                 value="initialUnspecified" />
             <frequency
                 count="object-count"
                 value="neverDeletable" />
             <frequency
                 count="object-count"
                 value="expired" />
             <frequency
                 count="object-count"
                 value="not expired" />
             </facet>
            Zero or more of the following facet entries depending on the number of content
             properties in the facets request entry:
             <facet
                 property="content-property-name">
                 <frequency
                     count="object-count"
                     value="value-or-facet-range" />
                Up to 99 additional range frequency entries
         </facet>
    </facets>
</queryResult>