Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Returns list of prepared messages. At least one of the following two fields is mandatory:

  • 'lastUpdateDateFrom'

  • 'creationDateFrom' - must be within 31 days of CreationDateTo.

CreationDateTo if is not given then by default is currentDate, if is given than obligatory is to use creationDateFrom as well.

To get the result faster, use limit (1-500).

Available from

v7

Request path

POST [REST URL]/preparedmessage/find

Query Parameters

Parameter

Type

Description

filter

PreparedMessageSummary

A filter with the list of prepared messages.

Example bodies

Code Block
{
 "externalMessageId": "MessageID"
}
Code Block
{
 "creationDateFrom": "2020-07-10",
 "messageName" : "MessageToBeArchived",
 "limit":1 
}
Code Block
{
"creationDateFrom": "2020-07-10",
"creationDateTo" : "2020-07-15",
"messageName" : "MessageToBeArchived",
"limit":1
}
Code Block
{
 "lastUpdateDateFrom": "2020-07-17",
 "messageName" : "MessageToBeArchived",
 "limit":1 
}
Code Block
{
 "lastUpdateDateFrom": "2020-07-10",
 "creationDateTo" : "2020-07-15",
 "messageName" : "MessageToBeArchived",
 "limit":1 
}
Code Block
{
"creationDateFrom": "2020-07-01",
"lastUpdateDateFrom": "2020-07-10",
"creationDateTo" : "2020-07-15",
"messageName" : "MessageToBeArchived",
"limit":1
}