X12EnvelopeOverride
Important
Microsoft Azure BizTalk Services (MABS) is being retired, and replaced with Azure Logic Apps. If you currently use MABS, then Move from BizTalk Services to Logic Appsprovides some guidance on moving your integration solutions to Logic Apps.
If you're brand new to Logic Apps, then we suggest getting started here:
-
Create your first logic app, or quickly get started using a pre-built template
-
View all the available connectors you can use in your logic apps
The X12EnvelopeOverrides entity captures the X12 envelope override settings associated with an X12 protocol setting.
X12EnvelopeOverrides Entity Properties
Create an X12EnvelopeOverride
List X12EnvelopOverrides
Update an X12EnvelopeOverride
Delete an X12EnvelopeOverride
Link Other Entities with X12EnvelopeOverride
Delete Link between Other Entities and X12EnvelopeOverride
X12EnvelopeOverrides Entity Properties
Property |
Type |
Description |
|---|---|---|
ID |
Int |
Specifies a unique ID for the X12 envelope overrides settings. This value is auto-generated. |
DateFormat |
Short |
Required. Specifies the date format (GS04). The possible values are CCYYMMDD or YYMMDD. |
TimeFormat |
Short |
Required. Specifies the time format. |
FunctionalIdentifierCode |
String |
Specifies the functional identifier code (GS01). The possible values are between AA to ZZ. |
HeaderVersion |
String |
- |
MessageId |
String |
Required. Specifies the message ID, for example, 810. |
ProtocolVersion |
String |
Specified the protocol version, for example, 00401. |
ResponsibleAgencyCode |
Short |
Required. Specifies the agency code. The valid values are 84 (for TransportationDataCoordinationCommittee) and 88 (for AccreditedStandardsCommittee). |
ReceiverApplicationId |
String |
Specifies the receiver application ID (GS03). |
SenderApplicationId |
String |
Specifies the sender application ID (GS02). |
X12ProtocolSettings |
X12ProtocolSettings |
Required. A navigation property that references the X12 protocol settings associated with the overrides. |
X12ProtocolSettingsId |
Int |
Required. A navigation property that references an X12 protocol settings ID. |
TargetNamespace |
String |
Specifies the target namespace string, for example, https://schemas.microsoft.com/BizTalk/EDI/X12/2006. |
Version |
Byte[] |
This value is auto-generated and is for internal use only. |
Create an X12EnvelopeOverride
You can create an X12 envelop override entity using a POST HTTP request.
Method |
Request URI |
HTTP Version |
|---|---|---|
POST |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12EnvelopeOverrides |
HTTP/1.1 |
Sample Request
The following request message shows how to create an X12 envelope override and link it to X12ProtocoSettings entity.
POST https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12EnvelopeOverrides HTTP/1.1
Content-Type: application/json; odata=verbose
Accept: text/html, application/xhtml+xml, */*
Host: integration.zurich.test.dnsdemo1.com:5446
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
x-ms-version: 1.0
Connection: Keep-Alive
Authorization: WRAP access_token = "<token>"
<?xml version="1.0" encoding="utf-8"?>
<entry xmlns="https://www.w3.org/2005/Atom" xmlns:d="https://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="https://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
<category term="Microsoft.ApplicationServer.Integration.PartnerManagement.X12EnvelopeOverride" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="https://schemas.microsoft.com/ado/2007/08/dataservices/related/X12ProtocolSettings" type="application/atom+xml;type=entry" title="X12ProtocolSettings" href="https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(1)/Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings" />
<id />
<title />
<updated>2013-02-08T20:59:46Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:DateFormat m:type="Edm.Int16">0</d:DateFormat>
<d:FunctionalIdentifierCode m:null="true" />
<d:HeaderVersion>Version</d:HeaderVersion>
<d:Id m:type="Edm.Int32">0</d:Id>
<d:MessageId>810</d:MessageId>
<d:ProtocolVersion>00401</d:ProtocolVersion>
<d:ReceiverApplicationId>RECEIVE-APP</d:ReceiverApplicationId>
<d:ResponsibleAgencyCode m:type="Edm.Int16">88</d:ResponsibleAgencyCode>
<d:SenderApplicationId>BTS-SENDER2</d:SenderApplicationId>
<d:TargetNamespace>https://schemas.microsoft.com/BizTalk/EDI/X12/2006</d:TargetNamespace>
<d:TimeFormat m:type="Edm.Int16">0</d:TimeFormat>
<d:Version m:type="Edm.Binary">AA==</d:Version>
<d:X12ProtocolSettingsId m:type="Edm.Int32">0</d:X12ProtocolSettingsId>
</m:properties>
</content>
</entry>
List X12EnvelopOverrides
You can list X12 envelope overrides using a GET HTTP request.
Method |
Request URI |
HTTP Version |
|---|---|---|
GET |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12EnvelopeOverrides This returns all the X12 envelope overrides |
HTTP/1.1 |
GET |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12EnvelopeOverrides(id) This returns information about the X12 envelope override with the specified ID. |
HTTP/1.1 |
Sample Request
Retrieve all the X12 envelope overrides
GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12EnvelopeOverrides HTTP/1.1
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
x-ms-version: 1.0
Host: integration.zurich.test.dnsdemo1.com:5446
Retrieve information about a specific X12 envelope override
GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12EnvelopeOverrides(1) HTTP/1.1
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
x-ms-version: 1.0
Host: integration.zurich.test.dnsdemo1.com:5446
Update an X12EnvelopeOverride
You can update an X12 envelop override using a MERGE HTTP request.
Method |
Request URI |
HTTP Version |
|---|---|---|
MERGE |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12EnvelopeOverrides(id) |
HTTP/1.1 |
Sample Request
MERGE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12EnvelopeOverrides(1) HTTP/1.1
User-Agent: Microsoft ADO.NET Data Services
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
x-ms-version: 1.0
Content-Type: application/atom+xml
If-Match: W/"X'0000000000000A67'"
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 1344
Expect: 100-continue
<?xml version="1.0" encoding="utf-8"?><entry xmlns="https://www.w3.org/2005/Atom" xmlns:d="https://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="https://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
<id>https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12EnvelopeOverrides(6)</id>
<category term="Microsoft.ApplicationServer.Integration.PartnerManagement.X12EnvelopeOverride" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<title />
<updated>2013-02-10T22:30:44Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:DateFormat m:type="Edm.Int16">0</d:DateFormat>
<d:FunctionalIdentifierCode m:null="true" />
<d:HeaderVersion>Version1</d:HeaderVersion>
<d:Id m:type="Edm.Int32">6</d:Id>
<d:MessageId>840</d:MessageId>
<d:ProtocolVersion>00401</d:ProtocolVersion>
<d:ReceiverApplicationId>RECEIVE-APP</d:ReceiverApplicationId>
<d:ResponsibleAgencyCode m:type="Edm.Int16">88</d:ResponsibleAgencyCode>
<d:SenderApplicationId>BTS-SENDER2</d:SenderApplicationId>
<d:TargetNamespace>https://schemas.microsoft.com/BizTalk/EDI/X12/2006</d:TargetNamespace>
<d:TimeFormat m:type="Edm.Int16">0</d:TimeFormat>
<d:Version m:type="Edm.Binary">AAAAAAAACmc=</d:Version>
<d:X12ProtocolSettingsId m:type="Edm.Int32">13</d:X12ProtocolSettingsId>
</m:properties>
</content>
</entry>
Delete an X12EnvelopeOverride
You can delete an X12 envelope override using a DELETE HTTP request.
Method |
Request URI |
HTTP Version |
|---|---|---|
DELETE |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12EnvelopeOverrides(id) |
HTTP/1.1 |
Sample Request
DELETE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12EnvelopeOverrides(1) HTTP/1.1
User-Agent: Microsoft ADO.NET Data Services
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
x-ms-version: 1.0
If-Match: W/"X'0000000000000A66'"
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 0
Link Other Entities with X12EnvelopeOverride
In Create an X12EnvelopeOverride section, we saw how to create a link between an X12 envelope override and an X12 protocol settings entity while creating the X12 envelope override entity. In this section, we see how to create a link in the opposite direction, that is, from an X12 protocol setting entity to an X12 envelope override. To create the link, the URI of the X12 envelope override must be included in the request body.
Method |
Request URI |
HTTP Version |
|---|---|---|
POST |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(id)/Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings/$links/EnvelopeOverrides ProtocolSettings(id) denotes the ID of the protocol setting that links to the X12 envelope override. |
HTTP/1.1 |
Sample Request
POST https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(1)/Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings/$links/EnvelopeOverrides HTTP/1.1
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
x-ms-version: 1.0
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
Content-Type: application/xml
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 216
Expect: 100-continue
<?xml version="1.0" encoding="utf-8"?>
<uri xmlns="https://schemas.microsoft.com/ado/2007/08/dataservices/metadata">https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12EnvelopeOverrides(1)</uri>
Delete Link between Other Entities and X12EnvelopeOverride
You can delete a link between other entities and an X12 envelope override by using the HTTP DELETE method.
Method |
Request URI |
HTTP Version |
|---|---|---|
DELETE |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(id)/Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings/$links/EnvelopeOverrides(id) |
HTTP/1.1 |
Sample Request
DELETE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(1)/Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings/$links/EnvelopeOverrides(1) HTTP/1.1
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
x-ms-version: 1.0
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
Content-Type: application/xml
Host: integration.zurich.test.dnsdemo1.com:5446
Expect: 100-continue