The following objects are used in multiple endpoints within the Query API.
Response Body
Element | Description | Type | Notes |
---|---|---|---|
repositoryId | Alphanumeric ID of the internal repository. | string | Default value is default. |
query | The HXQL query used to return search results. | string | Required in request bodies. |
limit | The maximum number of documents that can be retrieved by the given query. | integer | Default value is 0. |
offset | The number of documents to skip in the search results before starting to retrieve them. | integer | Used for pagination support. The default value is 0. |
trackTotalCount | True/false indicator of whether the total count of the query was computed. | Boolean | None |
totalCountIsTruncated | True/false indicator of whether the total count of the query was truncated. | Boolean | None |
documents | List of the documents retrieved by the given query. | array | For more information on the child elements commonly used within a document, see Document. |
aggregates | List of the aggregates being used to filter the search results. | array | The Hyland Content repository supports the following aggregate
types:
For more information on aggregates and these supported types, see the OpenSearch documentation. |
totalCount | The total number of documents that match the query. | integer | If the trackTotalCount element is set to false, the totalCount value is approximated. |
count | The number of documents included in the search results after accounting for the specified limit and offset values. | integer | None |
Sample Response
{ "repositoryId": "default", "query": "SELECT * FROM SysContent", "limit": 100, "offset": 100, "trackTotalCount": true, "totalCountIsTruncated": true, "documents": [ { "sys_repository": "string", "sys_id": "string", "sys_primaryType": "string", "sys_title": "string", "sys_name": "string", "sys_path": "string", "sys_parentId": "string", "sys_parentPath": "string", "sys_version": 0, "sys_versionSeriesId": "string", "sys_isCheckedIn": true, "sys_isFolderish": true, "sys_isProxy": true, "sys_isTrashed": true, "sys_isVersion": true, "sys_isLatestVersion": true, "sys_mixinTypes": [ "string" ], "sys_lifecycleState": "string", "sys_pos": 0, "sys_acl": [ { "creator": "string", "permission": "string", "granted": true, "user": { "id": "string", "firstName": "string", "lastName": "string", "email": "string" }, "group": { "id": "string", "name": "string", "label": "string" }, "end": "2022-03-10T16:15:50Z", "begin": "2022-03-10T16:15:50Z", "status": "PENDING" } ], "sys_effectiveAcl": [ { "creator": "string", "permission": "string", "granted": true, "user": { "id": "string", "firstName": "string", "lastName": "string", "email": "string" }, "group": { "id": "string", "name": "string", "label": "string" }, "end": "2022-03-10T16:15:50Z", "begin": "2022-03-10T16:15:50Z", "status": "PENDING" } ], "sys_effectivePermissions": [ "string" ], "sys_fulltextBinary": "string", "additionalProp1": {} } ], "aggregates": { "additionalProp1": { "id": "string", "type": "string", "field": "string", "properties": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "ranges": [ { "key": "medium", "from": 2048.0, "to": 6144.0 } ], "dateRanges": [ { "key": "string", "from": "string", "to": "string" } ], "selection": [ "string" ], "buckets": [ { "key": "string", "docCount": 0 } ], "extendedBuckets": [ { "key": "string", "docCount": 0 } ], "xPathField": "string" }, "additionalProp2": { "id": "string", "type": "string", "field": "string", "properties": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "ranges": [ { "key": "medium", "from": 2048.0, "to": 6144.0 } ], "dateRanges": [ { "key": "string", "from": "string", "to": "string" } ], "selection": [ "string" ], "buckets": [ { "key": "string", "docCount": 0 } ], "extendedBuckets": [ { "key": "string", "docCount": 0 } ], "xPathField": "string" }, "additionalProp3": { "id": "string", "type": "string", "field": "string", "properties": { "additionalProp1": "string", "additionalProp2": "string", "additionalProp3": "string" }, "ranges": [ { "key": "medium", "from": 2048.0, "to": 6144.0 } ], "dateRanges": [ { "key": "string", "from": "string", "to": "string" } ], "selection": [ "string" ], "buckets": [ { "key": "string", "docCount": 0 } ], "extendedBuckets": [ { "key": "string", "docCount": 0 } ], "xPathField": "string" } }, "totalCount": 0, "count": 0 }