JSON response 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

A JSON response for an object-based query has this format:

{
    "queryResult":{
        "query":{
             "expression":"query-request-entry"
         },
         "resultSet":[{
             {
                  "urlName":"object-url",
                 "operation":"operation-type",
                 "changeTimeMilliseconds":"change-time-in-milliseconds.index",
                 "version":version-id,
                Additional properties if specified in the objectProperties request entry or
                  if the verbose request entry specifies true
             },
            Additional object entries
        }],
             "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 value of true
         "contentProperties":[{
             "contentProperty":{
             “expression":content-property-expression,
             "name":content-property-name,
             "type":data-type,
             "multivalued":true|false,
             "format":data-format,
         }
         Additional content properties
     }],
    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":[{
                 "value":"true",
                 "count:object-count
                 }, {
                "value":"false",
                "count":object-count
                 }]
                 }, {
                    "property":"namespace",
                    "frequency":[{
                        "value":"namespace-name.tenant-name",
                        "count":object-count
                    Up to 99 additional value properties
                    }]
                }, {
                    "property":"retentionClass",
                     "frequency":[{
                         "value":"retention-class-name",
                         "count":object-count
                         Up to 99 additional value properties
                          }]
                      }, {
                           "property":"retention",
                           "frequency":[{
                              "value":"initialUnspecified",
                              "count":object-count
                         },{
                             "value":"neverDeletable",
                              "count":object-count
                          },{
                              "value":"expired",
                              "count":object-count
                          },{
                             "value":"not expired",
                              "count":object-count
                         ]
                              Zero or more of the following facet entries depending
                              on whether the number of defined content properties in the
                              facets request entry.
                      },{
                         property:"content--property-name",
                          frequency:[{
                              count:"object-count",
                              value:"value-or-facet-range"
                          },{
                             Up to 99 additional range frequency entries
                   }
                 }]
          }]
    }
}