GET api/2.0/project/message/filter This function requires authentication

Description

Returns a list with the detailed information about all the messages matching the filter parameters specified in the request.

Parameters

Name	Description	Type	Example
projectid sent in url	Project ID optional	number	1234
tag sent in url	Project tag optional	number	1234
departament sent in url	Departament GUID optional	guid	9924256A-739C-462b-AF15-E652A3B1B6EB
participant sent in url	Participant GUID optional	guid	9924256A-739C-462b-AF15-E652A3B1B6EB
createdStart sent in url	Minimum value of message creation date optional	Date and Time	Roundtrip format: 2008-04-10T06-30-00.000Z
createdStop sent in url	Maximum value of message creation date optional	Date and Time	Roundtrip format: 2008-04-10T06-30-00.000Z
lastId sent in url	Last message ID	number	1234
myProjects sent in url	Specifies whether to return messages only from my projects or not	Bool value	true
follow sent in url	Specifies whether to return messages only from followed discussions or not	Bool value	true
status sent in url	Message status ("Open" or "Archived") optional	Open, Archived	Open

Example

GET api/2.0/project/message/filter?projectid=1234&tag=1234&departament=%229924256A-739C-462b-AF15-E652A3B1B6EB%22&participant=%229924256A-739C-462b-AF15-E652A3B1B6EB%22&createdStart=%222008-04-10T06-30-00.000Z%22&createdStop=%222008-04-10T06-30-00.000Z%22&lastId=1234&myProjects=true&follow=true&status=%22Open%22
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

Returns

List of messages

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "Id": 10,
      "Title": "Sample Title",
      "Description": "Sample description",
      "ProjectOwner": {
        "Id": "123",
        "Title": "Sample project",
        "Status": 0,
        "IsPrivate": false
      },
      "Text": "Hello, this is sample message",
      "Status": 0,
      "Responsible": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "DisplayName": "Mike Zanyatski",
        "Title": "Manager",
        "AvatarSmall": "url to small avatar",
        "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
      },
      "ResponsibleId": "00000000-0000-0000-0000-000000000000",
      "UpdatedBy": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "DisplayName": "Mike Zanyatski",
        "Title": "Manager",
        "AvatarSmall": "url to small avatar",
        "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
      },
      "UpdatedById": "00000000-0000-0000-0000-000000000000",
      "Created": "2020-12-22T04:11:56.5658524Z",
      "CreatedBy": {
        "Id": "00000000-0000-0000-0000-000000000000",
        "DisplayName": "Mike Zanyatski",
        "Title": "Manager",
        "AvatarSmall": "url to small avatar",
        "ProfileUrl": "\\/Products\\/People\\/Profile.aspx?user=administrator"
      },
      "CreatedById": "00000000-0000-0000-0000-000000000000",
      "Updated": "2020-12-22T04:11:56.5658524Z",
      "CanCreateComment": false,
      "CanEdit": true,
      "CommentsCount": 5
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <Id>10</Id>
    <Title>Sample Title</Title>
    <Description>Sample description</Description>
    <ProjectOwner>
      <Id>123</Id>
      <Title>Sample project</Title>
      <Status>0</Status>
      <IsPrivate>False</IsPrivate>
    </ProjectOwner>
    <Text>Hello, this is sample message</Text>
    <Status>0</Status>
    <Responsible>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </Responsible>
    <ResponsibleId>00000000-0000-0000-0000-000000000000</ResponsibleId>
    <UpdatedBy>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </UpdatedBy>
    <UpdatedById>00000000-0000-0000-0000-000000000000</UpdatedById>
    <Created>2020-12-22T04:11:56.5658524Z</Created>
    <CreatedBy>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <DisplayName>Mike Zanyatski</DisplayName>
      <Title>Manager</Title>
      <AvatarSmall>url to small avatar</AvatarSmall>
      <ProfileUrl>\/Products\/People\/Profile.aspx?user=administrator</ProfileUrl>
    </CreatedBy>
    <CreatedById>00000000-0000-0000-0000-000000000000</CreatedById>
    <Updated>2020-12-22T04:11:56.5658524Z</Updated>
    <CanCreateComment>False</CanCreateComment>
    <CanEdit>True</CanEdit>
    <CommentsCount>5</CommentsCount>
  </response>
</result>