Message
Creates a message
POST https://demo.icure.cloud/rest/v2/message
Request Body
| Name | Type | Description |
|---|---|---|
body* | Message |
Deletes a message delegation
DELETE https://demo.icure.cloud/rest/v2/message/{messageId}/delegate/{delegateId}
Path Parameters
| Name | Type | Description |
|---|---|---|
messageId* | String | |
delegateId* | String |
Deletes multiple messages
POST https://demo.icure.cloud/rest/v2/message/delete/batch
Request Body
| Name | Type | Description |
|---|---|---|
body* | ListOfIds |
Get all messages (paginated) for current HC Party
GET https://demo.icure.cloud/rest/v2/message
Query Parameters
| Name | Type | Description |
|---|---|---|
startKey | String | |
startDocumentId | String | |
limit | Integer |
Get all messages (paginated) for current HC Party and provided from address
GET https://demo.icure.cloud/rest/v2/message/byFromAddress
Query Parameters
| Name | Type | Description |
|---|---|---|
fromAddress | String | |
startKey | String | |
startDocumentId | String | |
limit | Integer | |
hcpId | String |
List messages found By Healthcare Party and secret foreign keys.
GET https://demo.icure.cloud/rest/v2/message/byHcPartySecretForeignKeys
Keys must be delimited by coma
Query Parameters
| Name | Type | Description |
|---|---|---|
secretFKeys* | String |
Get all messages (paginated) for current HC Party and provided to address
GET https://demo.icure.cloud/rest/v2/message/byToAddress
Query Parameters
| Name | Type | Description |
|---|---|---|
toAddress | String | |
startKey | String | |
startDocumentId | String | |
limit | Integer | |
reverse | Boolean | |
hcpId | String |
Get all messages (paginated) for current HC Party and provided transportGuid
GET https://demo.icure.cloud/rest/v2/message/byTransportGuid
Query Parameters
| Name | Type | Description |
|---|---|---|
transportGuid | String | |
received | Boolean | |
startKey | String | |
startDocumentId | String | |
limit | Integer | |
hcpId | String |
Get all messages starting by a prefix between two date
GET https://demo.icure.cloud/rest/v2/message/byTransportGuidSentDate
Query Parameters
| Name | Type | Description |
|---|---|---|
transportGuid | String | |
from | Long | |
to | Long | |
startKey | String | |
startDocumentId | String | |
limit | Integer | |
hcpId | String |
Get children messages of provided message
GET https://demo.icure.cloud/rest/v2/message/{messageId}/children
Path Parameters
| Name | Type | Description |
|---|---|---|
messageId* | String |
Gets a message
GET https://demo.icure.cloud/rest/v2/message/{messageId}
Path Parameters
| Name | Type | Description |
|---|---|---|
messageId* | String |
Get children messages of provided message
POST https://demo.icure.cloud/rest/v2/message/children/batch
Request Body
| Name | Type | Description |
|---|---|---|
body* | ListOfIds |
Get children messages of provided message
POST https://demo.icure.cloud/rest/v2/message/byInvoice
Request Body
| Name | Type | Description |
|---|---|---|
body* | ListOfIds |
Get all messages for current HC Party and provided transportGuids
POST https://demo.icure.cloud/rest/v2/message/byTransportGuid/list
Query Parameters
| Name | Type | Description |
|---|---|---|
hcpId* | String |
Request Body
| Name | Type | Description |
|---|---|---|
body* | ListOfIds |
Updates a message
PUT https://demo.icure.cloud/rest/v2/message
Request Body
| Name | Type | Description |
|---|---|---|
body* | Message |
Adds a delegation to a message
PUT https://demo.icure.cloud/rest/v2/message/{messageId}/delegate
Path Parameters
| Name | Type | Description |
|---|---|---|
messageId* | String |
Request Body
| Name | Type | Description |
|---|---|---|
body* | List |
Set read status for given list of messages
PUT https://demo.icure.cloud/rest/v2/message/readstatus
Request Body
| Name | Type | Description |
|---|---|---|
body* | MessagesReadStatusUpdate |
Set status bits for given list of messages
PUT https://demo.icure.cloud/rest/v2/message/status/{status}
Path Parameters
| Name | Type | Description |
|---|---|---|
status* | Integer |
Request Body
| Name | Type | Description |
|---|---|---|
body* | ListOfIds |
Last updated