共用方式為

BizTalk Server 2020 REST API 參考

  • 發行項

您可以使用 REST 來管理BizTalk Server環境中的不同成品。 此 API 參考隨附于 BizTalk Server 2020。

如需設定步驟，請參閱 設定 REST API。

合約

  • 取得 /Agreements
  • post /Agreements
  • get /Agreements/{partner1Name}/{partner2Name}
  • 刪除 /Agreements/{agreementName}
  • get /Agreements/{agreementName}
  • put /Agreements/{agreementName}

應用程式

  • 取得 /Applications
  • post /Applications
  • 刪除 /Applications/{applicationName}
  • get /Applications/{applicationName}
  • put /Applications/{applicationName}
  • put /Applications/{applicationName}/Start
  • put /Applications/{applicationName}/Stop

批次

  • get /Batches/{senderParty}/{receiverParty}/{agreementName}
  • post /Batches/{senderParty}/{receiverParty}/{agreementName}
  • delete /Batches/{senderParty}/{receiverParty}/{agreementName}/{batchName}
  • get /Batches/{senderParty}/{receiverParty}/{agreementName}/{batchName}
  • put /Batches/{senderParty}/{receiverParty}/{agreementName}/{batchName}
  • put /Batches/{senderParty}/{receiverParty}/{agreementName}/{batchName}/{controlAction}
  • get /Batches/{senderParty}/{receiverParty}/{agreementName}/{batchName}/ActivationStatus

BusinessProfiles

  • get /BusinessProfiles/{partyName}
  • post /BusinessProfiles/{partyName}
  • 刪除 /BusinessProfiles/{partyName}/{profileName}
  • get /BusinessProfiles/{partyName}/{profileName}
  • put /BusinessProfiles/{partyName}/{profileName}
  • post /BusinessProfiles/Identities/{partyName}/{profileName}
  • 刪除 /BusinessProfiles/Identities/{partyName}/{profileName}/{id}
  • put /BusinessProfiles/Identities/{partyName}/{profileName}/{id}

FallbackSettings

  • get /FallbackSettings
  • put /FallbackSettings

群組

  • 取得 /Group/Properties
  • 取得 /Group/Settings
  • put /Group/Settings

HostInstances

  • get /HostInstances
  • get /HostInstances/Settings/{hostName}/{serverName}
  • put /HostInstances/Settings/{hostName}/{serverName}
  • put /HostInstances/{hostName}/{serverName}/Start
  • put /HostInstances/{hostName}/{serverName}/Stop

主控件

  • 取得 /Hosts
  • 取得 /Hosts/Settings/{hostName}
  • put /Hosts/Settings/{hostName}

OperationalData

  • 取得 /OperationalData/Instances
  • put /OperationalData/Instances/Terminate/{instanceId}
  • put /OperationalData/Instances/Resume/{instanceId}
  • put /OperationalData/Instances/Suspend/{instanceId}
  • 取得 /OperationalData/Messages
  • 取得 /OperationalData/Subscriptions
  • get /OperationalData/TrackedMessageEvents
  • get /OperationalData/TrackedServiceInstances
  • get /OperationalData/TransactionSets
  • get /OperationalData/TransactionSetAggregationReports
  • get /OperationalData/InterchangeStatusRecords
  • get /OperationalData/InterchangeAggregationRecords
  • get /OperationalData/AS2StatusRecords
  • 取得 /OperationalData/Batches
  • get /OperationalData/Batches/Status/{destinationPartyName}/{batchName}

協調流程

  • 取得 /Orchestrations
  • put /Orchestrations
  • get /Orchestrations/{applicationName}/{orchestrationName}
  • put /Orchestrations/{applicationName}/{orchestrationName}/Enlist
  • put /Orchestrations/{applicationName}/{orchestrationName}/Unenlist
  • put /Orchestrations/{applicationName}/{orchestrationName}/Start
  • put /Orchestrations/{applicationName}/{orchestrationName}/Stop

合作對象

  • get /Parties
  • post /Parties
  • delete /Party/{partyName}
  • get /Party/{partyName}
  • post /Party/{partyName}
  • put /Party/{partyName}
  • 刪除 /Party/{partyName}/{partyAliasName}
  • put /Party/{partyName}/{partyAliasName}

管線

  • 取得 /Pipelines
  • get /Pipelines/{pipelineName}
  • put /Pipelines/{pipelineName}

原則

  • 取得 /Policies
  • put /Policies/Deploy/{policyName}/{majorVersion}/{minorVersion}
  • put /Policies/Undeploy/{policyName}/{majorVersion}/{minorVersion}
  • put /Policies/AddToApplication/{applicationName}/{policyName}/{majorVersion}/{minorVersion}
  • put /Policies/RemoveFromApplication/{applicationName}/{policyName}/{majorVersion}/{minorVersion}

ProtocolTypes

  • get /ProtocolTypes

ReceiveLocations

  • get /ReceiveLocations
  • post /ReceiveLocations
  • delete /ReceiveLocations/{receivePortName}/{receiveLocationName}
  • get /ReceiveLocations/{receivePortName}/{receiveLocationName}
  • put /ReceiveLocations/{receiveLocationName}
  • put /ReceiveLocations/SetPrimary/{receivePortName}/{receiveLocationName}
  • put /ReceiveLocations/Enable/{receivePortName}/{receiveLocationName}
  • put /ReceiveLocations/Disable/{receivePortName}/{receiveLocationName}

ReceivePorts

  • get /ReceivePorts
  • post /ReceivePorts
  • delete /ReceivePorts/{receivePortName}
  • get /ReceivePorts/{receivePortName}
  • put /ReceivePorts/{receivePortName}

資源

  • 取得 /Resources
  • get /RoleLinks
  • get /RoleLinks/{applicationName}/{roleLinkName}
  • put /RoleLinks/AddEnlistedParties/{applicationName}/{roleLinkName}
  • put /RoleLinks/RemoveEnlistedParties/{applicationName}/{roleLinkName}

結構描述

  • get /Schemas
  • get /Schemas/{schemaName}
  • put /Schemas/{schemaName}

SendPortGroups

  • get /SendPortGroups
  • post /SendPortGroups
  • delete /SendPortGroups/{sendPortGroupName}
  • get /SendPortGroups/{sendPortGroupName}
  • put /SendPortGroups/{sendPortGroupName}
  • put /SendPortGroups/{sendPortGroupName}/Unenlist
  • put /SendPortGroups/{sendPortGroupName}/Start
  • put /SendPortGroups/{sendPortGroupName}/Stop
  • put /SendPortGroups/{sendPortGroupName}/Enlist

SendPorts

  • get /SendPorts
  • post /SendPorts
  • delete /SendPorts/{sendPortName}
  • get /SendPorts/{sendPortName}
  • put /SendPorts/{sendPortName}
  • put /SendPorts/{sendPortName}/Unenlist
  • put /SendPorts/{sendPortName}/Start
  • put /SendPorts/{sendPortName}/Stop
  • put /SendPorts/{sendPortName}/Enlist

轉換

  • get /Transforms
  • get /Transforms/{transformFullName}
  • put /Transforms/{transformFullName}