Skip to content

Chat Service v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

chat-service microservice.

Base URLs:

Authentication

  • HTTP Authentication, scheme: bearer

AttachmentFileController

AttachmentFileController.createBulk

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "attachmentFiles": [
    null
  ]
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attach-files/bulk',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "attachmentFiles": [
    null
  ]
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attach-files/bulk',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /attach-files/bulk

Permissions
CreateAttachmentFile

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "attachmentFiles": [
    null
  ]
}

Parameters

Name In Type Required Description
body body New Attachment Files false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "attachmentFiles": [
    null
  ]
}

Responses

Status Meaning Description Schema
200 OK Attachment model instance AttachmentFileDto

AttachmentFileController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attach-files/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attach-files/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /attach-files/count

Permissions
ViewAttachmentFile

Parameters

Name In Type Required Description
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK AttachmentFile model count loopback.Count

AttachmentFileController.replaceById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "fileKey": "string",
  "messageId": "string",
  "metaData": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/attach-files/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "fileKey": "string",
  "messageId": "string",
  "metaData": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/attach-files/{id}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /attach-files/{id}

Permissions
UpdateAttachmentFile

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "fileKey": "string",
  "messageId": "string",
  "metaData": {}
}

Parameters

Name In Type Required Description
id path string true none
body body AttachmentFile false none

Example responses

204 Response

1
null

Responses

Status Meaning Description Schema
200 OK Return value of AttachmentFileController.replaceById None
204 No Content No Content Inline

Response Schema

Status Code 204

AttachmentFile PUT success

Name Type Required Restrictions Description

AttachmentFileController.updateById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "fileKey": "string",
  "messageId": "string",
  "metaData": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attach-files/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "fileKey": "string",
  "messageId": "string",
  "metaData": {}
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attach-files/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /attach-files/{id}

Permissions
UpdateAttachmentFile

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "fileKey": "string",
  "messageId": "string",
  "metaData": {}
}

Parameters

Name In Type Required Description
id path string true none
body body AttachmentFilePartial false none

Responses

Status Meaning Description Schema
204 No Content AttachmentFile PATCH success None

AttachmentFileController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attach-files/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attach-files/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /attach-files/{id}

Permissions
ViewAttachmentFile

Parameters

Name In Type Required Description
id path string true none
filter query message_files.Filter false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "fileKey": "string",
  "messageId": "string",
  "metaData": {},
  "message": {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "body": "string",
    "channelId": "string",
    "channelType": "string",
    "status": 0,
    "subject": "string",
    "toUserId": "string",
    "parentMessageId": "string",
    "messageRecipients": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "channelId": "string",
        "forwardedBy": "string",
        "isFavorite": true,
        "isForwarded": true,
        "isRead": true,
        "recipientId": "string",
        "messageId": "string",
        "message": {},
        "foreignKey": null
      }
    ],
    "attachmentFiles": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "channelId": "string",
        "fileKey": "string",
        "messageId": "string",
        "metaData": {},
        "message": {},
        "foreignKey": null
      }
    ],
    "parentMessage": {},
    "foreignKey": null,
    "messages": [
      {}
    ]
  },
  "foreignKey": null
}

Responses

Status Meaning Description Schema
200 OK AttachmentFile model instance AttachmentFileWithRelations

AttachmentFileController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Accept':'application/json'
};

fetch('/attach-files/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'
};

fetch('/attach-files/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /attach-files/{id}

Permissions
DeleteAttachmentFile

Parameters

Name In Type Required Description
id path string true none

Example responses

204 Response

1
null

Responses

Status Meaning Description Schema
200 OK Return value of AttachmentFileController.deleteById None
204 No Content No Content Inline

Response Schema

Status Code 204

Attachment File DELETE success

Name Type Required Restrictions Description

AttachmentFileController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "channelId": "string",
  "fileKey": "string",
  "messageId": "string",
  "metaData": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attach-files',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "channelId": "string",
  "fileKey": "string",
  "messageId": "string",
  "metaData": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attach-files',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /attach-files

Permissions
CreateAttachmentFile

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "channelId": "string",
  "fileKey": "string",
  "messageId": "string",
  "metaData": {}
}

Parameters

Name In Type Required Description
body body NewAttachmentFile false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "fileKey": "string",
  "messageId": "string",
  "metaData": {}
}

Responses

Status Meaning Description Schema
200 OK Attachment model instance AttachmentFile

AttachmentFileController.updateAll

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "fileKey": "string",
  "messageId": "string",
  "metaData": {}
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attach-files',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "fileKey": "string",
  "messageId": "string",
  "metaData": {}
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attach-files',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /attach-files

Permissions
UpdateAttachmentFile

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "fileKey": "string",
  "messageId": "string",
  "metaData": {}
}

Parameters

Name In Type Required Description
where query object false none
body body AttachmentFilePartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK AttachmentFile PATCH success count loopback.Count

AttachmentFileController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attach-files',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/attach-files',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /attach-files

Permissions
ViewAttachmentFile

Parameters

Name In Type Required Description
filter query message_files.Filter1 false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "channelId": "string",
    "fileKey": "string",
    "messageId": "string",
    "metaData": {},
    "message": {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "body": "string",
      "channelId": "string",
      "channelType": "string",
      "status": 0,
      "subject": "string",
      "toUserId": "string",
      "parentMessageId": "string",
      "messageRecipients": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "channelId": "string",
          "forwardedBy": "string",
          "isFavorite": true,
          "isForwarded": true,
          "isRead": true,
          "recipientId": "string",
          "messageId": "string",
          "message": {},
          "foreignKey": null
        }
      ],
      "attachmentFiles": [
        {}
      ],
      "parentMessage": {},
      "foreignKey": null,
      "messages": [
        {}
      ]
    },
    "foreignKey": null
  }
]

Responses

Status Meaning Description Schema
200 OK Array of AttachmentFile model instances Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [AttachmentFileWithRelations] false none [(tsType: AttachmentFileWithRelations, schemaOptions: { includeRelations: true })]
» AttachmentFileWithRelations AttachmentFileWithRelations false none (tsType: AttachmentFileWithRelations, schemaOptions: { includeRelations: true })
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» channelId string false none none
»» fileKey string false none none
»» messageId string false none none
»» metaData object false none none
»» message MessageWithRelations false none (tsType: MessageWithRelations, schemaOptions: { includeRelations: true })
»»» deleted boolean false none none
»»» deletedOn string(date-time)¦null false none none
»»» deletedBy string¦null false none none
»»» createdOn string(date-time) false none none
»»» modifiedOn string(date-time) false none none
»»» createdBy string false none none
»»» modifiedBy string false none none
»»» id string false none none
»»» body string true none none
»»» channelId string true none none
»»» channelType string true none none
»»» status number false none none
»»» subject string false none none
»»» toUserId string false none none
»»» parentMessageId string false none none
»»» messageRecipients [MessageRecipientWithRelations] false none (tsType: MessageRecipientWithRelations, schemaOptions: { includeRelations: true })
»»»» MessageRecipientWithRelations MessageRecipientWithRelations false none (tsType: MessageRecipientWithRelations, schemaOptions: { includeRelations: true })
»»»»» deleted boolean false none none
»»»»» deletedOn string(date-time)¦null false none none
»»»»» deletedBy string¦null false none none
»»»»» createdOn string(date-time) false none none
»»»»» modifiedOn string(date-time) false none none
»»»»» createdBy string false none none
»»»»» modifiedBy string false none none
»»»»» id string false none none
»»»»» channelId string true none none
»»»»» forwardedBy string false none none
»»»»» isFavorite boolean false none none
»»»»» isForwarded boolean false none none
»»»»» isRead boolean false none none
»»»»» recipientId string true none none
»»»»» messageId string true none none
»»»»» message MessageWithRelations false none (tsType: MessageWithRelations, schemaOptions: { includeRelations: true })
»»»»» foreignKey any false none none
»»» attachmentFiles [AttachmentFileWithRelations] false none (tsType: AttachmentFileWithRelations, schemaOptions: { includeRelations: true })
»»»» AttachmentFileWithRelations AttachmentFileWithRelations false none (tsType: AttachmentFileWithRelations, schemaOptions: { includeRelations: true })
»»» parentMessage MessageWithRelations false none (tsType: MessageWithRelations, schemaOptions: { includeRelations: true })
»»» foreignKey any false none none
»»» messages [MessageWithRelations] false none (tsType: MessageWithRelations, schemaOptions: { includeRelations: true })
»»»» MessageWithRelations MessageWithRelations false none (tsType: MessageWithRelations, schemaOptions: { includeRelations: true })
»» foreignKey any false none none

MessageRecipientController

MessageRecipientController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/message-recipients/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/message-recipients/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /message-recipients/count

Permissions
ViewMessageRecipient
6

Parameters

Name In Type Required Description
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK MessageRecipient model count loopback.Count

MessageRecipientController.replaceById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/message-recipients/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/message-recipients/{id}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /message-recipients/{id}

Permissions
UpdateMessageRecipient
7

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
}

Parameters

Name In Type Required Description
id path string true none
body body MessageRecipient false none

Responses

Status Meaning Description Schema
204 No Content MessageRecipient PUT success None

MessageRecipientController.updateById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/message-recipients/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/message-recipients/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /message-recipients/{id}

Permissions
UpdateMessageRecipient
7

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
}

Parameters

Name In Type Required Description
id path string true none
body body MessageRecipientPartial false none

Responses

Status Meaning Description Schema
204 No Content MessageRecipient PATCH success None

MessageRecipientController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/message-recipients/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/message-recipients/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /message-recipients/{id}

Permissions
ViewMessageRecipient
6

Parameters

Name In Type Required Description
id path string true none
filter query message_recipients.Filter false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string",
  "message": {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "body": "string",
    "channelId": "string",
    "channelType": "string",
    "status": 0,
    "subject": "string",
    "toUserId": "string",
    "parentMessageId": "string",
    "messageRecipients": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "channelId": "string",
        "forwardedBy": "string",
        "isFavorite": true,
        "isForwarded": true,
        "isRead": true,
        "recipientId": "string",
        "messageId": "string",
        "message": {},
        "foreignKey": null
      }
    ],
    "attachmentFiles": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "channelId": "string",
        "fileKey": "string",
        "messageId": "string",
        "metaData": {},
        "message": {},
        "foreignKey": null
      }
    ],
    "parentMessage": {},
    "foreignKey": null,
    "messages": [
      {}
    ]
  },
  "foreignKey": null
}

Responses

Status Meaning Description Schema
200 OK MessageRecipient model instance MessageRecipientWithRelations

MessageRecipientController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/message-recipients/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/message-recipients/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /message-recipients/{id}

Permissions
DeleteMessageRecipient
8

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
204 No Content MessageRecipient DELETE success None

MessageRecipientController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/message-recipients',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/message-recipients',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /message-recipients

Permissions
CreateMessageRecipient
5

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
}

Parameters

Name In Type Required Description
body body NewMessageRecipient false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
}

Responses

Status Meaning Description Schema
200 OK MessageRecipient model instance MessageRecipient

MessageRecipientController.updateAll

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/message-recipients',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/message-recipients',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /message-recipients

Permissions
UpdateMessageRecipient
7

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
}

Parameters

Name In Type Required Description
where query object false none
body body MessageRecipientPartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK MessageRecipient PATCH success count loopback.Count

MessageRecipientController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/message-recipients',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/message-recipients',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /message-recipients

Permissions
ViewMessageRecipient
6

Parameters

Name In Type Required Description
filter query message_recipients.Filter1 false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "channelId": "string",
    "forwardedBy": "string",
    "isFavorite": true,
    "isForwarded": true,
    "isRead": true,
    "recipientId": "string",
    "messageId": "string",
    "message": {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "body": "string",
      "channelId": "string",
      "channelType": "string",
      "status": 0,
      "subject": "string",
      "toUserId": "string",
      "parentMessageId": "string",
      "messageRecipients": [
        {}
      ],
      "attachmentFiles": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "channelId": "string",
          "fileKey": "string",
          "messageId": "string",
          "metaData": {},
          "message": {},
          "foreignKey": null
        }
      ],
      "parentMessage": {},
      "foreignKey": null,
      "messages": [
        {}
      ]
    },
    "foreignKey": null
  }
]

Responses

Status Meaning Description Schema
200 OK Array of MessageRecipient model instances Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [MessageRecipientWithRelations] false none [(tsType: MessageRecipientWithRelations, schemaOptions: { includeRelations: true })]
» MessageRecipientWithRelations MessageRecipientWithRelations false none (tsType: MessageRecipientWithRelations, schemaOptions: { includeRelations: true })
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» channelId string true none none
»» forwardedBy string false none none
»» isFavorite boolean false none none
»» isForwarded boolean false none none
»» isRead boolean false none none
»» recipientId string true none none
»» messageId string true none none
»» message MessageWithRelations false none (tsType: MessageWithRelations, schemaOptions: { includeRelations: true })
»»» deleted boolean false none none
»»» deletedOn string(date-time)¦null false none none
»»» deletedBy string¦null false none none
»»» createdOn string(date-time) false none none
»»» modifiedOn string(date-time) false none none
»»» createdBy string false none none
»»» modifiedBy string false none none
»»» id string false none none
»»» body string true none none
»»» channelId string true none none
»»» channelType string true none none
»»» status number false none none
»»» subject string false none none
»»» toUserId string false none none
»»» parentMessageId string false none none
»»» messageRecipients [MessageRecipientWithRelations] false none (tsType: MessageRecipientWithRelations, schemaOptions: { includeRelations: true })
»»»» MessageRecipientWithRelations MessageRecipientWithRelations false none (tsType: MessageRecipientWithRelations, schemaOptions: { includeRelations: true })
»»» attachmentFiles [AttachmentFileWithRelations] false none (tsType: AttachmentFileWithRelations, schemaOptions: { includeRelations: true })
»»»» AttachmentFileWithRelations AttachmentFileWithRelations false none (tsType: AttachmentFileWithRelations, schemaOptions: { includeRelations: true })
»»»»» deleted boolean false none none
»»»»» deletedOn string(date-time)¦null false none none
»»»»» deletedBy string¦null false none none
»»»»» createdOn string(date-time) false none none
»»»»» modifiedOn string(date-time) false none none
»»»»» createdBy string false none none
»»»»» modifiedBy string false none none
»»»»» id string false none none
»»»»» channelId string false none none
»»»»» fileKey string false none none
»»»»» messageId string false none none
»»»»» metaData object false none none
»»»»» message MessageWithRelations false none (tsType: MessageWithRelations, schemaOptions: { includeRelations: true })
»»»»» foreignKey any false none none
»»» parentMessage MessageWithRelations false none (tsType: MessageWithRelations, schemaOptions: { includeRelations: true })
»»» foreignKey any false none none
»»» messages [MessageWithRelations] false none (tsType: MessageWithRelations, schemaOptions: { includeRelations: true })
»»»» MessageWithRelations MessageWithRelations false none (tsType: MessageWithRelations, schemaOptions: { includeRelations: true })
»» foreignKey any false none none

MessageRecipientMessageController

MessageRecipientMessageController.getMessage

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/message-recipients/{id}/message',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/message-recipients/{id}/message',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /message-recipients/{id}/message

Permissions
ViewMessage
1

Parameters

Name In Type Required Description
id path string true none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "body": "string",
    "channelId": "string",
    "channelType": "string",
    "status": 0,
    "subject": "string",
    "toUserId": "string",
    "parentMessageId": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Message belonging to MessageRecipient Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Message] false none none
» Message Message false none none
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» body string true none none
»» channelId string true none none
»» channelType string true none none
»» status number false none none
»» subject string false none none
»» toUserId string false none none
»» parentMessageId string false none none

MessageController

MessageController.count

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/count',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /messages/count

Permissions
ViewMessage
1

Parameters

Name In Type Required Description
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Message model count loopback.Count

MessageController.replaceById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}',
{
  method: 'PUT',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /messages/{id}

Permissions
UpdateMessage
3

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
}

Parameters

Name In Type Required Description
id path string true none
body body Message false none

Responses

Status Meaning Description Schema
204 No Content Message PUT success None

MessageController.updateById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /messages/{id}

Permissions
UpdateMessage
3

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
}

Parameters

Name In Type Required Description
id path string true none
body body MessagePartial false none

Responses

Status Meaning Description Schema
204 No Content Message PATCH success None

MessageController.findById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /messages/{id}

Permissions
ViewMessage
1

Parameters

Name In Type Required Description
id path string true none
filter query messages.Filter false none

Example responses

200 Response

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string",
  "messageRecipients": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "channelId": "string",
      "forwardedBy": "string",
      "isFavorite": true,
      "isForwarded": true,
      "isRead": true,
      "recipientId": "string",
      "messageId": "string",
      "message": {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "body": "string",
        "channelId": "string",
        "channelType": "string",
        "status": 0,
        "subject": "string",
        "toUserId": "string",
        "parentMessageId": "string",
        "messageRecipients": [],
        "attachmentFiles": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "channelId": "string",
            "fileKey": "string",
            "messageId": "string",
            "metaData": {},
            "message": {},
            "foreignKey": null
          }
        ],
        "parentMessage": {},
        "foreignKey": null,
        "messages": [
          {}
        ]
      },
      "foreignKey": null
    }
  ],
  "attachmentFiles": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "channelId": "string",
      "fileKey": "string",
      "messageId": "string",
      "metaData": {},
      "message": {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "body": "string",
        "channelId": "string",
        "channelType": "string",
        "status": 0,
        "subject": "string",
        "toUserId": "string",
        "parentMessageId": "string",
        "messageRecipients": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "channelId": "string",
            "forwardedBy": "string",
            "isFavorite": true,
            "isForwarded": true,
            "isRead": true,
            "recipientId": "string",
            "messageId": "string",
            "message": {},
            "foreignKey": null
          }
        ],
        "attachmentFiles": [],
        "parentMessage": {},
        "foreignKey": null,
        "messages": [
          {}
        ]
      },
      "foreignKey": null
    }
  ],
  "parentMessage": {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "body": "string",
    "channelId": "string",
    "channelType": "string",
    "status": 0,
    "subject": "string",
    "toUserId": "string",
    "parentMessageId": "string",
    "messageRecipients": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "channelId": "string",
        "forwardedBy": "string",
        "isFavorite": true,
        "isForwarded": true,
        "isRead": true,
        "recipientId": "string",
        "messageId": "string",
        "message": {},
        "foreignKey": null
      }
    ],
    "attachmentFiles": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "channelId": "string",
        "fileKey": "string",
        "messageId": "string",
        "metaData": {},
        "message": {},
        "foreignKey": null
      }
    ],
    "parentMessage": {},
    "foreignKey": null,
    "messages": [
      {}
    ]
  },
  "foreignKey": null,
  "messages": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "body": "string",
      "channelId": "string",
      "channelType": "string",
      "status": 0,
      "subject": "string",
      "toUserId": "string",
      "parentMessageId": "string",
      "messageRecipients": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "channelId": "string",
          "forwardedBy": "string",
          "isFavorite": true,
          "isForwarded": true,
          "isRead": true,
          "recipientId": "string",
          "messageId": "string",
          "message": {},
          "foreignKey": null
        }
      ],
      "attachmentFiles": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "channelId": "string",
          "fileKey": "string",
          "messageId": "string",
          "metaData": {},
          "message": {},
          "foreignKey": null
        }
      ],
      "parentMessage": {},
      "foreignKey": null,
      "messages": []
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK Message model instance MessageWithRelations

MessageController.deleteById

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
const fetch = require('node-fetch');

const headers = {
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /messages/{id}

Permissions
DeleteMessage
4

Parameters

Name In Type Required Description
id path string true none

Responses

Status Meaning Description Schema
204 No Content Message DELETE success None

MessageController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /messages

Permissions
CreateMessage
2

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
}

Parameters

Name In Type Required Description
body body NewMessage false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
}

Responses

Status Meaning Description Schema
200 OK Message model instance Message

MessageController.updateAll

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /messages

Permissions
UpdateMessage
3

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
}

Parameters

Name In Type Required Description
where query object false none
body body MessagePartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Message PATCH success count loopback.Count

MessageController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /messages

Permissions
ViewMessage
1

Parameters

Name In Type Required Description
filter query messages.Filter1 false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "body": "string",
    "channelId": "string",
    "channelType": "string",
    "status": 0,
    "subject": "string",
    "toUserId": "string",
    "parentMessageId": "string",
    "messageRecipients": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "channelId": "string",
        "forwardedBy": "string",
        "isFavorite": true,
        "isForwarded": true,
        "isRead": true,
        "recipientId": "string",
        "messageId": "string",
        "message": {},
        "foreignKey": null
      }
    ],
    "attachmentFiles": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "channelId": "string",
        "fileKey": "string",
        "messageId": "string",
        "metaData": {},
        "message": {},
        "foreignKey": null
      }
    ],
    "parentMessage": {},
    "foreignKey": null,
    "messages": [
      {}
    ]
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Message model instances Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [MessageWithRelations] false none [(tsType: MessageWithRelations, schemaOptions: { includeRelations: true })]
» MessageWithRelations MessageWithRelations false none (tsType: MessageWithRelations, schemaOptions: { includeRelations: true })
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» body string true none none
»» channelId string true none none
»» channelType string true none none
»» status number false none none
»» subject string false none none
»» toUserId string false none none
»» parentMessageId string false none none
»» messageRecipients [MessageRecipientWithRelations] false none (tsType: MessageRecipientWithRelations, schemaOptions: { includeRelations: true })
»»» MessageRecipientWithRelations MessageRecipientWithRelations false none (tsType: MessageRecipientWithRelations, schemaOptions: { includeRelations: true })
»»»» deleted boolean false none none
»»»» deletedOn string(date-time)¦null false none none
»»»» deletedBy string¦null false none none
»»»» createdOn string(date-time) false none none
»»»» modifiedOn string(date-time) false none none
»»»» createdBy string false none none
»»»» modifiedBy string false none none
»»»» id string false none none
»»»» channelId string true none none
»»»» forwardedBy string false none none
»»»» isFavorite boolean false none none
»»»» isForwarded boolean false none none
»»»» isRead boolean false none none
»»»» recipientId string true none none
»»»» messageId string true none none
»»»» message MessageWithRelations false none (tsType: MessageWithRelations, schemaOptions: { includeRelations: true })
»»»» foreignKey any false none none
»» attachmentFiles [AttachmentFileWithRelations] false none (tsType: AttachmentFileWithRelations, schemaOptions: { includeRelations: true })
»»» AttachmentFileWithRelations AttachmentFileWithRelations false none (tsType: AttachmentFileWithRelations, schemaOptions: { includeRelations: true })
»»»» deleted boolean false none none
»»»» deletedOn string(date-time)¦null false none none
»»»» deletedBy string¦null false none none
»»»» createdOn string(date-time) false none none
»»»» modifiedOn string(date-time) false none none
»»»» createdBy string false none none
»»»» modifiedBy string false none none
»»»» id string false none none
»»»» channelId string false none none
»»»» fileKey string false none none
»»»» messageId string false none none
»»»» metaData object false none none
»»»» message MessageWithRelations false none (tsType: MessageWithRelations, schemaOptions: { includeRelations: true })
»»»» foreignKey any false none none
»» parentMessage MessageWithRelations false none (tsType: MessageWithRelations, schemaOptions: { includeRelations: true })
»» foreignKey any false none none
»» messages [MessageWithRelations] false none (tsType: MessageWithRelations, schemaOptions: { includeRelations: true })
»»» MessageWithRelations MessageWithRelations false none (tsType: MessageWithRelations, schemaOptions: { includeRelations: true })

MessageMessageRecipientController

MessageMessageRecipientController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}/message-recipients',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}/message-recipients',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /messages/{id}/message-recipients

Permissions
CreateMessageRecipient
5

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
}

Parameters

Name In Type Required Description
id path string true none
body body NewMessageRecipientInMessage false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
}

Responses

Status Meaning Description Schema
200 OK Message model instance MessageRecipient

MessageMessageRecipientController.patch

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}/message-recipients',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}/message-recipients',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /messages/{id}/message-recipients

Permissions
UpdateMessageRecipient
7

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
}

Parameters

Name In Type Required Description
id path string true none
where query object false none
body body MessageRecipientPartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Message.MessageRecipient PATCH success count loopback.Count

MessageMessageRecipientController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}/message-recipients',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}/message-recipients',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /messages/{id}/message-recipients

Permissions
ViewMessageRecipient
6

Parameters

Name In Type Required Description
id path string true none
filter query object false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "channelId": "string",
    "forwardedBy": "string",
    "isFavorite": true,
    "isForwarded": true,
    "isRead": true,
    "recipientId": "string",
    "messageId": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Message has many MessageRecipient Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [MessageRecipient] false none none
» MessageRecipient MessageRecipient false none none
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» channelId string true none none
»» forwardedBy string false none none
»» isFavorite boolean false none none
»» isForwarded boolean false none none
»» isRead boolean false none none
»» recipientId string true none none
»» messageId string true none none

MessageMessageRecipientController.delete

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}/message-recipients',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}/message-recipients',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /messages/{id}/message-recipients

Permissions
DeleteMessageRecipient
8

Parameters

Name In Type Required Description
id path string true none
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Message.MessageRecipient DELETE success count loopback.Count

MessageMessageController

MessageMessageController.create

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}/messages',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}/messages',
{
  method: 'POST',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /messages/{id}/messages

Permissions
CreateMessage
2

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
}

Parameters

Name In Type Required Description
id path string true none
body body NewMessageInMessage false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
}

Responses

Status Meaning Description Schema
200 OK Message model instance Message

MessageMessageController.patch

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
const inputBody = '{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}/messages',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
const fetch = require('node-fetch');
const inputBody = {
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
};
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}/messages',
{
  method: 'PATCH',
  body: JSON.stringify(inputBody),
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PATCH /messages/{id}/messages

Permissions
UpdateMessage
3

Body parameter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
}

Parameters

Name In Type Required Description
id path string true none
where query object false none
body body MessagePartial false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Message.Message PATCH success count loopback.Count

MessageMessageController.find

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}/messages',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}/messages',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /messages/{id}/messages

Permissions
ViewMessage
1

Parameters

Name In Type Required Description
id path string true none
filter query object false none

Example responses

200 Response

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
[
  {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "body": "string",
    "channelId": "string",
    "channelType": "string",
    "status": 0,
    "subject": "string",
    "toUserId": "string",
    "parentMessageId": "string"
  }
]

Responses

Status Meaning Description Schema
200 OK Array of Message has many Message Inline

Response Schema

Status Code 200

Name Type Required Restrictions Description
anonymous [Message] false none none
» Message Message false none none
»» deleted boolean false none none
»» deletedOn string(date-time)¦null false none none
»» deletedBy string¦null false none none
»» createdOn string(date-time) false none none
»» modifiedOn string(date-time) false none none
»» createdBy string false none none
»» modifiedBy string false none none
»» id string false none none
»» body string true none none
»» channelId string true none none
»» channelType string true none none
»» status number false none none
»» subject string false none none
»» toUserId string false none none
»» parentMessageId string false none none

MessageMessageController.delete

Code samples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}/messages',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/messages/{id}/messages',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /messages/{id}/messages

Permissions
DeleteMessage
4

Parameters

Name In Type Required Description
id path string true none
where query object false none

Example responses

200 Response

1
2
3
{
  "count": 0
}

Responses

Status Meaning Description Schema
200 OK Message.Message DELETE success count loopback.Count

Schemas

Message

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
}

Message

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
body string true none none
channelId string true none none
channelType string true none none
status number false none none
subject string false none none
toUserId string false none none
parentMessageId string false none none

NewMessage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
}

NewMessage

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
body string true none none
channelId string true none none
channelType string true none none
status number false none none
subject string false none none
toUserId string false none none
parentMessageId string false none none

MessageWithRelations

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string",
  "messageRecipients": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "channelId": "string",
      "forwardedBy": "string",
      "isFavorite": true,
      "isForwarded": true,
      "isRead": true,
      "recipientId": "string",
      "messageId": "string",
      "message": {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "body": "string",
        "channelId": "string",
        "channelType": "string",
        "status": 0,
        "subject": "string",
        "toUserId": "string",
        "parentMessageId": "string",
        "messageRecipients": [],
        "attachmentFiles": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "channelId": "string",
            "fileKey": "string",
            "messageId": "string",
            "metaData": {},
            "message": {},
            "foreignKey": null
          }
        ],
        "parentMessage": {},
        "foreignKey": null,
        "messages": [
          {}
        ]
      },
      "foreignKey": null
    }
  ],
  "attachmentFiles": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "channelId": "string",
      "fileKey": "string",
      "messageId": "string",
      "metaData": {},
      "message": {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "body": "string",
        "channelId": "string",
        "channelType": "string",
        "status": 0,
        "subject": "string",
        "toUserId": "string",
        "parentMessageId": "string",
        "messageRecipients": [
          {
            "deleted": true,
            "deletedOn": "2019-08-24T14:15:22Z",
            "deletedBy": "string",
            "createdOn": "2019-08-24T14:15:22Z",
            "modifiedOn": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "modifiedBy": "string",
            "id": "string",
            "channelId": "string",
            "forwardedBy": "string",
            "isFavorite": true,
            "isForwarded": true,
            "isRead": true,
            "recipientId": "string",
            "messageId": "string",
            "message": {},
            "foreignKey": null
          }
        ],
        "attachmentFiles": [],
        "parentMessage": {},
        "foreignKey": null,
        "messages": [
          {}
        ]
      },
      "foreignKey": null
    }
  ],
  "parentMessage": {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "body": "string",
    "channelId": "string",
    "channelType": "string",
    "status": 0,
    "subject": "string",
    "toUserId": "string",
    "parentMessageId": "string",
    "messageRecipients": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "channelId": "string",
        "forwardedBy": "string",
        "isFavorite": true,
        "isForwarded": true,
        "isRead": true,
        "recipientId": "string",
        "messageId": "string",
        "message": {},
        "foreignKey": null
      }
    ],
    "attachmentFiles": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "channelId": "string",
        "fileKey": "string",
        "messageId": "string",
        "metaData": {},
        "message": {},
        "foreignKey": null
      }
    ],
    "parentMessage": {},
    "foreignKey": null,
    "messages": [
      {}
    ]
  },
  "foreignKey": null,
  "messages": [
    {
      "deleted": true,
      "deletedOn": "2019-08-24T14:15:22Z",
      "deletedBy": "string",
      "createdOn": "2019-08-24T14:15:22Z",
      "modifiedOn": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "modifiedBy": "string",
      "id": "string",
      "body": "string",
      "channelId": "string",
      "channelType": "string",
      "status": 0,
      "subject": "string",
      "toUserId": "string",
      "parentMessageId": "string",
      "messageRecipients": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "channelId": "string",
          "forwardedBy": "string",
          "isFavorite": true,
          "isForwarded": true,
          "isRead": true,
          "recipientId": "string",
          "messageId": "string",
          "message": {},
          "foreignKey": null
        }
      ],
      "attachmentFiles": [
        {
          "deleted": true,
          "deletedOn": "2019-08-24T14:15:22Z",
          "deletedBy": "string",
          "createdOn": "2019-08-24T14:15:22Z",
          "modifiedOn": "2019-08-24T14:15:22Z",
          "createdBy": "string",
          "modifiedBy": "string",
          "id": "string",
          "channelId": "string",
          "fileKey": "string",
          "messageId": "string",
          "metaData": {},
          "message": {},
          "foreignKey": null
        }
      ],
      "parentMessage": {},
      "foreignKey": null,
      "messages": []
    }
  ]
}

MessageWithRelations

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
body string true none none
channelId string true none none
channelType string true none none
status number false none none
subject string false none none
toUserId string false none none
parentMessageId string false none none
messageRecipients [MessageRecipientWithRelations] false none [(tsType: MessageRecipientWithRelations, schemaOptions: { includeRelations: true })]
attachmentFiles [AttachmentFileWithRelations] false none [(tsType: AttachmentFileWithRelations, schemaOptions: { includeRelations: true })]
parentMessage MessageWithRelations false none (tsType: MessageWithRelations, schemaOptions: { includeRelations: true })
foreignKey any false none none
messages [MessageWithRelations] false none [(tsType: MessageWithRelations, schemaOptions: { includeRelations: true })]

MessagePartial

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
}

MessagePartial

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
body string false none none
channelId string false none none
channelType string false none none
status number false none none
subject string false none none
toUserId string false none none
parentMessageId string false none none

MessageRecipient

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
}

MessageRecipient

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
channelId string true none none
forwardedBy string false none none
isFavorite boolean false none none
isForwarded boolean false none none
isRead boolean false none none
recipientId string true none none
messageId string true none none

NewMessageRecipient

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
}

NewMessageRecipient

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
channelId string true none none
forwardedBy string false none none
isFavorite boolean false none none
isForwarded boolean false none none
isRead boolean false none none
recipientId string true none none
messageId string true none none

MessageRecipientWithRelations

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string",
  "message": {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "body": "string",
    "channelId": "string",
    "channelType": "string",
    "status": 0,
    "subject": "string",
    "toUserId": "string",
    "parentMessageId": "string",
    "messageRecipients": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "channelId": "string",
        "forwardedBy": "string",
        "isFavorite": true,
        "isForwarded": true,
        "isRead": true,
        "recipientId": "string",
        "messageId": "string",
        "message": {},
        "foreignKey": null
      }
    ],
    "attachmentFiles": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "channelId": "string",
        "fileKey": "string",
        "messageId": "string",
        "metaData": {},
        "message": {},
        "foreignKey": null
      }
    ],
    "parentMessage": {},
    "foreignKey": null,
    "messages": [
      {}
    ]
  },
  "foreignKey": null
}

MessageRecipientWithRelations

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
channelId string true none none
forwardedBy string false none none
isFavorite boolean false none none
isForwarded boolean false none none
isRead boolean false none none
recipientId string true none none
messageId string true none none
message MessageWithRelations false none (tsType: MessageWithRelations, schemaOptions: { includeRelations: true })
foreignKey any false none none

MessageRecipientPartial

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
}

MessageRecipientPartial

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
channelId string false none none
forwardedBy string false none none
isFavorite boolean false none none
isForwarded boolean false none none
isRead boolean false none none
recipientId string false none none
messageId string false none none

NewMessageInMessage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "body": "string",
  "channelId": "string",
  "channelType": "string",
  "status": 0,
  "subject": "string",
  "toUserId": "string",
  "parentMessageId": "string"
}

NewMessageInMessage

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
body string true none none
channelId string true none none
channelType string true none none
status number false none none
subject string false none none
toUserId string false none none
parentMessageId string false none none

NewMessageRecipientInMessage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "channelId": "string",
  "forwardedBy": "string",
  "isFavorite": true,
  "isForwarded": true,
  "isRead": true,
  "recipientId": "string",
  "messageId": "string"
}

NewMessageRecipientInMessage

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
channelId string true none none
forwardedBy string false none none
isFavorite boolean false none none
isForwarded boolean false none none
isRead boolean false none none
recipientId string true none none
messageId string false none none

AttachmentFile

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "fileKey": "string",
  "messageId": "string",
  "metaData": {}
}

AttachmentFile

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
channelId string false none none
fileKey string false none none
messageId string false none none
metaData object false none none

NewAttachmentFile

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "channelId": "string",
  "fileKey": "string",
  "messageId": "string",
  "metaData": {}
}

NewAttachmentFile

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
channelId string false none none
fileKey string false none none
messageId string false none none
metaData object false none none

AttachmentFileDto

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "attachmentFiles": [
    null
  ]
}

AttachmentFileDto

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
attachmentFiles [any] true none none

New Attachment Files

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "attachmentFiles": [
    null
  ]
}

New Attachment Files

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
attachmentFiles [any] true none none

AttachmentFileWithRelations

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "fileKey": "string",
  "messageId": "string",
  "metaData": {},
  "message": {
    "deleted": true,
    "deletedOn": "2019-08-24T14:15:22Z",
    "deletedBy": "string",
    "createdOn": "2019-08-24T14:15:22Z",
    "modifiedOn": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "modifiedBy": "string",
    "id": "string",
    "body": "string",
    "channelId": "string",
    "channelType": "string",
    "status": 0,
    "subject": "string",
    "toUserId": "string",
    "parentMessageId": "string",
    "messageRecipients": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "channelId": "string",
        "forwardedBy": "string",
        "isFavorite": true,
        "isForwarded": true,
        "isRead": true,
        "recipientId": "string",
        "messageId": "string",
        "message": {},
        "foreignKey": null
      }
    ],
    "attachmentFiles": [
      {
        "deleted": true,
        "deletedOn": "2019-08-24T14:15:22Z",
        "deletedBy": "string",
        "createdOn": "2019-08-24T14:15:22Z",
        "modifiedOn": "2019-08-24T14:15:22Z",
        "createdBy": "string",
        "modifiedBy": "string",
        "id": "string",
        "channelId": "string",
        "fileKey": "string",
        "messageId": "string",
        "metaData": {},
        "message": {},
        "foreignKey": null
      }
    ],
    "parentMessage": {},
    "foreignKey": null,
    "messages": [
      {}
    ]
  },
  "foreignKey": null
}

AttachmentFileWithRelations

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
channelId string false none none
fileKey string false none none
messageId string false none none
metaData object false none none
message MessageWithRelations false none (tsType: MessageWithRelations, schemaOptions: { includeRelations: true })
foreignKey any false none none

AttachmentFilePartial

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "deleted": true,
  "deletedOn": "2019-08-24T14:15:22Z",
  "deletedBy": "string",
  "createdOn": "2019-08-24T14:15:22Z",
  "modifiedOn": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "modifiedBy": "string",
  "id": "string",
  "channelId": "string",
  "fileKey": "string",
  "messageId": "string",
  "metaData": {}
}

AttachmentFilePartial

Properties

Name Type Required Restrictions Description
deleted boolean false none none
deletedOn string(date-time)¦null false none none
deletedBy string¦null false none none
createdOn string(date-time) false none none
modifiedOn string(date-time) false none none
createdBy string false none none
modifiedBy string false none none
id string false none none
channelId string false none none
fileKey string false none none
messageId string false none none
metaData object false none none

loopback.Count

1
2
3
{
  "count": 0
}

loopback.Count

Properties

Name Type Required Restrictions Description
count number false none none

message_files.ScopeFilter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {},
  "include": [
    {}
  ]
}

message_files.ScopeFilter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [object] false none none

message_files.IncludeFilter.Items

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "relation": "message",
  "scope": {
    "offset": 0,
    "limit": 100,
    "skip": 0,
    "order": "string",
    "where": {},
    "fields": {},
    "include": [
      {}
    ]
  }
}

message_files.IncludeFilter.Items

Properties

Name Type Required Restrictions Description
relation string false none none
scope message_files.ScopeFilter false none none

Enumerated Values

Property Value
relation message

message_files.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "channelId": true,
    "fileKey": true,
    "messageId": true,
    "metaData": true
  },
  "include": [
    {
      "relation": "message",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

message_files.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» channelId boolean false none none
»» fileKey boolean false none none
»» messageId boolean false none none
»» metaData boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [anyOf] false none none

anyOf

Name Type Required Restrictions Description
» anonymous message_files.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none

message_files.Filter1

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "channelId": true,
    "fileKey": true,
    "messageId": true,
    "metaData": true
  },
  "include": [
    {
      "relation": "message",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

message_files.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» channelId boolean false none none
»» fileKey boolean false none none
»» messageId boolean false none none
»» metaData boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [anyOf] false none none

anyOf

Name Type Required Restrictions Description
» anonymous message_files.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none

message_recipients.ScopeFilter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {},
  "include": [
    {}
  ]
}

message_recipients.ScopeFilter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [object] false none none

message_recipients.IncludeFilter.Items

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "relation": "message",
  "scope": {
    "offset": 0,
    "limit": 100,
    "skip": 0,
    "order": "string",
    "where": {},
    "fields": {},
    "include": [
      {}
    ]
  }
}

message_recipients.IncludeFilter.Items

Properties

Name Type Required Restrictions Description
relation string false none none
scope message_recipients.ScopeFilter false none none

Enumerated Values

Property Value
relation message

message_recipients.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "channelId": true,
    "forwardedBy": true,
    "isFavorite": true,
    "isForwarded": true,
    "isRead": true,
    "recipientId": true,
    "messageId": true
  },
  "include": [
    {
      "relation": "message",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

message_recipients.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» channelId boolean false none none
»» forwardedBy boolean false none none
»» isFavorite boolean false none none
»» isForwarded boolean false none none
»» isRead boolean false none none
»» recipientId boolean false none none
»» messageId boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [anyOf] false none none

anyOf

Name Type Required Restrictions Description
» anonymous message_recipients.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none

message_recipients.Filter1

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "channelId": true,
    "forwardedBy": true,
    "isFavorite": true,
    "isForwarded": true,
    "isRead": true,
    "recipientId": true,
    "messageId": true
  },
  "include": [
    {
      "relation": "message",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

message_recipients.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» channelId boolean false none none
»» forwardedBy boolean false none none
»» isFavorite boolean false none none
»» isForwarded boolean false none none
»» isRead boolean false none none
»» recipientId boolean false none none
»» messageId boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [anyOf] false none none

anyOf

Name Type Required Restrictions Description
» anonymous message_recipients.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none

messages.ScopeFilter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {},
  "include": [
    {}
  ]
}

messages.ScopeFilter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [object] false none none

messages.IncludeFilter.Items

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
{
  "relation": "messageRecipients",
  "scope": {
    "offset": 0,
    "limit": 100,
    "skip": 0,
    "order": "string",
    "where": {},
    "fields": {},
    "include": [
      {}
    ]
  }
}

messages.IncludeFilter.Items

Properties

Name Type Required Restrictions Description
relation string false none none
scope messages.ScopeFilter false none none

Enumerated Values

Property Value
relation messageRecipients
relation attachmentFiles
relation parentMessage
relation messages

messages.Filter

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "body": true,
    "channelId": true,
    "channelType": true,
    "status": true,
    "subject": true,
    "toUserId": true,
    "parentMessageId": true
  },
  "include": [
    {
      "relation": "messageRecipients",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

messages.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» body boolean false none none
»» channelId boolean false none none
»» channelType boolean false none none
»» status boolean false none none
»» subject boolean false none none
»» toUserId boolean false none none
»» parentMessageId boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [anyOf] false none none

anyOf

Name Type Required Restrictions Description
» anonymous messages.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none

messages.Filter1

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{
  "offset": 0,
  "limit": 100,
  "skip": 0,
  "order": "string",
  "where": {},
  "fields": {
    "deleted": true,
    "deletedOn": true,
    "deletedBy": true,
    "createdOn": true,
    "modifiedOn": true,
    "createdBy": true,
    "modifiedBy": true,
    "id": true,
    "body": true,
    "channelId": true,
    "channelType": true,
    "status": true,
    "subject": true,
    "toUserId": true,
    "parentMessageId": true
  },
  "include": [
    {
      "relation": "messageRecipients",
      "scope": {
        "offset": 0,
        "limit": 100,
        "skip": 0,
        "order": "string",
        "where": {},
        "fields": {},
        "include": [
          {}
        ]
      }
    }
  ]
}

messages.Filter

Properties

Name Type Required Restrictions Description
offset integer false none none
limit integer false none none
skip integer false none none
order any false none none

oneOf

Name Type Required Restrictions Description
» anonymous string false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
where object false none none
fields any false none none

oneOf

Name Type Required Restrictions Description
» anonymous object false none none
»» deleted boolean false none none
»» deletedOn boolean false none none
»» deletedBy boolean false none none
»» createdOn boolean false none none
»» modifiedOn boolean false none none
»» createdBy boolean false none none
»» modifiedBy boolean false none none
»» id boolean false none none
»» body boolean false none none
»» channelId boolean false none none
»» channelType boolean false none none
»» status boolean false none none
»» subject boolean false none none
»» toUserId boolean false none none
»» parentMessageId boolean false none none

xor

Name Type Required Restrictions Description
» anonymous [string] false none none

continued

Name Type Required Restrictions Description
include [anyOf] false none none

anyOf

Name Type Required Restrictions Description
» anonymous messages.IncludeFilter.Items false none none

or

Name Type Required Restrictions Description
» anonymous string false none none