Performs document searches.
GET {{baseUrl}}/document?q=exercitation id&fields=exercitation id&lscsText=exercitation id&lscsField=exercitation id&max=33927043.5654576&start=33927043.5654576&sort=exercitation id&showFacet=exercitation id&traverse=exercitation id&streamUnique=false&maxFacet=33927043.5654576&expandMVF=true&project=exercitation id&includeDCRContent=true&format=XML
Returns a list of documents.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
q | string | The search query. | |
fields | string | Include metadata in the response. The wildcard * indicates all available metadata fields. A comma-separated list can be specified (e.g. title,path) to output only some fields. If empty no metadata is included in the response. This parameter should be used instead of the deprecated option to append the $ character to the path (e.g., document$*?q=...) | |
lscsText | string | Used to query for text value only. | |
lscsField | string | Used to query for field text value only. | |
max | string | Maximum number of results to return. This parameter is required for applications that want more or less than the default number of results per request. Default is 10. | |
start | string | Index of the first returned document in the result set. Default is 0. | |
sort | string | A comma-separated list of fields by which to sort the results. To sort date and numeric fields in ascending order, prefix the field name with the plus (+) character. Note that the + character must be percent-encoded as %2B when included in the URL. To sort these fields in descending order, prefix the field name with the minus (-) character. By default, the fields will be sorted in alphabetical order. If sort=random, the result set will be in a random order. | |
showFacet | string | A comma-separated list of fields for which to include value summaries. | |
traverse | string | The name of a metadata field containing the area-relative paths of related documents to include in the result. The traverse parameter should include a metadata field list. Multiple fields can be specified in a semicolon-delimited list. | |
streamUnique | boolean | When true, returns the content of the first asset instead of a content filter result. Cannot be used in conjunction with a metadata field list. | |
maxFacet | string | The maximum number of facet values returned. By default, this is 100. | |
expandMVF | boolean | By default, multivalued fields are displayed as they were stored in TeamSite. To split these fields into separate values, set expandMVF to true. | |
project | string | The project from which to select assets. If no parameter is not included in the request, then assets are selected from the default project. See description of the defaultProject setting in the lscs-conf.properties file. | |
includeDCRContent | boolean | Boolean. If true, it will include the file content of DCR documents. | |
format | string | The response format, json or XML. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
[[{"id":"nostrud officia ex","uri":"dolore incididunt consequat","path":"dolore in ullam","context":"fugiat sit laboris esse mollit"},{"id":"elit eiusmod fugiat laborum","uri":"id exercitation sint ipsum","path":"laboris enim","context":"ea"}],[{"id":"id ex deserunt","uri":"ad","path":"incididunt ea est","context":"ullamco Excepteur et enim"},{"id":"ad culpa adipisicing et","uri":"velit voluptate elit aliqua nostrud","path":"Lorem occaecat dolore","context":"magna enim exercitation"}]]