PUT Setup/ServiceBusMessage/{messageID}?validateOnly={validateOnly}

Request Information

URI Parameters

Name	Description	Type	Additional information
messageID		integer	Required
validateOnly		boolean	Default value is False

Body Parameters

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.

Request 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-04T07:59:56.5877486+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-04T07:59:56.5877486+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:59:56 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:59:56.5877486+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:59:56 AM"
      }
    },
    {
      "subscriberDetailID": 1,
      "messageID": 2,
      "messageTarget": "sample string 3",
      "messageState": 1,
      "results": "sample string 4",
      "recordState": 1,
      "created": {
        "dateUtc": "2024-12-04T07:59:56.5877486+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:59:56 AM"
      },
      "lastUpdated": {
        "dateUtc": "2024-12-04T07:59:56.5877486+00:00",
        "userName": "sample string 2",
        "summary": "sample string 2 on 12/4/2024 7:59:56 AM"
      }
    }
  ],
  "recordState": 1,
  "created": {
    "dateUtc": "2024-12-04T07:59:56.5877486+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:59:56 AM"
  },
  "lastUpdated": {
    "dateUtc": "2024-12-04T07:59:56.5877486+00:00",
    "userName": "sample string 2",
    "summary": "sample string 2 on 12/4/2024 7:59:56 AM"
  },
  "eventStatus": "sample string 8",
  "messageID": 9,
  "messageState": 1
}

application/xml, text/xml

Sample:

<ServiceBusMessageDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProcuraGroup.Models">
  <MessageID>9</MessageID>
  <MessageState>New</MessageState>
  <ChannelType>PointToPoint</ChannelType>
  <Created>
    <DateUtc>2024-12-04T07:59:56.5877486+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </Created>
  <EventStatus>sample string 8</EventStatus>
  <LastUpdated>
    <DateUtc>2024-12-04T07:59:56.5877486+00:00</DateUtc>
    <UserName>sample string 2</UserName>
  </LastUpdated>
  <MessageDateUtc>2024-12-04T07:59:56.5877486+00:00</MessageDateUtc>
  <MessageHeader>sample string 3</MessageHeader>
  <MessagePayload>sample string 6</MessagePayload>
  <MessagePayloadProps xmlns:d2p1="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-04T07:59:56.5877486+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <LastUpdated>
        <DateUtc>2024-12-04T07:59:56.5877486+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-04T07:59:56.5877486+00:00</DateUtc>
        <UserName>sample string 2</UserName>
      </Created>
      <LastUpdated>
        <DateUtc>2024-12-04T07:59:56.5877486+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>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/x-compressed-json

Sample:

��KN�0��byKJ�W�C� ��
�p�!Dr��(��Xp$��SU5�B����<�O3��3o��@)V��o�����k�x�_5���+V��Ҳ����f���7�r�qe��i�hnJh0��k��"
��0�� �.I	�ߤ-�$�n3�Ch�֋��Yd	�Z9Hl�m��d���P���;I��M�ͦ/&��qaW@��$�S�72�,�`�f���r�S �Y����*&{7���ţh_]���Â)�i�Ӑ3z����~��^�]�B�'�:��|t��`�O�v���

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.