JSON request body for operation-based queries

Content Platform Tenant Management Help

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

The JSON request body for an operation-based query must contain an unnamed top-level entry and, except when requesting all available information, the operation entry. All other entries are optional.

The JSON request body has the format shown below. Entries at each hierarchical level can be in any order:

{
   "operation": {
      "count":"number-of-results",
      "lastResult":{
          "urlName":"object-url",
          "changeTimeMilliseconds":"change-time-in-milliseconds.index",
          "version":version-id
      },
      "objectProperties":"comma-separated-list-of-properties",
      "systemMetadata":{
          "changeTime":{
              "start":start-time-in-milliseconds,
              "end":end-time-in-milliseconds
          },
          "directories":{
              "directory":["directory-path",...]
          },
          "indexable":"(true|false)",
          "namespaces":{
              "namespace":["namespace-name.tenant-name",...]
          },
            "replicationCollision":"(true|false)",
          "transactions":{
              "transaction":["operation-type",...]
          }
      },
        "verbose":"(true|false)"
    }
 }

For the namespace, directory, and transaction entries, the square brackets shown in this format are required.

The JSON body for an operation-based query that requests all available operation records contains only this line:

{}