Agreements - Get Agreement

Service:

BizTalk Server 2016

API Version:

v1

依名稱取得合約

GET http://localhost/BizTalkManagementService/Agreements/{agreementName}

URI 參數

名稱	位於	必要	類型	Description
agreementName	path	True	string	協議名稱。

回應

名稱	類型	Description
200 OK	Agreement	確定 Media Types: "application/json", "text/json", "application/xml", "text/xml"

定義

名稱	Description
Agreement	合約模型
AgreementContent	合約內容。
AS2AcknowledgmentConnectionSettings	AS2AcknowledgmentConnectionSettings 的模型
AS2AgreementContent	合約中 AS2 通訊協定設定的模型
AS2EnvelopeSettings	AS2EnvelopeSettings 的模型
AS2ErrorSettings	AS2ErrorSettings 的模型
AS2MDNSettings	AS2MDNSettings 的模型
AS2MessageConnectionSettings	AS2MessageConnectionSettings 的模型
AS2OnewayAgreement	AS2 Oneway 合約的模型
AS2ProtocolSettings	合約中 AS2 通訊協定設定的模型
AS2SecuritySettings	AS2SecuritySettings 的模型
AS2ValidationSettings	AS2ValidationSettings 的模型
BatchDescription	BatchDescription 的模型
Contact	連絡人模型
CustomSetting	合作物件自訂設定
DailyRecurrence	DailyRecurrence 的模型
EDIFACTAcknowledgmentSettings	EDIFACTAcknowledgmentSettings 的模型
EDIFACTAgreementContent	合約中 EDIFACT 通訊協定設定的模型
EDIFACTEnvelopeOverrides	EDIFACTEnvelopeOverride 的模型
EDIFACTEnvelopeSettings	EDIFACTEnvelopeSettings 的模型
EDIFACTFramingSettings	EDIFACTFramingSettings 的模型
EDIFACTMessageFilter	EDIFACTMessageFilter 的模型
EDIFACTMessageIdentifier	EDIFACTMessageIdentifier 的模型
EDIFACTOnewayAgreement	EDIFACT Oneway 合約的模型
EDIFACTProcessingSettings	EDIFACTProcessingSettings 的模型
EDIFACTProtocolSettings	合約中 EDIFACT 通訊協定設定的模型
EDIFACTSchemaOverrides	EDIFACTSchemaReference 的模型
EDIFACTSchemaSettings	EDIFACTSchemaSettings 的模型
EDIFACTValidationOverrides	EDIFACTValidationOverride 的模型
EDIFACTValidationSettings	EDIFACTValidationSettings 的模型
FilterGroup	FilterGroup 的模型
FilterPredicate	FilterGroup 的模型
FilterStatement	FilterStatement 的模型
HourlyRecurrence	HourlyRecurrence 的模型
InterchangeSizeReleaseCriteria	交換模型SizeReleaseCriteria
ManualReleaseCriteria	ManualReleaseCriteria 的模型
MessageCountReleaseCriteria	MessageCountReleaseCriteria 的模型
PartnerAgreementContext	PartnerAgreementCoNtext 的模型
QualifierIdentity	QualifierIdentity 的模型
TimeBasedReleaseCriteria	TimeBasedReleaseCriteria 的模型
WeeklyRecurrence	WeeklyRecurrence 的模型
X12AcknowledgmentSettings	X12AcknowledgmentSettings 的模型
X12AgreementContent	合約中 X12 通訊協定設定的模型
X12EnvelopeOverrides	X12EnvelopeOverride 的模型
X12EnvelopeSettings	X12EnvelopeSettings 的模型
X12FramingSettings	X12FramingSettings 的模型
X12MessageFilter	X12MessageFilter 的模型
X12MessageIdentifier	X12MessageIdentifier 的模型
X12OnewayAgreement	X12 Oneway 合約的模型
X12ProcessingSettings	X12ProcessingSettings 的模型
X12ProtocolSettings	合約中 X12 通訊協定設定的模型
X12SchemaOverrides	X12SchemaReference 的模型
X12SchemaSettings	X12SchemaSettings 的模型
X12SecuritySettings	X12SecuritySettings 的模型
X12ValidationOverrides	X12ValidationOverride 的模型
X12ValidationSettings	X12ValidationSettings 的模型

Agreement

合約模型

名稱	類型	Description
AgreementContent	AgreementContent	取得或設定合約內容。
Contacts	Contact[]	取得或設定連絡人。
CustomSettings	CustomSetting[]	取得或設定自訂設定。
Description	string	取得或設定描述。
Enabled	boolean	取得或設定值，指出是否已啟用。
EndDate	string	取得或設定結束日期。
Id	integer	取得或設定識別碼。
Name	string	取得或設定名稱。
Protocol	string	取得或設定通訊協定。
ReceivePartner	PartnerAgreementContext	取得或設定接收夥伴。
SendPartner	PartnerAgreementContext	取得或設定傳送夥伴。
StartDate	string	取得或設定開始日期。

AgreementContent

合約內容。

名稱	類型	Description
AS2AgreementContent	AS2AgreementContent	取得或設定 AS2 合約內容。
EDIFACTAgreementContent	EDIFACTAgreementContent	取得或設定 EDIFACT 合約內容。
X12AgreementContent	X12AgreementContent	取得或設定 X12 合約內容。

AS2AcknowledgmentConnectionSettings

AS2AcknowledgmentConnectionSettings 的模型

名稱	類型	Description
AckHttpExpect100Continue	boolean	取得或設定值，指出是否要繼續 ack HTTP 100。
AckIgnoreCertificateNameMismatch	boolean	取得或設定值，指出 ack 是否忽略憑證名稱不符。
AckKeepHttpConnectionAlive	boolean	取得或設定值，指出 ack 是否讓 HTTP 連線保持運作。
AckUnfoldHttpHeaders	boolean	取得或設定值，指出是否要展開 HTTP 標頭。

AS2AgreementContent

合約中 AS2 通訊協定設定的模型

名稱	類型	Description
ReceiveAgreement	AS2OnewayAgreement	取得或設定接收協定。
SendAgreement	AS2OnewayAgreement	取得或設定傳送協定。

AS2EnvelopeSettings

AS2EnvelopeSettings 的模型

名稱	類型	Description
AutogenerateFileName	boolean	取得或設定值，指出是否自動產生檔案名。
FileNameTemplate	string	取得或設定檔案名範本。
MessageContentType	string	取得或設定訊息內容類型。
SuspendMessageOnFileNameGenerationError	boolean	取得或設定值，指出是否在檔案名產生錯誤時暫停訊息。
TransmitFileNameInMimeHeader	boolean	取得或設定值，指出 mime 標頭中是否傳輸檔案名。

AS2ErrorSettings

AS2ErrorSettings 的模型

名稱	類型	Description
HttpRetryTimeout	string	取得或設定 HTTP 重試逾時。
MaxResendAttempts	integer	取得或設定最大重新傳送嘗試。
MaximumHttpRetryAttempts	integer	取得或設定 HTTP 重試嘗試次數上限。
MinimumHttpRetryInterval	string	取得或設定最小 HTTP 重試間隔。
MinimumResendInterval	string	取得或設定最小重新傳送間隔。
OverrideSendPort	boolean	取得或設定值，指出是否覆寫傳送埠。
ResendIfMDNNotReceived	boolean	取得或設定值，指出是否未收到 mdn 時重新傳送。
ResendTimeout	string	取得或設定重新傳送逾時。
SuspendDuplicateMessage	boolean	取得或設定值，指出是否暫停重複的訊息。

AS2MDNSettings

AS2MDNSettings 的模型

名稱	類型	Description
DispositionNotificationTo	string	取得或設定的處置通知。
MDNText	string	取得或設定 mdn 文字。
MicHashingAlgorithm	string	取得或設定麥克風雜湊演算法。
NeedMDN	boolean	取得或設定值，指出是否需要 mdn。
ProcessMDNtoMsgBox	boolean	取得或設定值，指出是否要將 mdn 處理至 msg 方塊。
ReceiptDeliveryUrl	string	取得或設定收據傳遞 URL。
SendMDNAsynchronously	boolean	取得或設定值，指出是否要以非同步方式傳送 mdn。
SignMDN	boolean	取得或設定值，指出是否要簽署 mdn。
SignOutboundMDNIfOptional	boolean	取得或設定值，指出是否選擇性地簽署輸出 mdn。

AS2MessageConnectionSettings

AS2MessageConnectionSettings 的模型

名稱	類型	Description
HttpExpect100ContinueSupported	boolean	取得或設定值，指出 HTTP 是否預期是否繼續支援 100。
IgnoreCertificateNameMismatch	boolean	取得或設定值，指出是否忽略憑證名稱不符。
KeepHttpConnectionAlive	boolean	取得或設定值，指出是否讓 HTTP 連線保持運作。
UnfoldHttpHeaders	boolean	取得或設定值，指出是否展開 HTTP 標頭。

AS2OnewayAgreement

AS2 Oneway 合約的模型

名稱	類型	Description
BatchDescriptions	BatchDescription[]	取得或設定批次描述。
Id	integer	取得或設定識別碼。
ProtocolSettings	AS2ProtocolSettings	取得或設定通訊協定設定。
ReceiveBusinessIdentity	QualifierIdentity	取得或設定接收商務身分識別。
SendPortNames	string[]	取得或設定傳送埠參考。
SenderBusinessIdentity	QualifierIdentity	取得或設定寄件者商務身分識別。

AS2ProtocolSettings

合約中 AS2 通訊協定設定的模型

名稱	類型	Description
AcknowledgmentConnectionSettings	AS2AcknowledgmentConnectionSettings	取得或設定通知連線設定。
EnvelopeSettings	AS2EnvelopeSettings	取得或設定信封設定。
ErrorSettings	AS2ErrorSettings	取得或設定錯誤設定。
Id	integer	取得或設定識別碼。
MDNSettings	AS2MDNSettings	取得或設定 mdn 設定。
MessageConnectionSettings	AS2MessageConnectionSettings	取得或設定訊息連線設定。
ProtocolName	string	取得或設定通訊協定名稱。
SecuritySettings	AS2SecuritySettings	取得或設定安全性設定。
SettingsName	string	取得或設定設定名稱。
ValidationSettings	AS2ValidationSettings	取得或設定驗證設定。

AS2SecuritySettings

AS2SecuritySettings 的模型

名稱	類型	Description
EnableNRRForInboundDecodedMessages	boolean	取得或設定值，指出是否為輸入解碼的訊息啟用 nrr。
EnableNRRForInboundEncodedMessages	boolean	取得或設定值，指出是否啟用輸入編碼訊息的 nrr。
EnableNRRForInboundMDN	boolean	取得或設定值，指出是否啟用輸入 mdn 的 nrr。
EnableNRRForOutboundDecodedMessages	boolean	取得或設定值，指出是否啟用輸出解碼訊息的 nrr。
EnableNRRForOutboundEncodedMessages	boolean	取得或設定值，指出是否啟用輸出編碼訊息的 nrr。
EnableNRRForOutboundMDN	boolean	取得或設定值，指出是否啟用輸出 mdn 的 nrr。
OverrideGroupSigningCertificate	boolean	取得或設定值，指出是否覆寫群組簽署憑證。
SigningCertificateName	string	取得或設定簽署憑證名稱。
SigningCertificateThumbprint	string	取得或設定簽署憑證指紋。

AS2ValidationSettings

AS2ValidationSettings 的模型

名稱	類型	Description
CheckCertificateRevocationListOnReceive	boolean	取得或設定值，指出是否在接收時檢查憑證撤銷清單。
CheckCertificateRevocationListOnSend	boolean	取得或設定值，指出是否在傳送時檢查憑證撤銷清單。
CheckDuplicateMessage	boolean	取得或設定值，指出是否檢查重複的訊息。
EncryptionAlgorithm	string	取得或設定加密演算法。
InterchangeDuplicatesValidity	integer	取得或設定交換重複項有效性。
MessageCompressed	boolean	取得或設定值，指出訊息是否壓縮。
MessageEncrypted	boolean	取得或設定值，指出訊息是否加密。
MessageSigned	boolean	取得或設定值，指出訊息是否帶正負號。
OverrideMessageProperties	boolean	取得或設定值，指出是否要覆寫訊息屬性。

BatchDescription

BatchDescription 的模型

名稱	類型	Description
Description	string	取得或設定描述。
EndDate	string	取得或設定結束日期。
Filter	FilterPredicate	取得或設定篩選述詞。
Id	integer	取得或設定識別碼。
InterchangeSizeRelease	InterchangeSizeReleaseCriteria	取得或設定交換大小發行準則
ManualRelease	ManualReleaseCriteria	取得或設定手動發行準則
MessageCountRelease	MessageCountReleaseCriteria	取得或設定訊息計數發行準則
Name	string	取得或設定名稱。
Protocol	string	取得或設定通訊協定。
StartDate	string	取得或設定開始日期。
TerminationCount	integer	取得或設定終止計數。
TimeBasedRelease	TimeBasedReleaseCriteria	取得或設定以時間為基礎的發行準則

Contact

連絡人模型

名稱	類型	Description
Address	string	取得或設定位址。
BusinessPhone	string	取得或設定商務電話。
Company	string	取得或設定公司。
Email	string	取得或設定電子郵件。
Fax	string	取得或設定傳真。
Id	integer	取得或設定識別碼。
JobTitle	string	取得或設定職稱。
MobilePhone	string	取得或設定行動電話。
Name	string	取得或設定名稱。
Notes	string	取得或設定附注。
WebAddress	string	取得或設定網址。

CustomSetting

合作物件自訂設定

名稱	類型	Description
Name	string	設定名稱
Value	string	設定值

DailyRecurrence

DailyRecurrence 的模型

名稱	類型	Description
Days	integer	取得或設定天數。
RecurrencePeriod	string	取得或設定週期期間。

EDIFACTAcknowledgmentSettings

EDIFACTAcknowledgmentSettings 的模型

名稱	類型	Description
AcknowledgmentControlNumberLowerBound	integer	取得或設定通知控制編號下限。
AcknowledgmentControlNumberPrefix	string	取得或設定通知控制編號前置詞。
AcknowledgmentControlNumberRollover	boolean	取得或設定值，指出是否要變換通知控制編號
AcknowledgmentControlNumberSuffix	string	取得或設定通知控制編號尾碼。
AcknowledgmentControlNumberUpperBound	integer	取得或設定通知控制項編號上限。
BatchFunctionalAcknowledgments	boolean	取得或設定值，指出是否要批次運作通知。
BatchTechnicalAcknowledgments	boolean	取得或設定值，指出是否要批次處理技術通知。
NeedFunctionalAcknowledgment	boolean	取得或設定值，指出是否需要功能通知。
NeedLoopForValidMessages	boolean	取得或設定值，指出有效訊息是否需要迴圈。
NeedTechnicalAcknowledgment	boolean	取得或設定值，指出是否需要技術通知。
SendSynchronousAcknowledgment	boolean	取得或設定值，指出是否要傳送同步通知。

EDIFACTAgreementContent

合約中 EDIFACT 通訊協定設定的模型

名稱	類型	Description
ReceiveAgreement	EDIFACTOnewayAgreement	取得或設定接收協定。
SendAgreement	EDIFACTOnewayAgreement	取得或設定傳送協定。

EDIFACTEnvelopeOverrides

EDIFACTEnvelopeOverride 的模型

名稱	類型	Description
ApplicationPassword	string	取得或設定應用程式密碼。
AssociationAssignedCode	string	取得或設定關聯指派的程式碼。
ControllingAgencyCode	string	取得或設定控制機構程式碼。
FunctionalGroupId	string	取得或設定功能群組識別碼。
GroupHeaderMessageRelease	string	取得或設定群組標頭訊息發行。
GroupHeaderMessageVersion	string	取得或設定群組標頭訊息版本。
MessageAssociationAssignedCode	string	取得或設定訊息關聯指派的程式碼。
MessageId	string	取得或設定必須套用此信封設定的訊息識別碼。
MessageRelease	string	取得或設定套用此信封設定的訊息發行版本本。
MessageVersion	string	取得或設定套用此信封設定的訊息版本。
ReceiverApplicationId	string	取得或設定接收者應用程式識別碼。
ReceiverApplicationQualifier	string	取得或設定接收者應用程式限定詞。
SenderApplicationId	string	取得或設定傳送者應用程式識別碼。
SenderApplicationQualifier	string	取得或設定寄件者應用程式限定詞。
TargetNamespace	string	取得或設定套用此信封設定的目標命名空間。

EDIFACTEnvelopeSettings

EDIFACTEnvelopeSettings 的模型

名稱	類型	Description
ApplicationReferenceId	string	取得或設定應用程式參考識別碼。
ApplyDelimiterStringAdvice	boolean	取得或設定值，指出是否套用分隔符號字串建議。
CommunicationAgreementId	string	取得或設定通訊協定識別碼。
CreateGroupingSegments	boolean	取得或設定值，指出是否建立群組區段。
EnableDefaultGroupHeaders	boolean	取得或設定值，指出是否要啟用預設群組標頭。
EnvelopeOverrides	EDIFACTEnvelopeOverrides[]	取得或設定信封覆寫。
FunctionalGroupId	string	取得或設定功能群組識別碼。
GroupApplicationPassword	string	取得或設定群組應用程式密碼。
GroupApplicationReceiverId	string	取得或設定群組應用程式接收者識別碼。
GroupApplicationReceiverQualifier	string	取得或設定群組應用程式接收者限定詞。
GroupApplicationSenderId	string	取得或設定群組應用程式寄件者識別碼。
GroupApplicationSenderQualifier	string	取得或設定群組應用程式寄件者限定詞。
GroupAssociationAssignedCode	string	取得或設定群組關聯指派的程式碼。
GroupControlNumberLowerBound	integer	取得或設定群組控制編號下限。
GroupControlNumberPrefix	string	取得或設定群組控制編號前置詞。
GroupControlNumberRollover	boolean	取得或設定值，指出是否要變換群組控制編號。
GroupControlNumberSuffix	string	取得或設定群組控制編號尾碼。
GroupControlNumberUpperBound	integer	取得或設定群組控制編號上限。
GroupControllingAgencyCode	string	取得或設定群組控制機構程式碼。
GroupMessageRelease	string	取得或設定群組訊息發行。
GroupMessageVersion	string	取得或設定群組訊息版本。
InterchangeControlNumberLowerBound	integer	取得或設定交換控制編號下限
InterchangeControlNumberPrefix	string	取得或設定交換控制編號前置詞。
InterchangeControlNumberRollover	boolean	取得或設定值，指出是否要變換交換控制編號。
InterchangeControlNumberSuffix	string	取得或設定交換控制編號尾碼。
InterchangeControlNumberUpperBound	integer	取得或設定交換控制編號上限。
IsTestInterchange	boolean	取得或設定值，指出是否為測試交換。
OverwriteExistingTransactionSetControlNumber	boolean	取得或設定值，指出是否要覆寫現有的交易集控制編號
ProcessingPriorityCode	string	取得或設定處理優先順序程式碼。
ReceiverInternalIdentification	string	取得或設定接收者內部識別。
ReceiverInternalSubIdentification	string	取得或設定接收者內部子識別。
ReceiverReverseRoutingAddress	string	取得或設定接收者反向路由位址。
RecipientReferencePasswordQualifier	string	取得或設定收件者參考密碼限定詞。
RecipientReferencePasswordValue	string	取得或設定收件者參考密碼值。
SenderInternalIdentification	string	取得或設定傳送者內部識別。
SenderInternalSubIdentification	string	取得或設定傳送者內部子識別。
SenderReverseRoutingAddress	string	取得或設定寄件者反向路由位址。
TransactionSetControlNumberLowerBound	integer	取得或設定交易集控制編號下限。
TransactionSetControlNumberPrefix	string	取得或設定交易集控制編號前置詞。
TransactionSetControlNumberRollover	boolean	取得或設定值，指出是否要變換交易集控制編號。
TransactionSetControlNumberSuffix	string	取得或設定交易集控制編號尾碼。
TransactionSetControlNumberUpperBound	integer	取得或設定交易集控制編號上限。

EDIFACTFramingSettings

EDIFACTFramingSettings 的模型

名稱	類型	Description
CharacterEncoding	string	取得或設定字元編碼。
CharacterSet	string	取得或設定 EDIFACT 字元集。
ComponentSeparator	integer	取得或設定元件分隔符號。
DataElementSeparator	integer	取得或設定資料項目分隔符號。
DecimalPointIndicator	string	取得或設定小數點指標。
ProtocolVersion	integer	取得或設定通訊協定版本。
ReleaseIndicator	integer	取得或設定發行指標。
RepetitionSeparator	integer	取得或設定重複分隔符號。
SegmentTerminator	integer	取得或設定區段結束字元。
SegmentTerminatorSuffix	string	取得或設定區段結束字元尾碼。
ServiceCodeListDirectoryVersion	string	取得或設定服務程式代碼清單目錄版本。

EDIFACTMessageFilter

EDIFACTMessageFilter 的模型

名稱	類型	Description
FilterMessages	EDIFACTMessageIdentifier[]	取得或設定篩選訊息。
MessageFilterType	string	取得或設定訊息篩選類型。

EDIFACTMessageIdentifier

EDIFACTMessageIdentifier 的模型

名稱	類型	Description
MessageId	string	取得或設定訊息識別碼。

EDIFACTOnewayAgreement

EDIFACT Oneway 合約的模型

名稱	類型	Description
BatchDescriptions	BatchDescription[]	取得或設定批次描述。
Id	integer	取得或設定識別碼。
ProtocolSettings	EDIFACTProtocolSettings	取得或設定通訊協定設定。
ReceiveBusinessIdentity	QualifierIdentity	取得或設定接收商務身分識別。
SendPortNames	string[]	取得或設定傳送埠參考。
SenderBusinessIdentity	QualifierIdentity	取得或設定寄件者商務身分識別。

EDIFACTProcessingSettings

EDIFACTProcessingSettings 的模型

名稱	類型	Description
CreateEmptyXmlTagsForTrailingSeparators	boolean	取得或設定值，指出是否要為尾端分隔符號建立空的 xml 標記。
MaskSecurityInfo	boolean	取得或設定值，指出是否要遮罩安全性資訊。
PreserveInterchange	boolean	取得或設定值，指出是否要保留交換。
SuspendInterchangeOnError	boolean	取得或設定值，指出是否要在錯誤時暫停交換。
UseDotAsDecimalSeparator	boolean	取得或設定值，指出是否要使用點做為小數分隔符號。

EDIFACTProtocolSettings

合約中 EDIFACT 通訊協定設定的模型

名稱	類型	Description
AcknowledgmentSettings	EDIFACTAcknowledgmentSettings	取得或設定通知設定。
EnvelopeSettings	EDIFACTEnvelopeSettings	取得或設定信封設定。
FramingSettings	EDIFACTFramingSettings	取得或設定框架設定。
Id	integer	取得或設定識別碼。
IsTestInterchange	boolean	取得或設定值，指出是否為測試交換。
MessageFilter	EDIFACTMessageFilter	取得或設定訊息篩選器。
ProcessingSettings	EDIFACTProcessingSettings	取得或設定處理設定。
ProtocolName	string	取得或設定通訊協定名稱。
SchemaSettings	EDIFACTSchemaSettings	取得或設定處理設定。
SettingsName	string	取得或設定設定名稱。
ValidationSettings	EDIFACTValidationSettings	取得或設定驗證設定。

EDIFACTSchemaOverrides

EDIFACTSchemaReference 的模型

名稱	類型	Description
ApplicationSenderID	string	取得或設定應用程式寄件者識別碼。
ApplicationSenderQualifier	string	取得或設定應用程式寄件者限定詞。
AssociationAssignedCode	string	取得或設定關聯指派的程式碼。
MessageId	string	取得或設定訊息識別碼。
MessageRelease	string	取得或設定訊息識別碼。
MessageVersion	string	取得或設定訊息識別碼。
TargetNamespace	string	取得或設定目標命名空間。

EDIFACTSchemaSettings

EDIFACTSchemaSettings 的模型

名稱	類型	Description
SchemaOverrides	EDIFACTSchemaOverrides[]	取得或設定架構覆寫。
TargetNamespace	string	取得或設定目標命名空間。

EDIFACTValidationOverrides

EDIFACTValidationOverride 的模型

名稱	類型	Description
AllowLeadingAndTrailingSpacesAndZeroes	boolean	取得或設定值，指出是否允許前置和尾端空格和零。
EnforceCharacterSet	boolean	取得或設定值，指出是否強制執行字元集。
InternalTrailingSeparatorPolicy	integer	取得或設定內部尾端分隔符號原則。
MessageId	string	取得或設定必須套用驗證設定的訊息識別碼。
TrailingSeparatorPolicy	string	取得或設定尾端分隔符號原則。
TrimLeadingAndTrailingSpacesAndZeroes	boolean	取得或設定值，指出是否修剪開頭和尾端空格和零。
ValidateEDITypes	boolean	取得或設定值，指出是否要驗證 EDI 類型。
ValidateXSDTypes	boolean	取得或設定值，指出是否要驗證 XSD 類型。

EDIFACTValidationSettings

EDIFACTValidationSettings 的模型

名稱	類型	Description
AllowLeadingAndTrailingSpacesAndZeroes	boolean	取得或設定值，指出是否允許前置和尾端空格和零。
CheckDuplicateGroupControlNumber	boolean	取得或設定值，指出是否要檢查重複的群組控制編號。
CheckDuplicateInterchangeControlNumber	boolean	取得或設定值，指出是否要檢查重複的交換控制編號。
CheckDuplicateTransactionSetControlNumber	boolean	取得或設定值，指出是否要檢查重複的交易集控制編號。
InterchangeControlNumberValidityPeriod	integer	取得或設定交換控制編號的有效期間。
TrailingSeparatorPolicy	string	取得或設定尾端分隔符號原則。
TrimLeadingAndTrailingSpacesAndZeroes	boolean	取得或設定值，指出是否修剪開頭和尾端空格和零。
ValidateCharacterSet	boolean	取得或設定值，指出是否要在訊息中驗證字元集。
ValidateEDITypes	boolean	取得或設定值，指出是否要驗證 EDI 類型。
ValidateXSDTypes	boolean	取得或設定值，指出是否要驗證 XSD 類型。
ValidationOverrides	EDIFACTValidationOverrides[]	取得或設定架構覆寫。

FilterGroup

FilterGroup 的模型

名稱	類型	Description
Statements	FilterStatement[]	取得或設定 語句。

FilterPredicate

FilterGroup 的模型

名稱	類型	Description
Groups	FilterGroup[]	取得或設定群組。

FilterStatement

FilterStatement 的模型

名稱	類型	Description
Operator	string	取得或設定運算子。
Property	string	取得或設定 屬性。
Value	string	取得或設定值。

HourlyRecurrence

HourlyRecurrence 的模型

名稱	類型	Description
Hours	integer	取得或設定小時。
Minutes	integer	取得或設定分鐘數。
RecurrencePeriod	string	取得或設定週期期間。

InterchangeSizeReleaseCriteria

交換模型SizeReleaseCriteria

名稱	類型	Description
CharacterCount	integer	取得或設定字元計數。

ManualReleaseCriteria

ManualReleaseCriteria 的模型

MessageCountReleaseCriteria

MessageCountReleaseCriteria 的模型

名稱	類型	Description
MessageCount	integer	取得或設定訊息計數。
MessageScope	string	取得或設定訊息範圍。

PartnerAgreementContext

PartnerAgreementCoNtext 的模型

名稱	類型	Description
PartnerName	string	取得或設定夥伴。
ProfileName	string	取得或設定設定檔。

QualifierIdentity

QualifierIdentity 的模型

名稱	類型	Description
Description	string	取得或設定描述。
Id	integer	取得或設定識別碼。
Qualifier	string	取得或設定限定詞。
Value	string	取得或設定值。

TimeBasedReleaseCriteria

TimeBasedReleaseCriteria 的模型

名稱	類型	Description
DailyRecurrence	DailyRecurrence	取得或設定週期排程。
FirstRelease	string	取得或設定第一個發行日期時間。
HourlyRecurrence	HourlyRecurrence	取得或設定週期排程。
SendEmptyBatchSignal	boolean	取得或設定值，指出是否傳送空的批次訊號。
WeeklyRecurrence	WeeklyRecurrence	取得或設定週期排程。

WeeklyRecurrence

WeeklyRecurrence 的模型

名稱	類型	Description
RecurrencePeriod	string	取得或設定週期期間。
WeekDays	string	取得或設定星期幾。

X12AcknowledgmentSettings

X12AcknowledgmentSettings 的模型

名稱	類型	Description
AcknowledgmentControlNumberLowerBound	integer	取得或設定通知控制編號下限。
AcknowledgmentControlNumberPrefix	string	取得或設定通知控制編號前置詞。
AcknowledgmentControlNumberRollover	boolean	取得或設定值，指出是否要變換通知控制編號
AcknowledgmentControlNumberSuffix	string	取得或設定通知控制編號尾碼。
AcknowledgmentControlNumberUpperBound	integer	取得或設定通知控制項編號上限。
BatchFunctionalAcknowledgments	boolean	取得或設定值，指出是否要批次運作通知。
BatchImplementationAcknowledgments	boolean	取得或設定值，指出是否要批次實作通知。
BatchTechnicalAcknowledgments	boolean	取得或設定值，指出是否要批次處理技術通知。
FunctionalAcknowledgmentVersion	string	取得或設定功能通知版本。
GeneratePatAK901	boolean	取得或設定值，指出是否產生 k 901。
ImplementationAcknowledgmentVersion	string	取得或設定實作通知版本。
NeedFunctionalAcknowledgment	boolean	取得或設定值，指出是否需要功能通知。
NeedImplementationAcknowledgment	boolean	取得或設定值，指出是否需要實作通知。
NeedLoopForValidMessages	boolean	取得或設定值，指出有效訊息是否需要迴圈。
NeedTechnicalAcknowledgment	boolean	取得或設定值，指出是否需要技術通知。
SendSynchronousAcknowledgment	boolean	取得或設定值，指出是否要傳送同步通知。

X12AgreementContent

合約中 X12 通訊協定設定的模型

名稱	類型	Description
ReceiveAgreement	X12OnewayAgreement	取得或設定接收協定。
SendAgreement	X12OnewayAgreement	取得或設定傳送協定。

X12EnvelopeOverrides

X12EnvelopeOverride 的模型

名稱	類型	Description
DateFormat	string	取得或設定日期格式。
FunctionalIdentifierCode	string	取得或設定功能識別碼代碼。
HeaderVersion	string	取得或設定標頭版本。
MessageId	string	取得或設定必須套用此信封設定的訊息識別碼。
ProtocolVersion	string	取得或設定必須套用此信封設定的通訊協定版本。
ReceiverApplicationId	string	取得或設定接收者應用程式識別碼。
ResponsibleAgencyCode	string	取得或設定負責的機構程式碼。
SenderApplicationId	string	取得或設定傳送者應用程式識別碼。
TargetNamespace	string	取得或設定套用此信封設定的目標命名空間。
TargetNamespaceString	string	取得或設定套用此信封設定的目標命名空間字串。
TimeFormat	string	取得或設定時間格式。

X12EnvelopeSettings

X12EnvelopeSettings 的模型

名稱	類型	Description
ControlStandardsId	integer	取得或設定控制項標準識別碼。
ControlVersionNumber	string	取得或設定控制項版本號碼。
EnableDefaultGroupHeaders	boolean	取得或設定值，指出是否要啟用預設群組標頭。
EnvelopeOverrides	X12EnvelopeOverrides[]	取得或設定信封覆寫。
FunctionalGroupId	string	取得或設定功能群組識別碼。
GroupControlNumberLowerBound	integer	取得或設定群組控制編號下限。
GroupControlNumberRollover	boolean	取得或設定值，指出是否要變換群組控制編號。
GroupControlNumberUpperBound	integer	取得或設定群組控制編號上限。
GroupHeaderAgencyCode	string	取得或設定群組標頭機構程式碼。
GroupHeaderDateFormat	string	取得或設定群組標頭日期格式。
GroupHeaderTimeFormat	string	取得或設定群組標頭時間格式。
GroupHeaderVersion	string	取得或設定群組標頭版本。
InterchangeControlNumberLowerBound	integer	取得或設定交換控制編號下限
InterchangeControlNumberRollover	boolean	取得或設定值，指出是否要變換交換控制編號。
InterchangeControlNumberUpperBound	integer	取得或設定交換控制編號上限。
OverwriteExistingTransactionSetControlNumber	boolean	取得或設定值，指出是否要覆寫現有的交易集控制編號
ReceiverApplicationId	string	取得或設定接收者應用程式識別碼。
SenderApplicationId	string	取得或設定傳送者應用程式識別碼。
TransactionSetControlNumberLowerBound	integer	取得或設定交易集控制編號下限。
TransactionSetControlNumberPrefix	string	取得或設定交易集控制編號前置詞。
TransactionSetControlNumberRollover	boolean	取得或設定值，指出是否要變換交易集控制編號。
TransactionSetControlNumberSuffix	string	取得或設定交易集控制編號尾碼。
TransactionSetControlNumberUpperBound	integer	取得或設定交易集控制編號上限。
UsageIndicator	string	取得或設定使用指標。
UseControlStandardsIdAsRepetitionCharacter	boolean	取得或設定值，指出是否要使用控制項標準識別碼做為重複字元。

X12FramingSettings

X12FramingSettings 的模型

名稱	類型	Description
CharacterSet	string	取得或設定 X12 字元集。
ComponentSeparator	integer	取得或設定元件分隔符號。
DataElementSeparator	integer	取得或設定資料項目分隔符號。
ReplaceCharacter	integer	取得或設定取代字元。
ReplaceSeparatorsInPayload	boolean	取得或設定值，指出是否要取代承載中的分隔符號。
SegmentTerminator	integer	取得或設定區段結束字元。
SegmentTerminatorSuffix	string	取得或設定區段結束字元尾碼。

X12MessageFilter

X12MessageFilter 的模型

名稱	類型	Description
FilterMessages	X12MessageIdentifier[]	取得或設定篩選訊息。
MessageFilterType	string	取得或設定訊息篩選類型。

X12MessageIdentifier

X12MessageIdentifier 的模型

名稱	類型	Description
MessageId	string	取得或設定訊息識別碼。

X12OnewayAgreement

X12 Oneway 合約的模型

名稱	類型	Description
BatchDescriptions	BatchDescription[]	取得或設定批次描述。
Id	integer	取得或設定識別碼。
ProtocolSettings	X12ProtocolSettings	取得或設定通訊協定設定。
ReceiveBusinessIdentity	QualifierIdentity	取得或設定接收商務身分識別。
SendPortNames	string[]	取得或設定傳送埠參考。
SenderBusinessIdentity	QualifierIdentity	取得或設定寄件者商務身分識別。

X12ProcessingSettings

X12ProcessingSettings 的模型

名稱	類型	Description
ConvertImpliedDecimal	boolean	取得或設定值，指出是否要將數數值型別轉換成隱含的小數點。
CreateEmptyXmlTagsForTrailingSeparators	boolean	取得或設定值，指出是否要為尾端分隔符號建立空的 xml 標記。
MaskSecurityInfo	boolean	取得或設定值，指出是否要遮罩安全性資訊。
PreserveInterchange	boolean	取得或設定值，指出是否要保留交換。
SuspendInterchangeOnError	boolean	取得或設定值，指出是否要在錯誤時暫停交換。

X12ProtocolSettings

合約中 X12 通訊協定設定的模型

名稱	類型	Description
AcknowledgmentSettings	X12AcknowledgmentSettings	取得或設定通知設定。
EnvelopeSettings	X12EnvelopeSettings	取得或設定信封設定。
FramingSettings	X12FramingSettings	取得或設定框架設定。
Id	integer	取得或設定識別碼。
MessageFilter	X12MessageFilter	取得或設定訊息篩選器。
ProcessingSettings	X12ProcessingSettings	取得或設定處理設定。
ProtocolName	string	取得或設定通訊協定名稱。
SchemaSettings	X12SchemaSettings	取得或設定架構設定。
SecuritySettings	X12SecuritySettings	取得或設定安全性設定。
SettingsName	string	取得或設定設定名稱。
ValidationSettings	X12ValidationSettings	取得或設定驗證設定。

X12SchemaOverrides

X12SchemaReference 的模型

名稱	類型	Description
MessageId	string	取得或設定訊息識別碼。
SenderApplicationId	string	取得或設定傳送者應用程式識別碼。
TargetNamespace	string	取得或設定目標命名空間。

X12SchemaSettings

X12SchemaSettings 的模型

名稱	類型	Description
SchemaOverrides	X12SchemaOverrides[]	取得或設定架構覆寫。
TargetNamespace	string	取得或設定訊息識別碼。

X12SecuritySettings

X12SecuritySettings 的模型

名稱	類型	Description
AuthorizationQualifier	string	取得或設定授權限定詞。
AuthorizationValue	string	取得或設定授權值。
PasswordValue	string	取得或設定密碼值。
SecurityQualifier	string	取得或設定安全性限定詞。

X12ValidationOverrides

X12ValidationOverride 的模型

名稱	類型	Description
AllowLeadingAndTrailingSpacesAndZeroes	boolean	取得或設定值，指出是否允許前置和尾端空格和零。
MessageId	string	取得或設定必須套用驗證設定的訊息識別碼。
TrailingSeparatorPolicy	string	取得或設定尾端分隔符號原則。
TrimLeadingAndTrailingSpacesAndZeroes	boolean	取得或設定值，指出是否修剪開頭和尾端空格和零。
ValidateCharacterSet	boolean	取得或設定值，指出是否要驗證字元集。
ValidateEDITypes	boolean	取得或設定值，指出是否要驗證 EDI 類型。
ValidateXSDTypes	boolean	取得或設定值，指出是否要驗證 XSD 類型。

X12ValidationSettings

X12ValidationSettings 的模型

名稱	類型	Description
AllowLeadingAndTrailingSpacesAndZeroes	boolean	取得或設定值，指出是否允許前置和尾端空格和零。
CheckDuplicateGroupControlNumber	boolean	取得或設定值，指出是否要檢查重複的群組控制編號。
CheckDuplicateInterchangeControlNumber	boolean	取得或設定值，指出是否要檢查重複的交換控制編號。
CheckDuplicateTransactionSetControlNumber	boolean	取得或設定值，指出是否要檢查重複的交易集控制編號。
InterchangeControlNumberValidityPeriod	integer	取得或設定交換控制編號的有效期間。
TrailingSeparatorPolicy	string	取得或設定尾端分隔符號原則。
TrimLeadingAndTrailingSpacesAndZeroes	boolean	取得或設定值，指出是否修剪前置和尾端空格和零。
ValidateCharacterSet	boolean	取得或設定值，指出是否要在訊息中驗證字元集。
ValidateEDITypes	boolean	取得或設定值，指出是否驗證 EDI 類型。
ValidateXSDTypes	boolean	取得或設定值，指出是否驗證 XSD 類型。
ValidationOverrides	X12ValidationOverrides[]	取得或設定架構覆寫。