QualifierIdentity

 

Updated: November 27, 2015

System_CAPS_importantImportant

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:

Property

Type

Description

Qualifier

String

Required. Specifies the qualifier text, such as ZZ. The length of the text must not be more than 64 characters.

Description

String

Specifies the descriptive text about the qualifier. The text must not be more than 256 characters.

Value

String

Required. Specifies the qualifier value. The value must not be more than 256 characters.

SupportedProtocols

String

Specifies the supported protocols, such as X12. The value must not be more than 256 characters.

You can create a qualifier identity using POST HTTP request.

Method

Request URI

HTTP Version

POST

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

HTTP/1.1

System_CAPS_noteNote

You cannot create a business identity without linking it to a business profile or a OneWayAgreement* entity. In the following sample request, a business identity is linked to a business profile using the <link> element of the request body.

POST https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessIdentities 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/atom+xml
Host: integration.zurich.test.dnsdemo1.com:5446
Expect: 100-continue

<?xml version="1.0" encoding="utf-8"?>
<entry xmlns="http://www.w3.org/2005/Atom" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
  <category term="Microsoft.ApplicationServer.Integration.PartnerManagement.QualifierIdentity" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
  <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/BusinessProfile" type="application/atom+xml;type=entry" title="BusinessProfile" href="https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessProfiles(43)" />
  <id />
  <title />
  <updated>2013-01-31T07:25:37Z</updated>
  <author>
    <name />
  </author>
  <content type="application/xml">
    <m:properties>
      <d:Description m:null="true" />
      <d:Name>IdentityA_859</d:Name>
      <d:Qualifier>ZZ</d:Qualifier>
      <d:Value>1_859</d:Value>
    </m:properties>
  </content>
</entry>

You can list qualifier identities using a GET HTTP request.

Method

Request URI

HTTP Version

GET

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

This returns all the qualifier identities

HTTP/1.1

GET

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

This returns information about the qualifier identity with the specified ID.

HTTP/1.1

Retrieve all the identities

GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessIdentities 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>"
Host: integration.zurich.test.dnsdemo1.com:5446

Retrieve information about a specific identity

GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessIdentities(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>"
Host: integration.zurich.test.dnsdemo1.com:5446

You can update a qualifier identity using a MERGE HTTP request.

Method

Request URI

HTTP Version

MERGE

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

HTTP/1.1

MERGE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessIdentities(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/atom+xml
If-Match: W/"X'0000000000001003'"
Host: integration.zurich.test.dnsdemo1.com:5446
Expect: 100-continue

<?xml version="1.0" encoding="utf-8"?>
<entry xmlns="http://www.w3.org/2005/Atom" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
  <id>https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessIdentities(1)</id>
  <category term="Microsoft.ApplicationServer.Integration.PartnerManagement.QualifierIdentity" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
  <title />
  <updated>2013-01-31T07:45:00Z</updated>
  <author>
    <name />
  </author>
  <content type="application/xml">
    <m:properties>
      <d:Name>New Identity</d:Name>
    </m:properties>
  </content>
</entry>

You can delete a qualifier identity using a DELETE HTTP request.

Method

Request URI

HTTP Version

DELETE

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

HTTP/1.1

DELETE https://integration.zurich.test.dnsdemo1.com:5446/test01/$PartnerManagement/BusinessIdentities(1) HTTP/1.1
User-Agent: Microsoft ADO.NET Data Services
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>"
If-Match: W/"X'000000000000101E'"
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 0

In the Create a Qualifier Identity section, we saw how to create a link between a qualifier identity and a business profile while creating a qualifier identity. In this section, we see how to create a link in the opposite direction, that is, from a business profile to a qualifier identity. The URI of the qualifier identity must be included in the request body.

Method

Request URI

HTTP Version

POST

https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessProfiles(id)/$links/BusinessIdentities

BusinessProfiles(id) denotes the ID of the business profile that links to the qualifier identity

HTTP/1.1

POST https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessProfiles(1)/$links/BusinessIdentities 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
Content-Length: 217
Expect: 100-continue

<?xml version="1.0" encoding="utf-8"?>
<uri xmlns="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessIdentities(1)</uri>

You can delete a link between business profiles and qualifier identities by using the HTTP DELETE method.

Method

Request URI

HTTP Version

DELETE

https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessProfiles(id)/$links/BusinessIdentities(id)

HTTP/1.1

DELETE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BusinessProfiles(1)/$links/BusinessIdentities(1) HTTP/1.1
User-Agent: Microsoft ADO.NET Data Services
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>"
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 0
Show: