GET Setup/ServiceBusMessage
Get serviceBusMessages from criteria
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| QueryingAtLeastOneThing |
Indicates whether there is a flag |
boolean |
None. |
| IncludeActive |
Include records where RecordState == RecordState.Active |
boolean |
None. |
| IncludeInactive |
Include records where RecordState == RecordState.Inactive |
boolean |
None. |
| IncludeDeleted |
Include records where RecordState == RecordState.Deleted |
boolean |
None. |
| Match |
When searching by string, include records based on match type |
MatchCriteriaStringType |
None. |
| MessageIDs |
Filter by MessageIDs |
Collection of integer |
None. |
| MessageType |
Filter by MessageType |
ServiceBusMessageType |
None. |
| ChannelType |
Filter by ChannelType |
ServiceBusChannelType |
None. |
| MessageSource |
Filter by MessageSource |
string |
None. |
| MessageTarget |
Filter by MessageTarget |
string |
None. |
| BroadcastMessageTarget |
Filter by BroadcastMessageTarget |
string |
None. |
| MessageHeader |
Filter by MessageHeader |
string |
None. |
| MessageDateUtcMin |
Filter by MessageDateUtcMin |
date |
None. |
| MessageDateUtcMax |
Filter by MessageDateUtcMax |
date |
None. |
| MessageState |
Filter by MessageState |
ServiceBusMessageState |
None. |
| MessageStates |
Filter by MessageStates |
Collection of ServiceBusMessageState |
None. |
| MessageSourceReferenceID |
Filter by MessageSourceReferenceID |
string |
None. |
| IncludePayload |
Include payload |
boolean |
None. |
| CreatedDateUtcMin |
Filter by CreatedDateUtcMin |
date |
None. |
| CreatedDateUtcMax |
Filter by CreatedDateUtcMax |
date |
None. |
| LastUpdatedDateUtcMin |
Filter by LastUpdatedDateUtcMin |
date |
None. |
| LastUpdatedDateUtcMax |
Filter by LastUpdatedDateUtcMax |
date |
None. |
| MaxRows |
Limit number of rows |
integer |
None. |
| SortColumn |
Sort the result by this column |
string |
None. |
| SortDirection |
Sort the column in this direction |
string |
None. |
| Skip | integer |
None. |
|
| Limit | integer |
None. |
Body Parameters
None.
Response Information
Resource Description
List of ServiceBusMessageDTOs
Collection of ServiceBusMessageDTO| Name | Description | Type | Additional information |
|---|---|---|---|
| MessageType |
Message Type |
ServiceBusMessageType |
None. |
| ChannelType |
Channel Type |
ServiceBusChannelType |
None. |
| MessageSource |
Message Source |
string |
None. |
| MessageTarget |
Message Target |
string |
None. |
| MessageHeader |
Message Header |
string |
None. |
| MessageDateUtc |
Message Date Utc |
date |
None. |
| MessageSourceReferenceID |
Message Source Reference ID |
string |
None. |
| MessagePayload |
Payload |
string |
None. |
| MessagePayloadProps |
Props |
Collection of Object |
None. |
| MessageResults |
Results |
string |
None. |
| SubscriberDetails |
Last Updated |
Collection of ServiceBusMessageSubscriberDetailDTO |
None. |
| RecordState |
Record State |
RecordState |
None. |
| Created |
Created |
AuditDataDTO |
None. |
| LastUpdated |
Last Updated |
AuditDataDTO |
None. |
| EventStatus |
Event Status |
string |
None. |
| MessageID |
Message ID |
integer |
None. |
| MessageState |
Message State |
ServiceBusMessageState |
None. |