GET Setup/ServiceBusMessage

Request Information

URI Parameters

Name	Type	Additional information
QueryingAtLeastOneThing	boolean	None.
IncludeActive	boolean	None.
IncludeInactive	boolean	None.
IncludeDeleted	boolean	None.
Match	MatchCriteriaStringType	None.
MessageIDs	Collection of integer	None.
MessageType	ServiceBusMessageType	None.
ChannelType	ServiceBusChannelType	None.
MessageSource	string	None.
MessageTarget	string	None.
BroadcastMessageTarget	string	None.
MessageHeader	string	None.
MessageDateUtcMin	date	None.
MessageDateUtcMax	date	None.
MessageState	ServiceBusMessageState	None.
MessageStates	Collection of ServiceBusMessageState	None.
MessageSourceReferenceID	string	None.
IncludePayload	boolean	None.
CreatedDateUtcMin	date	None.
CreatedDateUtcMax	date	None.
LastUpdatedDateUtcMin	date	None.
LastUpdatedDateUtcMax	date	None.
MaxRows	integer	None.
SortColumn	string	None.
SortDirection	string	None.
Skip	integer	None.
Limit	integer	None.

Body Parameters

None.

Response Information

Resource Description

Collection of ServiceBusMessageDTO

Name	Type	Additional information
MessageType	ServiceBusMessageType	None.
ChannelType	ServiceBusChannelType	None.
MessageSource	string	None.
MessageTarget	string	None.
MessageHeader	string	None.
MessageDateUtc	date	None.
MessageSourceReferenceID	string	None.
MessagePayload	string	None.
MessagePayloadProps	Collection of Object	None.
MessageResults	string	None.
SubscriberDetails	Collection of ServiceBusMessageSubscriberDetailDTO	None.
RecordState	RecordState	None.
Created	AuditDataDTO	None.
LastUpdated	AuditDataDTO	None.
EventStatus	string	None.
MessageID	integer	None.
MessageState	ServiceBusMessageState	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "messageType": 1,
    "channelType": 1,
    "messageSource": "sample string 1",
    "messageTarget": "sample string 2",
    "messageHeader": "sample string 3",
    "messageDateUtc": "2024-12-04T08:02:05.9337578+00:00",
    "messageSourceReferenceID": "sample string 5",
    "messagePayload": "sample string 6",
    "messageResults": "sample string 7",
    "subscriberDetails": [
      {
        "subscriberDetailID": 1,
        "messageID": 2,
        "messageTarget": "sample string 3",
        "messageState": 1,
        "results": "sample string 4",
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:02:05.949783+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:02:05 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:02:05.949783+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:02:05 AM"
        }
      },
      {
        "subscriberDetailID": 1,
        "messageID": 2,
        "messageTarget": "sample string 3",
        "messageState": 1,
        "results": "sample string 4",
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:02:05.949783+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:02:05 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:02:05.949783+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:02:05 AM"
        }
      }
    ],
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T08:02:05.949783+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:02:05 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T08:02:05.949783+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:02:05 AM"
    },
    "eventStatus": "sample string 8",
    "messageID": 9,
    "messageState": 1
  },
  {
    "messageType": 1,
    "channelType": 1,
    "messageSource": "sample string 1",
    "messageTarget": "sample string 2",
    "messageHeader": "sample string 3",
    "messageDateUtc": "2024-12-04T08:02:05.9337578+00:00",
    "messageSourceReferenceID": "sample string 5",
    "messagePayload": "sample string 6",
    "messageResults": "sample string 7",
    "subscriberDetails": [
      {
        "subscriberDetailID": 1,
        "messageID": 2,
        "messageTarget": "sample string 3",
        "messageState": 1,
        "results": "sample string 4",
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:02:05.949783+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:02:05 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:02:05.949783+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:02:05 AM"
        }
      },
      {
        "subscriberDetailID": 1,
        "messageID": 2,
        "messageTarget": "sample string 3",
        "messageState": 1,
        "results": "sample string 4",
        "recordState": 1,
        "created": {
          "dateUtc": "2024-12-04T08:02:05.949783+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:02:05 AM"
        },
        "lastUpdated": {
          "dateUtc": "2024-12-04T08:02:05.949783+00:00",
          "userName": "sample string 2",
          "summary": "sample string 2 on 12/4/2024 8:02:05 AM"
        }
      }
    ],
    "recordState": 1,
    "created": {
      "dateUtc": "2024-12-04T08:02:05.949783+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:02:05 AM"
    },
    "lastUpdated": {
      "dateUtc": "2024-12-04T08:02:05.949783+00:00",
      "userName": "sample string 2",
      "summary": "sample string 2 on 12/4/2024 8:02:05 AM"
    },
    "eventStatus": "sample string 8",
    "messageID": 9,
    "messageState": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfServiceBusMessageDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <ServiceBusMessageDTO>
    <MessageID>9</MessageID>
    <MessageState>New</MessageState>
    <ChannelType>PointToPoint</ChannelType>
    <Created>
      <DateUtc>2024-12-04T08:02:05.949783+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <EventStatus>sample string 8</EventStatus>
    <LastUpdated>
      <DateUtc>2024-12-04T08:02:05.949783+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <MessageDateUtc>2024-12-04T08:02:05.9337578+00:00</MessageDateUtc>
    <MessageHeader>sample string 3</MessageHeader>
    <MessagePayload>sample string 6</MessagePayload>
    <MessagePayloadProps xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
    <MessageResults>sample string 7</MessageResults>
    <MessageSource>sample string 1</MessageSource>
    <MessageSourceReferenceID>sample string 5</MessageSourceReferenceID>
    <MessageTarget>sample string 2</MessageTarget>
    <MessageType>Event</MessageType>
    <RecordState>Active</RecordState>
    <SubscriberDetails>
      <ServiceBusMessageSubscriberDetailDTO>
        <Created>
          <DateUtc>2024-12-04T08:02:05.949783+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <LastUpdated>
          <DateUtc>2024-12-04T08:02:05.949783+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <MessageID>2</MessageID>
        <MessageState>New</MessageState>
        <MessageTarget>sample string 3</MessageTarget>
        <RecordState>Active</RecordState>
        <Results>sample string 4</Results>
        <SubscriberDetailID>1</SubscriberDetailID>
      </ServiceBusMessageSubscriberDetailDTO>
      <ServiceBusMessageSubscriberDetailDTO>
        <Created>
          <DateUtc>2024-12-04T08:02:05.949783+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <LastUpdated>
          <DateUtc>2024-12-04T08:02:05.949783+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <MessageID>2</MessageID>
        <MessageState>New</MessageState>
        <MessageTarget>sample string 3</MessageTarget>
        <RecordState>Active</RecordState>
        <Results>sample string 4</Results>
        <SubscriberDetailID>1</SubscriberDetailID>
      </ServiceBusMessageSubscriberDetailDTO>
    </SubscriberDetails>
  </ServiceBusMessageDTO>
  <ServiceBusMessageDTO>
    <MessageID>9</MessageID>
    <MessageState>New</MessageState>
    <ChannelType>PointToPoint</ChannelType>
    <Created>
      <DateUtc>2024-12-04T08:02:05.949783+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </Created>
    <EventStatus>sample string 8</EventStatus>
    <LastUpdated>
      <DateUtc>2024-12-04T08:02:05.949783+00:00</DateUtc>
      <UserName>sample string 2</UserName>
    </LastUpdated>
    <MessageDateUtc>2024-12-04T08:02:05.9337578+00:00</MessageDateUtc>
    <MessageHeader>sample string 3</MessageHeader>
    <MessagePayload>sample string 6</MessagePayload>
    <MessagePayloadProps xmlns:d3p1="http://schemas.datacontract.org/2004/07/ProcuraGroup.Common" i:nil="true" />
    <MessageResults>sample string 7</MessageResults>
    <MessageSource>sample string 1</MessageSource>
    <MessageSourceReferenceID>sample string 5</MessageSourceReferenceID>
    <MessageTarget>sample string 2</MessageTarget>
    <MessageType>Event</MessageType>
    <RecordState>Active</RecordState>
    <SubscriberDetails>
      <ServiceBusMessageSubscriberDetailDTO>
        <Created>
          <DateUtc>2024-12-04T08:02:05.949783+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <LastUpdated>
          <DateUtc>2024-12-04T08:02:05.949783+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <MessageID>2</MessageID>
        <MessageState>New</MessageState>
        <MessageTarget>sample string 3</MessageTarget>
        <RecordState>Active</RecordState>
        <Results>sample string 4</Results>
        <SubscriberDetailID>1</SubscriberDetailID>
      </ServiceBusMessageSubscriberDetailDTO>
      <ServiceBusMessageSubscriberDetailDTO>
        <Created>
          <DateUtc>2024-12-04T08:02:05.949783+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </Created>
        <LastUpdated>
          <DateUtc>2024-12-04T08:02:05.949783+00:00</DateUtc>
          <UserName>sample string 2</UserName>
        </LastUpdated>
        <MessageID>2</MessageID>
        <MessageState>New</MessageState>
        <MessageTarget>sample string 3</MessageTarget>
        <RecordState>Active</RecordState>
        <Results>sample string 4</Results>
        <SubscriberDetailID>1</SubscriberDetailID>
      </ServiceBusMessageSubscriberDetailDTO>
    </SubscriberDetails>
  </ServiceBusMessageDTO>
</ArrayOfServiceBusMessageDTO>

application/x-compressed-json

Sample:

��Kn�0����-i����Ub�.ZU	YUY8fJ�� �TBQN�E��+�DQHc���P���|���g<�o�[T��4��kŎ��3����_֭`�IZ5%XR��疃�DJE� �@��@�;	U�RL#o��RƘ�ؿ�\7���ct&mO �3�M��~�]Y��@�d�-�4�@#��H&�
�-JMi�O{	�u���dӉ	K�]�_ �P�>�j�
,��:�-ʾwы��=��J��2KK��V��jn9d���������٨�R��ljv�T�Wg=9�[5�\�6�fǅ�S;GF���`�Ӡ��d���4��hЯ?�(4��