CustomSetting
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 CustomSettings entity provides represents the custom information extending a Partner, BusinessProfile, or an Agreement.
CustomSetting Entity Properties
Create a CustomSetting Entity
List CustomSetting
Update a CustomSetting
Delete a CustomSetting
Link Other Entities with CustomSetting
Delete Link between Other Entities and CustomSetting
CustomSetting Entity Properties
Property |
Type |
Description |
|---|---|---|
ID |
Int |
Specifies a unique ID for the custom settings. This value is auto-generated. |
Agreement |
Agreement |
A navigation property that references the agreement entity with which the custom settings are associated. |
Blob |
Byte |
- |
BusinessProfile |
BusinessProfile |
A navigation property that references the business profile with which the custom settings are associated. |
Name |
Bool |
Required. Specifies a name for the custom setting entity. |
Partner |
Partner |
A navigation property that references the partner with which the custom settings are associated. |
Version |
Byte[] |
This value is auto-generated and is for internal use only. |
Considerations
A CustomSettings entity must be associated with either a Partner, BusinessProfile, or Agreement entity. Also, if a CustomSettings entity instance is associated with one of these three entities, it cannot be associated with the other entities. For example, if a CustomSettings entity instance is associated with the Partner entity, it cannot be associated with the BusinessProfile or Agreement entity.
Create a CustomSetting Entity
You can create a custom settings entity using a POST HTTP request.
Method |
Request URI |
HTTP Version |
|---|---|---|
POST |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CustomSettings |
HTTP/1.1 |
Sample Request
The following request message shows how to create a custom setting and link it to a partner entity.
POST https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CustomSettings 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
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.CustomSetting" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<link rel="https://schemas.microsoft.com/ado/2007/08/dataservices/related/Partner" type="application/atom+xml;type=entry" title="Partner" href="https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Partners(1)" />
<id />
<title />
<updated>2013-02-10T23:58:44Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Blob m:type="Edm.Binary" m:null="true" />
<d:Id m:type="Edm.Int32">0</d:Id>
<d:Name>CustomSetting1</d:Name>
<d:Version m:type="Edm.Binary">AA==</d:Version>
</m:properties>
</content>
</entry>
List CustomSetting
You can list custom settings using a GET HTTP request.
Method |
Request URI |
HTTP Version |
|---|---|---|
GET |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CustomSettings This returns all the custom settings |
HTTP/1.1 |
GET |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CustomSettings(id) This returns information about the custom setting with the specified ID. |
HTTP/1.1 |
Sample Request
Retrieve all the custom settings
GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CustomSettings 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 custom setting
GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CustomSettings() 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 a CustomSetting
You can update a custom setting using a MERGE HTTP request.
Method |
Request URI |
HTTP Version |
|---|---|---|
MERGE |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CustomSettings(id) |
HTTP/1.1 |
Sample Request
MERGE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CustomSettings(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
Content-Type: application/atom+xml
If-Match: W/"X'0000000000000FA5'"
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 796
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> CustomSettings/CustomSettings(1)</id>
<category term="Microsoft.ApplicationServer.Integration.PartnerManagement.CustomSetting" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<title />
<updated>2013-02-11T00:09:17Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
<d:Blob m:type="Edm.Binary" m:null="true" />
<d:Id m:type="Edm.Int32">1</d:Id>
<d:Name>CustomSetting2</d:Name>
<d:Version m:type="Edm.Binary">AAAAAAAAD6U=</d:Version>
</m:properties>
</content>
</entry>
Delete a CustomSetting
You can delete a custom setting using a DELETE HTTP request.
Method |
Request URI |
HTTP Version |
|---|---|---|
DELETE |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CustomSettings(id) |
HTTP/1.1 |
Sample Request
DELETE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/CustomSettings(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
If-Match: W/"X'0000000000000A69'"
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 0
Link Other Entities with CustomSetting
In Create a CustomSetting Entity section, we saw how to create a link between a custom setting and a partner entity while creating the custom setting entity. In this section, we see how to create a link in the opposite direction, that is, from a partner entity to a custom setting. To create the link, the URI of the partner must be included in the request body.
You could use similar requests to create links from Agreement or BusinessProfile entities.
Method |
Request URI |
HTTP Version |
|---|---|---|
POST |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Partners(id)//$links/CustomSettings Partners(id) denotes the ID of the partner that links to the custom setting. |
HTTP/1.1 |
Sample Request
POST https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Partners(1)/$links/CustomSettings 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: 213
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/CustomSettings(1)</uri>
Delete Link between Other Entities and CustomSetting
You can delete a link between other entities and a custom setting by using the HTTP DELETE method. This section shows the request URI and message to delete the link between a partner and a custom setting. You can use a similar request to delete a link from a business profile or an agreement.
Method |
Request URI |
HTTP Version |
|---|---|---|
DELETE |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Partners(id)/$links/CustomSettings(id) |
HTTP/1.1 |
Sample Request
DELETE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/Partners(1)/$links/CustomSettings(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