X12SchemaReference

Article
06/12/2017

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:

What are logic apps
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 X12SchemaReferences entity references the schemas that are associated with an X12 protocol setting.

X12SchemaReferences Entity Properties
Create an X12SchemaReference
List X12SchemaReference
Update an X12SchemaReference
Delete an X12SchemaReference
Link Other Entities with X12SchemaReference
Delete Link between Other Entities and X12SchemaReference

X12SchemaReferences Entity Properties

Property	Type	Description
ID	Int	Specifies a unique ID for the X12 schema reference. This value is auto-generated.
MessageId	String	Required. Specifies the message ID, for example, 810. This must not be more than 15 characters.
SchemaPath	String	Required. Specifies the path of the schema in the artifact store, such as, /X12_00401_810.XSD. This must not be more than 230 characters.
SchemaVersion	String	Required. Specifies the schema version, such as, 00401. This must not be more than 15 characters.
SenderApplicationId	String	Specifies the sender application ID (GS02).
X12ProtocolSettings	X12ProtocolSettings	Required. A navigation property that references the X12 protocol settings associated with the schema reference.
X12ProtocolSettingsId	Int	Required. A navigation property that references an X12 protocol settings ID.
Version	Byte[]	This value is auto-generated and is for internal use only.

Considerations

You can create an X12SchemaReference entity only if a schema is already uploaded to the artifact store.

Create an X12SchemaReference

You can create an X12 schema reference entity using a POST HTTP request.

Method	Request URI	HTTP Version
POST	https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12SchemaReferences	HTTP/1.1

Sample Request

The following request message shows how to create an X12 schema reference and link it to X12ProtocoSetting entity.

POST https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12SchemaReferences 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
Content-Type: application/atom+xml
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 1194
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">
  <category term="Microsoft.ApplicationServer.Integration.PartnerManagement.X12SchemaReference" 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-08T23:31:56Z</updated>
  <author>
    <name />
  </author>
  <content type="application/xml">
    <m:properties>
      <d:Id m:type="Edm.Int32">0</d:Id>
      <d:MessageId>810</d:MessageId>
      <d:SchemaPath>/X12_00401_810.XSD</d:SchemaPath>
      <d:SchemaVersion>00401</d:SchemaVersion>
      <d:SenderApplicationId m:null="true" />
      <d:Version m:type="Edm.Binary">AA==</d:Version>
      <d:X12ProtocolSettingsId m:type="Edm.Int32">0</d:X12ProtocolSettingsId>
    </m:properties>
  </content>
</entry>

List X12SchemaReference

You can list X12 schema references using a GET HTTP request.

Method	Request URI	HTTP Version
GET	https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12SchemaReferences This returns all the X12 schema reference	HTTP/1.1
GET	https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12SchemaReferences(id) This returns information about the X12 schema reference with the specified ID.	HTTP/1.1

GET

https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12SchemaReferences

This returns all the X12 schema reference

HTTP/1.1

GET

https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12SchemaReferences(id)

This returns information about the X12 schema reference with the specified ID.

HTTP/1.1

Sample Request

Retrieve all the X12 schema references

GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12SchemaReferences 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 schema reference

GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12SchemaReferences(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 X12SchemaReference

You can update an X12 schema reference using a MERGE HTTP request.

Method	Request URI	HTTP Version
MERGE	https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12SchemaReferences(id)	HTTP/1.1

Sample Request

MERGE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12SchemaReferences(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'0000000000000888'"
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 959
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/X12SchemaReferences(1)</id>
  <category term="Microsoft.ApplicationServer.Integration.PartnerManagement.X12SchemaReference" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
  <title />
  <updated>2013-02-09T01:31:46Z</updated>
  <author>
    <name />
  </author>
  <content type="application/xml">
    <m:properties>
      <d:Id m:type="Edm.Int32">3</d:Id>
      <d:MessageId>840</d:MessageId>
      <d:SchemaPath>/X12_00401_810.XSD</d:SchemaPath>
      <d:SchemaVersion>00401</d:SchemaVersion>
      <d:SenderApplicationId m:null="true" />
      <d:Version m:type="Edm.Binary">AAAAAAAACIg=</d:Version>
      <d:X12ProtocolSettingsId m:type="Edm.Int32">35</d:X12ProtocolSettingsId>
    </m:properties>
  </content>
</entry>

Delete an X12SchemaReference

You can delete an X12 schema reference using a DELETE HTTP request.

Method	Request URI	HTTP Version
DELETE	https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12SchemaReferences(id)	HTTP/1.1

Sample Request

DELETE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/X12SchemaReferences(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'0000000000000A69'"
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 0

Link Other Entities with X12SchemaReference

In Create an X12SchemaReference section, we saw how to create a link between an X12 schema reference and an X12 protocol settings entity while creating the X12 schema reference 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 schema reference. To create the link, the URI of the X12 schema reference 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/SchemaReferences ProtocolSettings(id) denotes the ID of the protocol setting that links to the X12 schema reference.	HTTP/1.1

POST

https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(id)/Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings/$links/SchemaReferences

ProtocolSettings(id) denotes the ID of the protocol setting that links to the X12 schema reference.

HTTP/1.1

Sample Request

POST https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(1)/Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings/$links/SchemaReferences 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
Content-Type: application/xml
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 219
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/X12SchemaReferences(1)</uri>

Delete Link between Other Entities and X12SchemaReference

You can delete a link between other entities and an X12 schema reference 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/SchemaReferences(id)	HTTP/1.1

Sample Request

DELETE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(1)/Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings/$links/SchemaReferences(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

X12SchemaReference

X12SchemaReferences Entity Properties

Considerations

Create an X12SchemaReference

Sample Request

List X12SchemaReference

Sample Request

Update an X12SchemaReference

Sample Request

Delete an X12SchemaReference

Sample Request

Link Other Entities with X12SchemaReference

Sample Request

Delete Link between Other Entities and X12SchemaReference

Sample Request

See Also

Additional resources