Compartir a través de

Referencia de la API REST de BizTalk Server 2020

Con REST, puede administrar los distintos artefactos en los entornos de BizTalk Server. Esta referencia de API se incluye con BizTalk Server 2020.

Para conocer los pasos de configuración, consulte Configuración de las API REST.

Contratos

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

Aplicaciones

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

Instancias de 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

Grupo

  • 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

Hosts

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

OperationalData

  • get /OperationalData/Instances
  • put /OperationalData/Instances/Terminate/{instanceId}
  • put /OperationalData/Instances/Resume/{instanceId}
  • put /OperationalData/Instances/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}

Orquestaciones

  • 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

Entidades

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

Canalizaciones

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

Directivas

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

Recursos

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

Esquemas

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

GruposPuertosEnvío

  • get /SendPortGroups
  • post /SendPortGroups
  • delete /SendPortGroups/{sendPortGroupName}
  • get /SendPortGroups/{sendPortGroupName}
  • put /SendPortGroups/{sendPortGroupName}
  • put /SendPortGroups/{sendPortGroupName}/Unlist
  • 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

Transformaciones

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