Informazioni di riferimento sulle API REST BizTalk Server 2020

  • Articolo

Usando REST, è possibile gestire i diversi artefatti negli ambienti di BizTalk Server. Questo riferimento api è incluso in BizTalk Server 2020.

Per i passaggi di configurazione, vedere Configurare le API REST.

Contratti

  • get /Agreement
  • post /Agreement
  • get /Agreement/{partner1Name}/{partner2Name}
  • delete /Agreement/{agreementName}
  • get /Agreement/{agreementName}
  • put /Agreement/{agreementName}

Applicazioni

  • get /Applications
  • post /Applications
  • delete /Applications/{applicationName}
  • get /Applications/{applicationName}
  • put /Applications/{applicationName}
  • put /Applications/{applicationName}/Start
  • put /Applications/{applicationName}/Stop

Batch

  • 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}
  • delete /BusinessProfiles/{partyName}/{profileName}
  • get /BusinessProfiles/{partyName}/{profileName}
  • put /BusinessProfiles/{partyName}/{profileName}
  • post /BusinessProfiles/Identities/{partyName}/{profileName}
  • delete /BusinessProfiles/Identities/{partyName}/{profileName}/{id}
  • put /BusinessProfiles/Identities/{partyName}/{profileName}/{id}

FallbackSettings

  • get /FallbackSettings
  • put /FallbackSettings

Gruppo

  • get /Group/Properties
  • get /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

Host

  • get /Hosts
  • get /Hosts/Settings/{hostName}
  • put /Hosts/Settings/{hostName}

OperationalData

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

Orchestrazioni

  • get /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

Entità

  • get /Party
  • post /Party
  • delete /Party/{partyName}
  • get /Party/{partyName}
  • post /Party/{partyName}
  • put /Party/{partyName}
  • delete /Party/{partyName}/{partyAliasName}
  • put /Party/{partyName}/{partyAliasName}

Pipeline

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

Criteri

  • get /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}

Risorse

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

Schemi

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

Gruppi porte trasmissione

  • 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

Trasformazioni

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