Agreements - Get Agreement

Service:

BizTalk Server 2020

API Version:

v1

Obtención del contrato por nombre

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
agreementName	path	True	string	Nombre del contrato.

Respuestas

Nombre	Tipo	Description
200 OK	Agreement	Aceptar Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definiciones

Nombre	Description
Agreement	Modelo para contrato
AgreementContent	Contenido del contrato.
AS2AcknowledgmentConnectionSettings	Modelo para AS2AcknowledgmentConnectionSettings
AS2AgreementContent	Modelo para la configuración del protocolo AS2 en un contrato
AS2EnvelopeSettings	Modelo para AS2EnvelopeSettings
AS2ErrorSettings	Modelo para AS2ErrorSettings
AS2MDNSettings	Modelo para AS2MDNSettings
AS2MessageConnectionSettings	Modelo para AS2MessageConnectionSettings
AS2OnewayAgreement	Modelo para el Contrato oneway de AS2
AS2ProtocolSettings	Modelo para la configuración del protocolo AS2 en un contrato
AS2SecuritySettings	Modelo para AS2SecuritySettings
AS2ValidationSettings	Modelo para AS2ValidationSettings
BatchDescription	Modelo para BatchDescription
Contact	Modelo para contacto
CustomSetting	Configuración personalizada de entidad
DailyRecurrence	Modelo para DailyRecurrence
EDIFACTAcknowledgmentSettings	Modelo para EDIFACTAcknowledgmentSettings
EDIFACTAgreementContent	Modelo para la configuración del protocolo EDIFACT en un contrato
EDIFACTEnvelopeOverrides	Modelo para EDIFACTEnvelopeOverride
EDIFACTEnvelopeSettings	Modelo para EDIFACTEnvelopeSettings
EDIFACTFramingSettings	Modelo para EDIFACTFramingSettings
EDIFACTMessageFilter	Modelo para EDIFACTMessageFilter
EDIFACTMessageIdentifier	Modelo para EDIFACTMessageIdentifier
EDIFACTOnewayAgreement	Modelo para el contrato oneway de EDIFACT
EDIFACTProcessingSettings	Modelo para EDIFACTProcessingSettings
EDIFACTProtocolSettings	Modelo para la configuración del protocolo EDIFACT en un contrato
EDIFACTSchemaOverrides	Modelo para EDIFACTSchemaReference
EDIFACTSchemaSettings	Modelo para EDIFACTSchemaSettings
EDIFACTValidationOverrides	Modelo para EDIFACTValidationOverride
EDIFACTValidationSettings	Modelo para EDIFACTValidationSettings
FilterGroup	Modelo para FilterGroup
FilterPredicate	Modelo para FilterGroup
FilterStatement	Modelo para FilterStatement
HourlyRecurrence	Modelo para HourlyRecurrence
InterchangeSizeReleaseCriteria	Modelo para InterchangeSizeReleaseCriteria
ManualReleaseCriteria	Modelo para ManualReleaseCriteria
MessageCountReleaseCriteria	Modelo para MessageCountReleaseCriteria
PartnerAgreementContext	Modelo para PartnerAgreementContext
QualifierIdentity	Modelo para QualifierIdentity
TimeBasedReleaseCriteria	Modelo para TimeBasedReleaseCriteria
WeeklyRecurrence	Modelo para WeeklyRecurrence
X12AcknowledgmentSettings	Modelo para X12AcknowledgmentSettings
X12AgreementContent	Modelo para la configuración del protocolo X12 en un contrato
X12EnvelopeOverrides	Modelo para X12EnvelopeOverride
X12EnvelopeSettings	Modelo para X12EnvelopeSettings
X12FramingSettings	Modelo para X12FramingSettings
X12MessageFilter	Modelo para X12MessageFilter
X12MessageIdentifier	Modelo para X12MessageIdentifier
X12OnewayAgreement	Modelo para el contrato X12 Oneway
X12ProcessingSettings	Modelo para X12ProcessingSettings
X12ProtocolSettings	Modelo para la configuración del protocolo X12 en un contrato
X12SchemaOverrides	Modelo para X12SchemaReference
X12SchemaSettings	Modelo para X12SchemaSettings
X12SecuritySettings	Modelo para X12SecuritySettings
X12ValidationOverrides	Modelo para X12ValidationOverride
X12ValidationSettings	Modelo para X12ValidationSettings

Agreement

Modelo para contrato

Nombre	Tipo	Description
AgreementContent	AgreementContent	Obtiene o establece el contenido del contrato.
Contacts	Contact[]	Obtiene o establece los contactos.
CustomSettings	CustomSetting[]	Obtiene o establece la configuración personalizada.
Description	string	Obtiene o establece la descripción.
Enabled	boolean	Obtiene o establece un valor que indica si está habilitado.
EndDate	string	Obtiene o establece la fecha final.
Id	integer	Obtiene o establece el identificador.
Name	string	Obtiene o establece el nombre.
Protocol	string	Obtiene o establece el protocolo.
ReceivePartner	PartnerAgreementContext	Obtiene o establece el asociado de recepción.
SendPartner	PartnerAgreementContext	Obtiene o establece el asociado de envío.
StartDate	string	Obtiene o establece la fecha de inicio.

AgreementContent

Contenido del contrato.

Nombre	Tipo	Description
AS2AgreementContent	AS2AgreementContent	Obtiene o establece el contenido del contrato AS2.
EDIFACTAgreementContent	EDIFACTAgreementContent	Obtiene o establece el contenido del contrato EDIFACT.
X12AgreementContent	X12AgreementContent	Obtiene o establece el contenido del contrato X12.

AS2AcknowledgmentConnectionSettings

Modelo para AS2AcknowledgmentConnectionSettings

Nombre	Tipo	Description
AckHttpExpect100Continue	boolean	Obtiene o establece un valor que indica si ack http espera que continúe 100.
AckIgnoreCertificateNameMismatch	boolean	Obtiene o establece un valor que indica si la ack omite la coincidencia del nombre del certificado.
AckKeepHttpConnectionAlive	boolean	Obtiene o establece un valor que indica si la confirmación mantiene activa la conexión HTTP.
AckUnfoldHttpHeaders	boolean	Obtiene o establece un valor que indica si ack desarrolla encabezados HTTP.

AS2AgreementContent

Modelo para la configuración del protocolo AS2 en un contrato

Nombre	Tipo	Description
ReceiveAgreement	AS2OnewayAgreement	Obtiene o establece el contrato de recepción.
SendAgreement	AS2OnewayAgreement	Obtiene o establece el contrato de envío.

AS2EnvelopeSettings

Modelo para AS2EnvelopeSettings

Nombre	Tipo	Description
AutogenerateFileName	boolean	Obtiene o establece un valor que indica si el nombre de archivo generado automáticamente.
FileNameTemplate	string	Obtiene o establece la plantilla de nombre de archivo.
MessageContentType	string	Obtiene o establece el tipo de contenido del mensaje.
SuspendMessageOnFileNameGenerationError	boolean	Obtiene o establece un valor que indica si se suspende el mensaje en el error de generación de nombres de archivo.
TransmitFileNameInMimeHeader	boolean	Obtiene o establece un valor que indica si transmite el nombre de archivo en el encabezado mime.

AS2ErrorSettings

Modelo para AS2ErrorSettings

Nombre	Tipo	Description
HttpRetryTimeout	string	Obtiene o establece el tiempo de espera de reintento http.
MaxResendAttempts	integer	Obtiene o establece el número máximo de intentos de reenvío.
MaximumHttpRetryAttempts	integer	Obtiene o establece el número máximo de intentos de reintento http.
MinimumHttpRetryInterval	string	Obtiene o establece el intervalo de reintento http mínimo.
MinimumResendInterval	string	Obtiene o establece el intervalo de reenvío mínimo.
OverrideSendPort	boolean	Obtiene o establece un valor que indica si invalida el puerto de envío.
ResendIfMDNNotReceived	boolean	Obtiene o establece un valor que indica si no se ha recibido mdn si no se ha recibido mdn.
ResendTimeout	string	Obtiene o establece el tiempo de espera de reenvío.
SuspendDuplicateMessage	boolean	Obtiene o establece un valor que indica si suspende el mensaje duplicado.

AS2MDNSettings

Modelo para AS2MDNSettings

Nombre	Tipo	Description
DispositionNotificationTo	string	Obtiene o establece la notificación de eliminación en .
MDNText	string	Obtiene o establece el texto mdn.
MicHashingAlgorithm	string	Obtiene o establece el algoritmo hash de micrófono.
NeedMDN	boolean	Obtiene o establece un valor que indica si se necesita mdn.
ProcessMDNtoMsgBox	boolean	Obtiene o establece un valor que indica si se va a procesar mdn en msg box.
ReceiptDeliveryUrl	string	Obtiene o establece la dirección URL de entrega de recibos.
SendMDNAsynchronously	boolean	Obtiene o establece un valor que indica si se va a enviar mdn de forma asincrónica.
SignMDN	boolean	Obtiene o establece un valor que indica si se va a firmar mdn.
SignOutboundMDNIfOptional	boolean	Obtiene o establece un valor que indica si el mdn de salida de cierre de sesión es opcional.

AS2MessageConnectionSettings

Modelo para AS2MessageConnectionSettings

Nombre	Tipo	Description
HttpExpect100ContinueSupported	boolean	Obtiene o establece un valor que indica si http espera que se siga admitiendo 100.
IgnoreCertificateNameMismatch	boolean	Obtiene o establece un valor que indica si no coinciden los nombres del certificado.
KeepHttpConnectionAlive	boolean	Obtiene o establece un valor que indica si mantiene activa la conexión http.
UnfoldHttpHeaders	boolean	Obtiene o establece un valor que indica si se desarrollan encabezados HTTP.

AS2OnewayAgreement

Modelo para el Contrato oneway de AS2

Nombre	Tipo	Description
BatchDescriptions	BatchDescription[]	Obtiene o establece las descripciones del lote.
Id	integer	Obtiene o establece el identificador.
ProtocolSettings	AS2ProtocolSettings	Obtiene o establece la configuración del protocolo.
ReceiveBusinessIdentity	QualifierIdentity	Obtiene o establece la identidad empresarial de recepción.
SendPortNames	string[]	Obtiene o establece las referencias de puerto de envío.
SenderBusinessIdentity	QualifierIdentity	Obtiene o establece la identidad empresarial del remitente.

AS2ProtocolSettings

Modelo para la configuración del protocolo AS2 en un contrato

Nombre	Tipo	Description
AcknowledgmentConnectionSettings	AS2AcknowledgmentConnectionSettings	Obtiene o establece la configuración de conexión de confirmación.
EnvelopeSettings	AS2EnvelopeSettings	Obtiene o establece la configuración del sobre.
ErrorSettings	AS2ErrorSettings	Obtiene o establece la configuración de error.
Id	integer	Obtiene o establece el identificador.
MDNSettings	AS2MDNSettings	Obtiene o establece la configuración de mdn.
MessageConnectionSettings	AS2MessageConnectionSettings	Obtiene o establece la configuración de conexión del mensaje.
ProtocolName	string	Obtiene o establece el nombre del protocolo.
SecuritySettings	AS2SecuritySettings	Obtiene o establece la configuración de seguridad.
SettingsName	string	Obtiene o establece el nombre de la configuración.
ValidationSettings	AS2ValidationSettings	Obtiene o establece la configuración de validación.

AS2SecuritySettings

Modelo para AS2SecuritySettings

Nombre	Tipo	Description
EnableNRRForInboundDecodedMessages	boolean	Obtiene o establece un valor que indica si habilite nrr para los mensajes descodificados entrantes.
EnableNRRForInboundEncodedMessages	boolean	Obtiene o establece un valor que indica si habilite nrr para los mensajes codificados entrantes.
EnableNRRForInboundMDN	boolean	Obtiene o establece un valor que indica si habilite nrr para el mdn entrante.
EnableNRRForOutboundDecodedMessages	boolean	Obtiene o establece un valor que indica si habilite nrr para los mensajes descodificados salientes.
EnableNRRForOutboundEncodedMessages	boolean	Obtiene o establece un valor que indica si habilite nrr para los mensajes codificados de salida.
EnableNRRForOutboundMDN	boolean	Obtiene o establece un valor que indica si habilite nrr para el mdn saliente.
OverrideGroupSigningCertificate	boolean	Obtiene o establece un valor que indica si invalida el certificado de firma de grupo.
SigningCertificateName	string	Obtiene o establece el nombre del certificado de firma.
SigningCertificateThumbprint	string	Obtiene o establece la huella digital del certificado de firma.

AS2ValidationSettings

Modelo para AS2ValidationSettings

Nombre	Tipo	Description
CheckCertificateRevocationListOnReceive	boolean	Obtiene o establece un valor que indica si comprueba la lista de revocación de certificados al recibir.
CheckCertificateRevocationListOnSend	boolean	Obtiene o establece un valor que indica si comprueba la lista de revocación de certificados al enviar.
CheckDuplicateMessage	boolean	Obtiene o establece un valor que indica si se comprueba el mensaje duplicado.
EncryptionAlgorithm	string	Obtiene o establece el algoritmo de cifrado.
InterchangeDuplicatesValidity	integer	Obtiene o establece la validez de los duplicados del intercambio.
MessageCompressed	boolean	Obtiene o establece un valor que indica si el mensaje está comprimido.
MessageEncrypted	boolean	Obtiene o establece un valor que indica si el mensaje está cifrado.
MessageSigned	boolean	Obtiene o establece un valor que indica si el mensaje está firmado.
OverrideMessageProperties	boolean	Obtiene o establece un valor que indica si se van a invalidar las propiedades del mensaje.

BatchDescription

Modelo para BatchDescription

Nombre	Tipo	Description
Description	string	Obtiene o establece la descripción.
EndDate	string	Obtiene o establece la fecha final.
Filter	FilterPredicate	Obtiene o establece el predicado de filtro.
Id	integer	Obtiene o establece el identificador.
InterchangeSizeRelease	InterchangeSizeReleaseCriteria	Obtiene o establece los criterios de versión de tamaño de intercambio.
ManualRelease	ManualReleaseCriteria	Obtiene o establece los criterios de versión manual.
MessageCountRelease	MessageCountReleaseCriteria	Obtiene o establece los criterios de versión del recuento de mensajes.
Name	string	Obtiene o establece el nombre.
Protocol	string	Obtiene o establece el protocolo.
StartDate	string	Obtiene o establece la fecha de inicio.
TerminationCount	integer	Obtiene o establece el recuento de terminación.
TimeBasedRelease	TimeBasedReleaseCriteria	Obtiene o establece los criterios de versión basados en tiempo.

Contact

Modelo para contacto

Nombre	Tipo	Description
Address	string	Obtiene o establece la dirección.
BusinessPhone	string	Obtiene o establece el teléfono de la empresa.
Company	string	Obtiene o establece la empresa.
Email	string	Obtiene o establece el correo electrónico.
Fax	string	Obtiene o establece el fax.
Id	integer	Obtiene o establece el identificador.
JobTitle	string	Obtiene o establece el título del trabajo.
MobilePhone	string	Obtiene o establece el teléfono móvil.
Name	string	Obtiene o establece el nombre.
Notes	string	Obtiene o establece las notas.
WebAddress	string	Obtiene o establece la dirección web.

CustomSetting

Configuración personalizada de entidad

Nombre	Tipo	Description
Name	string	Nombre de la opción de configuración
Value	string	Valor del valor

DailyRecurrence

Modelo para DailyRecurrence

Nombre	Tipo	Description
Days	integer	Obtiene o establece los días.
RecurrencePeriod	string	Obtiene o establece el período de periodicidad.

EDIFACTAcknowledgmentSettings

Modelo para EDIFACTAcknowledgmentSettings

Nombre	Tipo	Description
AcknowledgmentControlNumberLowerBound	integer	Obtiene o establece el límite inferior del número de control De confirmación.
AcknowledgmentControlNumberPrefix	string	Obtiene o establece el prefijo de número de control De confirmación.
AcknowledgmentControlNumberRollover	boolean	Obtiene o establece un valor que indica si se va a revertir el número de control de confirmación.
AcknowledgmentControlNumberSuffix	string	Obtiene o establece el sufijo de número de control de confirmación.
AcknowledgmentControlNumberUpperBound	integer	Obtiene o establece el límite superior del número de control de confirmación.
BatchFunctionalAcknowledgments	boolean	Obtiene o establece un valor que indica si se van a procesar confirmaciones funcionales por lotes.
BatchTechnicalAcknowledgments	boolean	Obtiene o establece un valor que indica si se va a procesar por lotes las confirmaciones técnicas.
NeedFunctionalAcknowledgment	boolean	Obtiene o establece un valor que indica si se necesita confirmación funcional.
NeedLoopForValidMessages	boolean	Obtiene o establece un valor que indica si se necesita un bucle para los mensajes válidos.
NeedTechnicalAcknowledgment	boolean	Obtiene o establece un valor que indica si se necesita confirmación técnica.
SendSynchronousAcknowledgment	boolean	Obtiene o establece un valor que indica si se va a enviar confirmación sincrónica.

EDIFACTAgreementContent

Modelo para la configuración del protocolo EDIFACT en un contrato

Nombre	Tipo	Description
ReceiveAgreement	EDIFACTOnewayAgreement	Obtiene o establece el contrato de recepción.
SendAgreement	EDIFACTOnewayAgreement	Obtiene o establece el contrato de envío.

EDIFACTEnvelopeOverrides

Modelo para EDIFACTEnvelopeOverride

Nombre	Tipo	Description
ApplicationPassword	string	Obtiene o establece la contraseña de la aplicación.
AssociationAssignedCode	string	Obtiene o establece el código asignado a la asociación.
ControllingAgencyCode	string	Obtiene o establece el código de agencia de control.
FunctionalGroupId	string	Obtiene o establece el identificador de grupo funcional.
GroupHeaderMessageRelease	string	Obtiene o establece la versión del mensaje de encabezado de grupo.
GroupHeaderMessageVersion	string	Obtiene o establece la versión del mensaje de encabezado de grupo.
MessageAssociationAssignedCode	string	Obtiene o establece el código asignado a la asociación de mensajes.
MessageId	string	Obtiene o establece el identificador de mensaje en el que se debe aplicar esta configuración de sobre.
MessageRelease	string	Obtiene o establece la versión de lanzamiento del mensaje en la que se debe aplicar esta configuración de sobre.
MessageVersion	string	Obtiene o establece la versión del mensaje en la que se debe aplicar esta configuración de sobre.
ReceiverApplicationId	string	Obtiene o establece el identificador de la aplicación receptora.
ReceiverApplicationQualifier	string	Obtiene o establece el calificador de aplicación receptora.
SenderApplicationId	string	Obtiene o establece el identificador de aplicación del remitente.
SenderApplicationQualifier	string	Obtiene o establece el calificador de aplicación remitente.
TargetNamespace	string	Obtiene o establece el espacio de nombres de destino en el que se debe aplicar esta configuración de sobre.

EDIFACTEnvelopeSettings

Modelo para EDIFACTEnvelopeSettings

Nombre	Tipo	Description
ApplicationReferenceId	string	Obtiene o establece el identificador de referencia de la aplicación.
ApplyDelimiterStringAdvice	boolean	Obtiene o establece un valor que indica si se aplican consejos de cadena de delimitador.
CommunicationAgreementId	string	Obtiene o establece el identificador del contrato de comunicación.
CreateGroupingSegments	boolean	Obtiene o establece un valor que indica si se crean segmentos de agrupación.
EnableDefaultGroupHeaders	boolean	Obtiene o establece un valor que indica si se van a habilitar los encabezados de grupo predeterminados.
EnvelopeOverrides	EDIFACTEnvelopeOverrides[]	Obtiene o establece las invalidaciones de sobre.
FunctionalGroupId	string	Obtiene o establece el identificador de grupo funcional.
GroupApplicationPassword	string	Obtiene o establece la contraseña de la aplicación de grupo.
GroupApplicationReceiverId	string	Obtiene o establece el identificador del receptor de la aplicación de grupo.
GroupApplicationReceiverQualifier	string	Obtiene o establece el calificador del receptor de la aplicación de grupo.
GroupApplicationSenderId	string	Obtiene o establece el identificador del remitente de la aplicación de grupo.
GroupApplicationSenderQualifier	string	Obtiene o establece el calificador del remitente de la aplicación de grupo.
GroupAssociationAssignedCode	string	Obtiene o establece el código asignado a la asociación de grupo.
GroupControlNumberLowerBound	integer	Obtiene o establece el número de control de grupo límite inferior.
GroupControlNumberPrefix	string	Obtiene o establece el prefijo de número de control de grupo.
GroupControlNumberRollover	boolean	Obtiene o establece un valor que indica si se va a revertir el número de control del grupo.
GroupControlNumberSuffix	string	Obtiene o establece el sufijo de número de control de grupo.
GroupControlNumberUpperBound	integer	Obtiene o establece el límite superior del número de control de grupo.
GroupControllingAgencyCode	string	Obtiene o establece el código de agencia de control de grupo.
GroupMessageRelease	string	Obtiene o establece la versión del mensaje de grupo.
GroupMessageVersion	string	Obtiene o establece la versión del mensaje de grupo.
InterchangeControlNumberLowerBound	integer	Obtiene o establece el número de control de intercambio límite inferior.
InterchangeControlNumberPrefix	string	Obtiene o establece el prefijo del número de control de intercambio.
InterchangeControlNumberRollover	boolean	Obtiene o establece un valor que indica si se va a revertir el número de control de intercambio.
InterchangeControlNumberSuffix	string	Obtiene o establece el sufijo de número de control de intercambio.
InterchangeControlNumberUpperBound	integer	Obtiene o establece el límite superior del número de control de intercambio.
IsTestInterchange	boolean	Obtiene o establece un valor que indica si se trata de un intercambio de prueba.
OverwriteExistingTransactionSetControlNumber	boolean	Obtiene o establece un valor que indica si se va a sobrescribir el número de control del conjunto de transacciones existente.
ProcessingPriorityCode	string	Obtiene o establece el código de prioridad de procesamiento.
ReceiverInternalIdentification	string	Obtiene o establece la identificación interna del receptor.
ReceiverInternalSubIdentification	string	Obtiene o establece la subidentificación interna del receptor.
ReceiverReverseRoutingAddress	string	Obtiene o establece la dirección de enrutamiento inverso del receptor.
RecipientReferencePasswordQualifier	string	Obtiene o establece el calificador de contraseña de referencia del destinatario.
RecipientReferencePasswordValue	string	Obtiene o establece el valor de contraseña de referencia del destinatario.
SenderInternalIdentification	string	Obtiene o establece la identificación interna del remitente.
SenderInternalSubIdentification	string	Obtiene o establece la subidentificación interna del remitente.
SenderReverseRoutingAddress	string	Obtiene o establece la dirección de enrutamiento inverso del remitente.
TransactionSetControlNumberLowerBound	integer	Obtiene o establece el número de control del conjunto de transacciones límite inferior.
TransactionSetControlNumberPrefix	string	Obtiene o establece el prefijo del número de control del conjunto de transacciones.
TransactionSetControlNumberRollover	boolean	Obtiene o establece un valor que indica si se va a revertir el número de control del conjunto de transacciones.
TransactionSetControlNumberSuffix	string	Obtiene o establece el sufijo de número de control del conjunto de transacciones.
TransactionSetControlNumberUpperBound	integer	Obtiene o establece el límite superior del número de control del conjunto de transacciones.

EDIFACTFramingSettings

Modelo para EDIFACTFramingSettings

Nombre	Tipo	Description
CharacterEncoding	string	Obtiene o establece la codificación de caracteres.
CharacterSet	string	Obtiene o establece el juego de caracteres EDIFACT.
ComponentSeparator	integer	Obtiene o establece el separador de componentes.
DataElementSeparator	integer	Obtiene o establece el separador de elementos de datos.
DecimalPointIndicator	string	Obtiene o establece el indicador de separador decimal.
ProtocolVersion	integer	Obtiene o establece la versión del protocolo.
ReleaseIndicator	integer	Obtiene o establece el indicador de versión.
RepetitionSeparator	integer	Obtiene o establece el separador de repetición.
SegmentTerminator	integer	Obtiene o establece el terminador de segmento.
SegmentTerminatorSuffix	string	Obtiene o establece el sufijo del terminador de segmento.
ServiceCodeListDirectoryVersion	string	Obtiene o establece la versión del directorio de lista de códigos de servicio.

EDIFACTMessageFilter

Modelo para EDIFACTMessageFilter

Nombre	Tipo	Description
FilterMessages	EDIFACTMessageIdentifier[]	Obtiene o establece los mensajes de filtro.
MessageFilterType	string	Obtiene o establece el tipo de filtro de mensaje.

EDIFACTMessageIdentifier

Modelo para EDIFACTMessageIdentifier

Nombre	Tipo	Description
MessageId	string	Obtiene o establece el identificador del mensaje.

EDIFACTOnewayAgreement

Modelo para el contrato oneway de EDIFACT

Nombre	Tipo	Description
BatchDescriptions	BatchDescription[]	Obtiene o establece las descripciones del lote.
Id	integer	Obtiene o establece el identificador.
ProtocolSettings	EDIFACTProtocolSettings	Obtiene o establece la configuración del protocolo.
ReceiveBusinessIdentity	QualifierIdentity	Obtiene o establece la identidad empresarial de recepción.
SendPortNames	string[]	Obtiene o establece las referencias de puerto de envío.
SenderBusinessIdentity	QualifierIdentity	Obtiene o establece la identidad empresarial del remitente.

EDIFACTProcessingSettings

Modelo para EDIFACTProcessingSettings

Nombre	Tipo	Description
CreateEmptyXmlTagsForTrailingSeparators	boolean	Obtiene o establece un valor que indica si se deben crear etiquetas xml vacías para separadores finales.
MaskSecurityInfo	boolean	Obtiene o establece un valor que indica si se va a enmascarar la información de seguridad.
PreserveInterchange	boolean	Obtiene o establece un valor que indica si se debe conservar el intercambio.
SuspendInterchangeOnError	boolean	Obtiene o establece un valor que indica si se debe suspender el intercambio en caso de error.
UseDotAsDecimalSeparator	boolean	Obtiene o establece un valor que indica si se va a usar el punto como separador decimal.

EDIFACTProtocolSettings

Modelo para la configuración del protocolo EDIFACT en un contrato

Nombre	Tipo	Description
AcknowledgmentSettings	EDIFACTAcknowledgmentSettings	Obtiene o establece la configuración de confirmación.
EnvelopeSettings	EDIFACTEnvelopeSettings	Obtiene o establece la configuración del sobre.
FramingSettings	EDIFACTFramingSettings	Obtiene o establece la configuración de trama.
Id	integer	Obtiene o establece el identificador.
IsTestInterchange	boolean	Obtiene o establece un valor que indica si se trata de un intercambio de prueba.
MessageFilter	EDIFACTMessageFilter	Obtiene o establece el filtro de mensajes.
ProcessingSettings	EDIFACTProcessingSettings	Obtiene o establece la configuración de procesamiento.
ProtocolName	string	Obtiene o establece el nombre del protocolo.
SchemaSettings	EDIFACTSchemaSettings	Obtiene o establece la configuración de procesamiento.
SettingsName	string	Obtiene o establece el nombre de la configuración.
ValidationSettings	EDIFACTValidationSettings	Obtiene o establece la configuración de validación.

EDIFACTSchemaOverrides

Modelo para EDIFACTSchemaReference

Nombre	Tipo	Description
ApplicationSenderID	string	Obtiene o establece el identificador del remitente de la aplicación.
ApplicationSenderQualifier	string	Obtiene o establece el calificador del remitente de la aplicación.
AssociationAssignedCode	string	Obtiene o establece el código asignado a la asociación.
MessageId	string	Obtiene o establece el identificador del mensaje.
MessageRelease	string	Obtiene o establece el identificador del mensaje.
MessageVersion	string	Obtiene o establece el identificador del mensaje.
TargetNamespace	string	Obtiene o establece el espacio de nombres de destino.

EDIFACTSchemaSettings

Modelo para EDIFACTSchemaSettings

Nombre	Tipo	Description
SchemaOverrides	EDIFACTSchemaOverrides[]	Obtiene o establece las invalidaciones de esquema.
TargetNamespace	string	Obtiene o establece el espacio de nombres de destino.

EDIFACTValidationOverrides

Modelo para EDIFACTValidationOverride

Nombre	Tipo	Description
AllowLeadingAndTrailingSpacesAndZeroes	boolean	Obtiene o establece un valor que indica si se permiten espacios iniciales y finales y ceros.
EnforceCharacterSet	boolean	Obtiene o establece un valor que indica si se debe aplicar el juego de caracteres.
InternalTrailingSeparatorPolicy	integer	Obtiene o establece la directiva de separador final interno.
MessageId	string	Obtiene o establece el identificador de mensaje en el que se debe aplicar la configuración de validación.
TrailingSeparatorPolicy	string	Obtiene o establece la directiva de separador final.
TrimLeadingAndTrailingSpacesAndZeroes	boolean	Obtiene o establece un valor que indica si se deben recortar los espacios iniciales y finales y los ceros.
ValidateEDITypes	boolean	Obtiene o establece un valor que indica si se van a validar los tipos EDI.
ValidateXSDTypes	boolean	Obtiene o establece un valor que indica si se van a validar los tipos XSD.

EDIFACTValidationSettings

Modelo para EDIFACTValidationSettings

Nombre	Tipo	Description
AllowLeadingAndTrailingSpacesAndZeroes	boolean	Obtiene o establece un valor que indica si se permiten espacios iniciales y finales y ceros.
CheckDuplicateGroupControlNumber	boolean	Obtiene o establece un valor que indica si se debe comprobar si hay un número de control de grupo duplicado.
CheckDuplicateInterchangeControlNumber	boolean	Obtiene o establece un valor que indica si se debe comprobar si hay un número de control de intercambio duplicado.
CheckDuplicateTransactionSetControlNumber	boolean	Obtiene o establece un valor que indica si se debe comprobar si hay un número de control de conjunto de transacciones duplicado.
InterchangeControlNumberValidityPeriod	integer	Obtiene o establece el período de validez del número de control de intercambio.
TrailingSeparatorPolicy	string	Obtiene o establece la directiva de separador final.
TrimLeadingAndTrailingSpacesAndZeroes	boolean	Obtiene o establece un valor que indica si se deben recortar espacios iniciales y finales y ceros.
ValidateCharacterSet	boolean	Obtiene o establece un valor que indica si se va a validar el juego de caracteres en el mensaje.
ValidateEDITypes	boolean	Obtiene o establece un valor que indica si se van a validar tipos EDI.
ValidateXSDTypes	boolean	Obtiene o establece un valor que indica si se van a validar tipos XSD.
ValidationOverrides	EDIFACTValidationOverrides[]	Obtiene o establece las invalidaciones de esquema.

FilterGroup

Modelo para FilterGroup

Nombre	Tipo	Description
Statements	FilterStatement[]	Obtiene o establece las instrucciones .

FilterPredicate

Modelo para FilterGroup

Nombre	Tipo	Description
Groups	FilterGroup[]	Obtiene o establece los grupos.

FilterStatement

Modelo para FilterStatement

Nombre	Tipo	Description
Operator	string	Obtiene o establece el operador.
Property	string	Obtiene o establece la propiedad .
Value	string	Obtiene o establece el valor.

HourlyRecurrence

Modelo para HourlyRecurrence

Nombre	Tipo	Description
Hours	integer	Obtiene o establece las horas.
Minutes	integer	Obtiene o establece los minutos.
RecurrencePeriod	string	Obtiene o establece el período de periodicidad.

InterchangeSizeReleaseCriteria

Modelo para InterchangeSizeReleaseCriteria

Nombre	Tipo	Description
CharacterCount	integer	Obtiene o establece el recuento de caracteres.

ManualReleaseCriteria

Modelo para ManualReleaseCriteria

MessageCountReleaseCriteria

Modelo para MessageCountReleaseCriteria

Nombre	Tipo	Description
MessageCount	integer	Obtiene o establece el recuento de mensajes.
MessageScope	string	Obtiene o establece el ámbito del mensaje.

PartnerAgreementContext

Modelo para PartnerAgreementContext

Nombre	Tipo	Description
PartnerName	string	Obtiene o establece el asociado.
ProfileName	string	Obtiene o establece el perfil.

QualifierIdentity

Modelo para QualifierIdentity

Nombre	Tipo	Description
Description	string	Obtiene o establece la descripción.
Id	integer	Obtiene o establece el identificador.
Qualifier	string	Obtiene o establece el calificador.
Value	string	Obtiene o establece el valor.

TimeBasedReleaseCriteria

Modelo para TimeBasedReleaseCriteria

Nombre	Tipo	Description
DailyRecurrence	DailyRecurrence	Obtiene o establece la programación de periodicidad.
FirstRelease	string	Obtiene o establece la primera fecha y hora de lanzamiento.
HourlyRecurrence	HourlyRecurrence	Obtiene o establece la programación de periodicidad.
SendEmptyBatchSignal	boolean	Obtiene o establece un valor que indica si se envía una señal por lotes vacía.
WeeklyRecurrence	WeeklyRecurrence	Obtiene o establece la programación de periodicidad.

WeeklyRecurrence

Modelo para WeeklyRecurrence

Nombre	Tipo	Description
RecurrencePeriod	string	Obtiene o establece el período de periodicidad.
WeekDays	string	Obtiene o establece los días de la semana.

X12AcknowledgmentSettings

Modelo para X12AcknowledgmentSettings

Nombre	Tipo	Description
AcknowledgmentControlNumberLowerBound	integer	Obtiene o establece el límite inferior del número de control De confirmación.
AcknowledgmentControlNumberPrefix	string	Obtiene o establece el prefijo de número de control De confirmación.
AcknowledgmentControlNumberRollover	boolean	Obtiene o establece un valor que indica si se va a revertir el número de control de confirmación.
AcknowledgmentControlNumberSuffix	string	Obtiene o establece el sufijo de número de control de confirmación.
AcknowledgmentControlNumberUpperBound	integer	Obtiene o establece el límite superior del número de control de confirmación.
BatchFunctionalAcknowledgments	boolean	Obtiene o establece un valor que indica si se van a procesar confirmaciones funcionales por lotes.
BatchImplementationAcknowledgments	boolean	Obtiene o establece un valor que indica si se van a procesar confirmaciones de implementación por lotes.
BatchTechnicalAcknowledgments	boolean	Obtiene o establece un valor que indica si se va a procesar por lotes las confirmaciones técnicas.
FunctionalAcknowledgmentVersion	string	Obtiene o establece la versión de confirmación funcional.
GeneratePatAK901	boolean	Obtiene o establece un valor que indica si genera pat a k 901.
ImplementationAcknowledgmentVersion	string	Obtiene o establece la versión de confirmación de implementación.
NeedFunctionalAcknowledgment	boolean	Obtiene o establece un valor que indica si se necesita confirmación funcional.
NeedImplementationAcknowledgment	boolean	Obtiene o establece un valor que indica si se necesita confirmación de implementación.
NeedLoopForValidMessages	boolean	Obtiene o establece un valor que indica si se necesita un bucle para los mensajes válidos.
NeedTechnicalAcknowledgment	boolean	Obtiene o establece un valor que indica si se necesita confirmación técnica.
SendSynchronousAcknowledgment	boolean	Obtiene o establece un valor que indica si se va a enviar confirmación sincrónica.

X12AgreementContent

Modelo para la configuración del protocolo X12 en un contrato

Nombre	Tipo	Description
ReceiveAgreement	X12OnewayAgreement	Obtiene o establece el contrato de recepción.
SendAgreement	X12OnewayAgreement	Obtiene o establece el contrato de envío.

X12EnvelopeOverrides

Modelo para X12EnvelopeOverride

Nombre	Tipo	Description
DateFormat	string	Obtiene o establece el formato de fecha.
FunctionalIdentifierCode	string	Obtiene o establece el código de identificador funcional.
HeaderVersion	string	Obtiene o establece la versión del encabezado.
MessageId	string	Obtiene o establece el identificador de mensaje en el que se debe aplicar esta configuración de sobre.
ProtocolVersion	string	Obtiene o establece la versión del protocolo en la que se debe aplicar esta configuración de sobre.
ReceiverApplicationId	string	Obtiene o establece el identificador de la aplicación receptora.
ResponsibleAgencyCode	string	Obtiene o establece el código de agencia responsable.
SenderApplicationId	string	Obtiene o establece el identificador de aplicación del remitente.
TargetNamespace	string	Obtiene o establece el espacio de nombres de destino en el que se debe aplicar esta configuración de sobre.
TargetNamespaceString	string	Obtiene o establece la cadena de espacio de nombres de destino en la que se debe aplicar esta configuración de sobre.
TimeFormat	string	Obtiene o establece el formato de hora.

X12EnvelopeSettings

Modelo para X12EnvelopeSettings

Nombre	Tipo	Description
ControlStandardsId	integer	Obtiene o establece el identificador de estándares de los controles.
ControlVersionNumber	string	Obtiene o establece el número de versión del control.
EnableDefaultGroupHeaders	boolean	Obtiene o establece un valor que indica si se van a habilitar los encabezados de grupo predeterminados.
EnvelopeOverrides	X12EnvelopeOverrides[]	Obtiene o establece las invalidaciones de sobre.
FunctionalGroupId	string	Obtiene o establece el identificador de grupo funcional.
GroupControlNumberLowerBound	integer	Obtiene o establece el número de control de grupo límite inferior.
GroupControlNumberRollover	boolean	Obtiene o establece un valor que indica si se va a revertir el número de control del grupo.
GroupControlNumberUpperBound	integer	Obtiene o establece el límite superior del número de control de grupo.
GroupHeaderAgencyCode	string	Obtiene o establece el código de agencia de encabezado de grupo.
GroupHeaderDateFormat	string	Obtiene o establece el formato de fecha del encabezado de grupo.
GroupHeaderTimeFormat	string	Obtiene o establece el formato de hora del encabezado de grupo.
GroupHeaderVersion	string	Obtiene o establece la versión del encabezado de grupo.
InterchangeControlNumberLowerBound	integer	Obtiene o establece el número de control de intercambio límite inferior.
InterchangeControlNumberRollover	boolean	Obtiene o establece un valor que indica si se va a revertir el número de control de intercambio.
InterchangeControlNumberUpperBound	integer	Obtiene o establece el límite superior del número de control de intercambio.
OverwriteExistingTransactionSetControlNumber	boolean	Obtiene o establece un valor que indica si se va a sobrescribir el número de control del conjunto de transacciones existente.
ReceiverApplicationId	string	Obtiene o establece el identificador de la aplicación receptora.
SenderApplicationId	string	Obtiene o establece el identificador de aplicación del remitente.
TransactionSetControlNumberLowerBound	integer	Obtiene o establece el número de control del conjunto de transacciones límite inferior.
TransactionSetControlNumberPrefix	string	Obtiene o establece el prefijo del número de control del conjunto de transacciones.
TransactionSetControlNumberRollover	boolean	Obtiene o establece un valor que indica si se va a revertir el número de control del conjunto de transacciones.
TransactionSetControlNumberSuffix	string	Obtiene o establece el sufijo de número de control del conjunto de transacciones.
TransactionSetControlNumberUpperBound	integer	Obtiene o establece el límite superior del número de control del conjunto de transacciones.
UsageIndicator	string	Obtiene o establece el indicador de uso.
UseControlStandardsIdAsRepetitionCharacter	boolean	Obtiene o establece un valor que indica si se debe usar el identificador de estándares de control como carácter de repetición.

X12FramingSettings

Modelo para X12FramingSettings

Nombre	Tipo	Description
CharacterSet	string	Obtiene o establece el juego de caracteres X12.
ComponentSeparator	integer	Obtiene o establece el separador de componentes.
DataElementSeparator	integer	Obtiene o establece el separador de elementos de datos.
ReplaceCharacter	integer	Obtiene o establece el carácter de reemplazo.
ReplaceSeparatorsInPayload	boolean	Obtiene o establece un valor que indica si se van a reemplazar separadores en la carga útil.
SegmentTerminator	integer	Obtiene o establece el terminador de segmento.
SegmentTerminatorSuffix	string	Obtiene o establece el sufijo del terminador de segmento.

X12MessageFilter

Modelo para X12MessageFilter

Nombre	Tipo	Description
FilterMessages	X12MessageIdentifier[]	Obtiene o establece los mensajes de filtro.
MessageFilterType	string	Obtiene o establece el tipo de filtro de mensaje.

X12MessageIdentifier

Modelo para X12MessageIdentifier

Nombre	Tipo	Description
MessageId	string	Obtiene o establece el identificador del mensaje.

X12OnewayAgreement

Modelo para el contrato X12 Oneway

Nombre	Tipo	Description
BatchDescriptions	BatchDescription[]	Obtiene o establece las descripciones del lote.
Id	integer	Obtiene o establece el identificador.
ProtocolSettings	X12ProtocolSettings	Obtiene o establece la configuración del protocolo.
ReceiveBusinessIdentity	QualifierIdentity	Obtiene o establece la identidad empresarial de recepción.
SendPortNames	string[]	Obtiene o establece las referencias de puerto de envío.
SenderBusinessIdentity	QualifierIdentity	Obtiene o establece la identidad empresarial del remitente.

X12ProcessingSettings

Modelo para X12ProcessingSettings

Nombre	Tipo	Description
ConvertImpliedDecimal	boolean	Obtiene o establece un valor que indica si se va a convertir el tipo numérico en decimal implícito.
CreateEmptyXmlTagsForTrailingSeparators	boolean	Obtiene o establece un valor que indica si se deben crear etiquetas xml vacías para separadores finales.
MaskSecurityInfo	boolean	Obtiene o establece un valor que indica si se va a enmascarar la información de seguridad.
PreserveInterchange	boolean	Obtiene o establece un valor que indica si se debe conservar el intercambio.
SuspendInterchangeOnError	boolean	Obtiene o establece un valor que indica si se debe suspender el intercambio en caso de error.

X12ProtocolSettings

Modelo para la configuración del protocolo X12 en un contrato

Nombre	Tipo	Description
AcknowledgmentSettings	X12AcknowledgmentSettings	Obtiene o establece la configuración de confirmación.
EnvelopeSettings	X12EnvelopeSettings	Obtiene o establece la configuración del sobre.
FramingSettings	X12FramingSettings	Obtiene o establece la configuración de trama.
Id	integer	Obtiene o establece el identificador.
MessageFilter	X12MessageFilter	Obtiene o establece el filtro de mensajes.
ProcessingSettings	X12ProcessingSettings	Obtiene o establece la configuración de procesamiento.
ProtocolName	string	Obtiene o establece el nombre del protocolo.
SchemaSettings	X12SchemaSettings	Obtiene o establece la configuración del esquema.
SecuritySettings	X12SecuritySettings	Obtiene o establece la configuración de seguridad.
SettingsName	string	Obtiene o establece el nombre de la configuración.
ValidationSettings	X12ValidationSettings	Obtiene o establece la configuración de validación.

X12SchemaOverrides

Modelo para X12SchemaReference

Nombre	Tipo	Description
MessageId	string	Obtiene o establece el identificador del mensaje.
SenderApplicationId	string	Obtiene o establece el identificador de aplicación del remitente.
TargetNamespace	string	Obtiene o establece el espacio de nombres de destino.

X12SchemaSettings

Modelo para X12SchemaSettings

Nombre	Tipo	Description
SchemaOverrides	X12SchemaOverrides[]	Obtiene o establece las invalidaciones de esquema.
TargetNamespace	string	Obtiene o establece el identificador del mensaje.

X12SecuritySettings

Modelo para X12SecuritySettings

Nombre	Tipo	Description
AuthorizationQualifier	string	Obtiene o establece el calificador de autorización.
AuthorizationValue	string	Obtiene o establece el valor de autorización.
PasswordValue	string	Obtiene o establece el valor de la contraseña.
SecurityQualifier	string	Obtiene o establece el calificador de seguridad.

X12ValidationOverrides

Modelo para X12ValidationOverride

Nombre	Tipo	Description
AllowLeadingAndTrailingSpacesAndZeroes	boolean	Obtiene o establece un valor que indica si se permiten espacios iniciales y finales y ceros.
MessageId	string	Obtiene o establece el identificador de mensaje en el que se debe aplicar la configuración de validación.
TrailingSeparatorPolicy	string	Obtiene o establece la directiva de separador final.
TrimLeadingAndTrailingSpacesAndZeroes	boolean	Obtiene o establece un valor que indica si se deben recortar espacios iniciales y finales y ceros.
ValidateCharacterSet	boolean	Obtiene o establece un valor que indica si se va a validar el juego de caracteres.
ValidateEDITypes	boolean	Obtiene o establece un valor que indica si se van a validar tipos EDI.
ValidateXSDTypes	boolean	Obtiene o establece un valor que indica si se van a validar tipos XSD.

X12ValidationSettings

Modelo para X12ValidationSettings

Nombre	Tipo	Description
AllowLeadingAndTrailingSpacesAndZeroes	boolean	Obtiene o establece un valor que indica si se permiten espacios iniciales y finales y ceros.
CheckDuplicateGroupControlNumber	boolean	Obtiene o establece un valor que indica si se debe comprobar si hay un número de control de grupo duplicado.
CheckDuplicateInterchangeControlNumber	boolean	Obtiene o establece un valor que indica si se debe comprobar si hay un número de control de intercambio duplicado.
CheckDuplicateTransactionSetControlNumber	boolean	Obtiene o establece un valor que indica si se debe comprobar si hay un número de control de conjunto de transacciones duplicado.
InterchangeControlNumberValidityPeriod	integer	Obtiene o establece el período de validez del número de control de intercambio.
TrailingSeparatorPolicy	string	Obtiene o establece la directiva de separador final.
TrimLeadingAndTrailingSpacesAndZeroes	boolean	Obtiene o establece un valor que indica si se deben recortar espacios iniciales y finales y ceros.
ValidateCharacterSet	boolean	Obtiene o establece un valor que indica si se va a validar el juego de caracteres en el mensaje.
ValidateEDITypes	boolean	Obtiene o establece un valor que indica si se van a validar tipos EDI.
ValidateXSDTypes	boolean	Obtiene o establece un valor que indica si se van a validar tipos XSD.
ValidationOverrides	X12ValidationOverrides[]	Obtiene o establece las invalidaciones de esquema.