GET api/2.0/project/{id}/@search/{query} This function requires authentication

Description

Returns the search results for a project containing the words/phrases matching the query specified in the request.

Parameters

Name	Description	Type	Example
id sent in url	Project ID	number	1234
query sent in url	Search query	string	some text

Example

GET api/2.0/project/1234/@search/%22some+text%22
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

Returns

List of results

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "Item": {
        "Id": 345,
        "EntityType": 0,
        "Title": "Sample title",
        "Description": "Sample desription",
        "Created": "2020-12-22T04:11:56.5308514Z"
      },
      "Owner": {
        "Id": 345,
        "EntityType": 0,
        "Title": "Sample title",
        "Description": "Sample desription",
        "Created": "2020-12-22T04:11:56.5308514Z"
      }
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <Item>
      <Id>345</Id>
      <EntityType>0</EntityType>
      <Title>Sample title</Title>
      <Description>Sample desription</Description>
      <Created>2020-12-22T04:11:56.5308514Z</Created>
    </Item>
    <Owner>
      <Id>345</Id>
      <EntityType>0</EntityType>
      <Title>Sample title</Title>
      <Description>Sample desription</Description>
      <Created>2020-12-22T04:11:56.5308514Z</Created>
    </Owner>
  </response>
</result>