Get Started
Portal api methods
Help

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

Description

Returns the list with the detailed information about all the message 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
Messages in my projects Bool value true
follow
sent in url
Followed messages Bool value true
status
sent in url
optional
ASC.Projects.Core.Domain.MessageStatus
Example
GET api/2.0/project/message/filter?projectid=1234&tag=1234&departament=9924256A-739C-462b-AF15-E652A3B1B6EB&participant=9924256A-739C-462b-AF15-E652A3B1B6EB&createdStart=2008-04-10T06-30-00.000Z&createdStop=2008-04-10T06-30-00.000Z&lastId=1234&myProjects=True&follow=True
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

List of messages

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "canCreateComment": false,
      "canEdit": true,
      "id": 10,
      "title": "Sample Title",
      "description": null,
      "projectOwner": {
        "id": 123,
        "title": "Sample project",
        "status": 0,
        "isPrivate": false
      },
      "commentsCount": 5,
      "text": "Hello, this is sample message",
      "status": 0,
      "updatedBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "created": "2019-10-16T14:55:14.6735659Z",
      "createdBy": {
        "id": "00000000-0000-0000-0000-000000000000",
        "displayName": "Mike Zanyatski",
        "title": "Manager",
        "avatarSmall": "url to small avatar",
        "profileUrl": ""
      },
      "updated": "2019-10-16T14:55:14.6735659Z"
    }
  ]
}

text/xml

<result>
  <status>0</status>
  <response>
    <canCreateComment>false</canCreateComment>
    <canEdit>true</canEdit>
    <id>10</id>
    <title>Sample Title</title>
    <description />
    <projectOwner>
      <id>123</id>
      <title>Sample project</title>
      <status>0</status>
      <isPrivate>false</isPrivate>
    </projectOwner>
    <commentsCount>5</commentsCount>
    <text>Hello, this is sample message</text>
    <status>0</status>
    <updatedBy>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </updatedBy>
    <created>2019-10-16T14:55:14.6735659Z</created>
    <createdBy>
      <id>00000000-0000-0000-0000-000000000000</id>
      <displayName>Mike Zanyatski</displayName>
      <title>Manager</title>
      <avatarSmall>url to small avatar</avatarSmall>
      <profileUrl></profileUrl>
    </createdBy>
    <updated>2019-10-16T14:55:14.6735659Z</updated>
  </response>
</result>