The API method Applicationmessages is used when you want to let Process Automation send information to another system. This can be useful in a variety of different applications. For example in an onboarding application, when you want to add a user to the AD. Or, if you want to send specific data to a billing system.
Note: To use Applicationmessages you need to call for API/v1.1 in the URL.
VERB | Header | Resource/Id/Selector | Description | Parameters | Return data |
POST | Ticket | /domains/{domainId}/applicationmessages | The API call is used to fetch data from a queue. When a message is fetched it is marked as processed and will not be returned again. Max 100 messages returned in the response | queueName (string) take (int) | id(string) queueName(string) message(string ) createdDate(DateTime) isProcessed(bool) processedDate(DateTime) processedBySecurityId(string) spaceObjectId(string) |
Example request:
POST
https://live.barium.se/API/v1.1/domains/1234/applicationmessages
Header
ticket=yourticket
POST data:
{
"queueName": "00000000-0000-0000-0000-000000000001.queue-name"
}
Note: The full queueName can be found in Process Studio when Configuring a message.
Example:
Here you can find a tutorial how to set up an application message