Microsoft.Logic (preview:2015-08-01)

2025/10/23 • 27 new, 27 deleted methods

IntegrationAccounts_ListBySubscription (new)
Description :  Gets a list of integration accounts by subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Logic/integrationAccounts
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration accounts. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
object ,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Shared: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
IntegrationAccounts_ListByResourceGroup (new)
Description :  Gets a list of integration accounts by resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration accounts. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
object ,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Shared: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
IntegrationAccounts_Get (new)
Description :  Gets an integration account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
object ,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Shared: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
IntegrationAccounts_CreateOrUpdate (new)
Description :  Creates or updates an integration account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
integrationAccount:
{
Description: The integration account. ,
Required: True ,
}
{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
object ,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Shared: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
object ,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Shared: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
object ,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Shared: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
IntegrationAccounts_Update (new)
Description :  Updates an integration account.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
integrationAccount:
{
Description: The integration account. ,
Required: True ,
}
{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
object ,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Shared: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
object ,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Shared: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
IntegrationAccounts_Delete (new)
Description :  Deletes an integration account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
IntegrationAccounts_ListCallbackUrl (new)
Description :  Lists the integration account callback URL.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/listCallbackUrl
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
parameters:
{
Description: The callback URL parameters. ,
Required: True ,
}
{
NotAfter:
{
Description: The expiry time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The URL value. ,
Required: False ,
}
string ,
}
IntegrationAccountSchemas_List (new)
Description :  Gets a list of integration account schemas.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/schemas
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration account schemas. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account schema properties. ,
Required: False ,
}
{
schemaType:
{
Description: The schema type. ,
Enum:
{
NotSpecified: No description available. ,
Xml: No description available. ,
}
,
Required: False ,
}
enum ,
targetNamespace:
{
Description: The target namespace. ,
Required: False ,
}
string ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
content:
{
Description: The content. ,
Required: False ,
}
object ,
contentType:
{
Description: The content type. ,
Required: False ,
}
string ,
contentLink:
{
Description: The content link. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The content hash algorithm. ,
Required: False ,
}
string ,
value:
{
Description: The content hash value. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
IntegrationAccountSchemas_Get (new)
Description :  Gets an integration account schema.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/schemas/{schemaName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
schemaName:
{
Description: The integration account schema name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The integration account schema properties. ,
Required: False ,
}
{
schemaType:
{
Description: The schema type. ,
Enum:
{
NotSpecified: No description available. ,
Xml: No description available. ,
}
,
Required: False ,
}
enum ,
targetNamespace:
{
Description: The target namespace. ,
Required: False ,
}
string ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
content:
{
Description: The content. ,
Required: False ,
}
object ,
contentType:
{
Description: The content type. ,
Required: False ,
}
string ,
contentLink:
{
Description: The content link. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The content hash algorithm. ,
Required: False ,
}
string ,
value:
{
Description: The content hash value. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
IntegrationAccountSchemas_CreateOrUpdate (new)
Description :  Creates or updates an integration account schema.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/schemas/{schemaName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
schemaName:
{
Description: The integration account schema name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
schema:
{
Description: The integration account schema. ,
Required: True ,
}
{
properties:
{
Description: The integration account schema properties. ,
Required: False ,
}
{
schemaType:
{
Description: The schema type. ,
Enum:
{
NotSpecified: No description available. ,
Xml: No description available. ,
}
,
Required: False ,
}
enum ,
targetNamespace:
{
Description: The target namespace. ,
Required: False ,
}
string ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
content:
{
Description: The content. ,
Required: False ,
}
object ,
contentType:
{
Description: The content type. ,
Required: False ,
}
string ,
contentLink:
{
Description: The content link. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The content hash algorithm. ,
Required: False ,
}
string ,
value:
{
Description: The content hash value. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account schema properties. ,
Required: False ,
}
{
schemaType:
{
Description: The schema type. ,
Enum:
{
NotSpecified: No description available. ,
Xml: No description available. ,
}
,
Required: False ,
}
enum ,
targetNamespace:
{
Description: The target namespace. ,
Required: False ,
}
string ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
content:
{
Description: The content. ,
Required: False ,
}
object ,
contentType:
{
Description: The content type. ,
Required: False ,
}
string ,
contentLink:
{
Description: The content link. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The content hash algorithm. ,
Required: False ,
}
string ,
value:
{
Description: The content hash value. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration account schema properties. ,
Required: False ,
}
{
schemaType:
{
Description: The schema type. ,
Enum:
{
NotSpecified: No description available. ,
Xml: No description available. ,
}
,
Required: False ,
}
enum ,
targetNamespace:
{
Description: The target namespace. ,
Required: False ,
}
string ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
content:
{
Description: The content. ,
Required: False ,
}
object ,
contentType:
{
Description: The content type. ,
Required: False ,
}
string ,
contentLink:
{
Description: The content link. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The content hash algorithm. ,
Required: False ,
}
string ,
value:
{
Description: The content hash value. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
IntegrationAccountSchemas_Delete (new)
Description :  Deletes an integration account schema.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/schemas/{schemaName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
schemaName:
{
Description: The integration account schema name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
IntegrationAccountMaps_List (new)
Description :  Gets a list of integration account maps.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/maps
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration account maps. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account map properties. ,
Required: False ,
}
{
mapType:
{
Description: The map type. ,
Enum:
{
NotSpecified: No description available. ,
Xslt: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
content:
{
Description: The content. ,
Required: False ,
}
object ,
contentType:
{
Description: The content type. ,
Required: False ,
}
string ,
contentLink:
{
Description: The content link. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The content hash algorithm. ,
Required: False ,
}
string ,
value:
{
Description: The content hash value. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
IntegrationAccountMaps_Get (new)
Description :  Gets an integration account map.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/maps/{mapName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
mapName:
{
Description: The integration account map name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The integration account map properties. ,
Required: False ,
}
{
mapType:
{
Description: The map type. ,
Enum:
{
NotSpecified: No description available. ,
Xslt: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
content:
{
Description: The content. ,
Required: False ,
}
object ,
contentType:
{
Description: The content type. ,
Required: False ,
}
string ,
contentLink:
{
Description: The content link. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The content hash algorithm. ,
Required: False ,
}
string ,
value:
{
Description: The content hash value. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
IntegrationAccountMaps_CreateOrUpdate (new)
Description :  Creates or updates an integration account map.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/maps/{mapName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
mapName:
{
Description: The integration account map name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
map:
{
Description: The integration account map. ,
Required: True ,
}
{
properties:
{
Description: The integration account map properties. ,
Required: False ,
}
{
mapType:
{
Description: The map type. ,
Enum:
{
NotSpecified: No description available. ,
Xslt: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
content:
{
Description: The content. ,
Required: False ,
}
object ,
contentType:
{
Description: The content type. ,
Required: False ,
}
string ,
contentLink:
{
Description: The content link. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The content hash algorithm. ,
Required: False ,
}
string ,
value:
{
Description: The content hash value. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account map properties. ,
Required: False ,
}
{
mapType:
{
Description: The map type. ,
Enum:
{
NotSpecified: No description available. ,
Xslt: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
content:
{
Description: The content. ,
Required: False ,
}
object ,
contentType:
{
Description: The content type. ,
Required: False ,
}
string ,
contentLink:
{
Description: The content link. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The content hash algorithm. ,
Required: False ,
}
string ,
value:
{
Description: The content hash value. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration account map properties. ,
Required: False ,
}
{
mapType:
{
Description: The map type. ,
Enum:
{
NotSpecified: No description available. ,
Xslt: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
content:
{
Description: The content. ,
Required: False ,
}
object ,
contentType:
{
Description: The content type. ,
Required: False ,
}
string ,
contentLink:
{
Description: The content link. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The content hash algorithm. ,
Required: False ,
}
string ,
value:
{
Description: The content hash value. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
IntegrationAccountMaps_Delete (new)
Description :  Deletes an integration account map.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/maps/{mapName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
mapName:
{
Description: The integration account map name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
IntegrationAccountPartners_List (new)
Description :  Gets a list of integration account partners.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/partners
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration account partners. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account partner properties. ,
Required: False ,
}
{
partnerType:
{
Description: The partner type. ,
Enum:
{
NotSpecified: No description available. ,
B2B: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
content:
{
Description: The partner content. ,
Required: False ,
}
{
b2b:
{
Description: The B2B partner content. ,
Required: False ,
}
{
businessIdentities:
{
Description: The list of partner business identities. ,
Required: False ,
}
[
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
IntegrationAccountPartners_Get (new)
Description :  Gets an integration account partner.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/partners/{partnerName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
partnerName:
{
Description: The integration account partner name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The integration account partner properties. ,
Required: False ,
}
{
partnerType:
{
Description: The partner type. ,
Enum:
{
NotSpecified: No description available. ,
B2B: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
content:
{
Description: The partner content. ,
Required: False ,
}
{
b2b:
{
Description: The B2B partner content. ,
Required: False ,
}
{
businessIdentities:
{
Description: The list of partner business identities. ,
Required: False ,
}
[
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}
IntegrationAccountPartners_CreateOrUpdate (new)
Description :  Creates or updates an integration account partner.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/partners/{partnerName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
partnerName:
{
Description: The integration account partner name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
partner:
{
Description: The integration account partner. ,
Required: True ,
}
{
properties:
{
Description: The integration account partner properties. ,
Required: False ,
}
{
partnerType:
{
Description: The partner type. ,
Enum:
{
NotSpecified: No description available. ,
B2B: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
content:
{
Description: The partner content. ,
Required: False ,
}
{
b2b:
{
Description: The B2B partner content. ,
Required: False ,
}
{
businessIdentities:
{
Description: The list of partner business identities. ,
Required: False ,
}
[
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account partner properties. ,
Required: False ,
}
{
partnerType:
{
Description: The partner type. ,
Enum:
{
NotSpecified: No description available. ,
B2B: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
content:
{
Description: The partner content. ,
Required: False ,
}
{
b2b:
{
Description: The B2B partner content. ,
Required: False ,
}
{
businessIdentities:
{
Description: The list of partner business identities. ,
Required: False ,
}
[
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration account partner properties. ,
Required: False ,
}
{
partnerType:
{
Description: The partner type. ,
Enum:
{
NotSpecified: No description available. ,
B2B: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
content:
{
Description: The partner content. ,
Required: False ,
}
{
b2b:
{
Description: The B2B partner content. ,
Required: False ,
}
{
businessIdentities:
{
Description: The list of partner business identities. ,
Required: False ,
}
[
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}
IntegrationAccountPartners_Delete (new)
Description :  Deletes an integration account partner.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/partners/{partnerName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
partnerName:
{
Description: The integration account partner name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
IntegrationAccountAgreements_List (new)
Description :  Gets a list of integration account agreements.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/agreements
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration account agreements. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account agreement properties. ,
Required: False ,
}
{
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
agreementType:
{
Description: The agreement type. ,
Enum:
{
NotSpecified: No description available. ,
AS2: No description available. ,
X12: No description available. ,
Edifact: No description available. ,
}
,
Required: False ,
}
enum ,
hostPartner:
{
Description: The host partner. ,
Required: False ,
}
string ,
guestPartner:
{
Description: The guest partner. ,
Required: False ,
}
string ,
hostIdentity:
{
Description: The host identity. ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
guestIdentity:
{
Description: The guest identity. ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
content:
{
Description: The agreement content. ,
Required: False ,
}
{
AS2:
{
Description: The AS2 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The AS2 one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: False ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: False ,
}
{
needMdn:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signMdn:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: False ,
}
boolean ,
sendMdnAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: False ,
}
boolean ,
receiptDeliveryUrl:
{
Description: The receipt delivery URL. ,
Required: False ,
}
string ,
dispositionNotificationTo:
{
Description: The disposition notification to header value. ,
Required: False ,
}
string ,
signOutboundMdnIfOptional:
{
Description: The value indicating whether to sign the outbound MDN if optional. ,
Required: False ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMdnToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: False ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: False ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signingCertificateName:
{
Description: The name of the signing certificate. ,
Required: False ,
}
string ,
encryptionCertificateName:
{
Description: The name of the encryption certificate. ,
Required: False ,
}
string ,
enableNrrForInboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for inbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundMdn:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: False ,
}
boolean ,
enableNrrForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundMdn:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: False ,
}
boolean ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: False ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: False ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: False ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: False ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: False ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: False ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: False ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: False ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: The encryption algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
DES3: No description available. ,
RC2: No description available. ,
AES128: No description available. ,
AES192: No description available. ,
AES256: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: False ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: False ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: False ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: False ,
}
string ,
SuspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: False ,
}
boolean ,
AutogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: False ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: False ,
}
{
SuspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: False ,
}
boolean ,
ResendIfMdnNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
sendAgreement:
{
Description: The AS2 one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: False ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: False ,
}
{
needMdn:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signMdn:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: False ,
}
boolean ,
sendMdnAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: False ,
}
boolean ,
receiptDeliveryUrl:
{
Description: The receipt delivery URL. ,
Required: False ,
}
string ,
dispositionNotificationTo:
{
Description: The disposition notification to header value. ,
Required: False ,
}
string ,
signOutboundMdnIfOptional:
{
Description: The value indicating whether to sign the outbound MDN if optional. ,
Required: False ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMdnToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: False ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: False ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signingCertificateName:
{
Description: The name of the signing certificate. ,
Required: False ,
}
string ,
encryptionCertificateName:
{
Description: The name of the encryption certificate. ,
Required: False ,
}
string ,
enableNrrForInboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for inbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundMdn:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: False ,
}
boolean ,
enableNrrForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundMdn:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: False ,
}
boolean ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: False ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: False ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: False ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: False ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: False ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: False ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: False ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: False ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: The encryption algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
DES3: No description available. ,
RC2: No description available. ,
AES128: No description available. ,
AES192: No description available. ,
AES256: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: False ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: False ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: False ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: False ,
}
string ,
SuspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: False ,
}
boolean ,
AutogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: False ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: False ,
}
{
SuspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: False ,
}
boolean ,
ResendIfMdnNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
X12:
{
Description: The X12 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The X12 one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: False ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The X12 character set. ,
Enum:
{
NotSpecified: No description available. ,
Basic: No description available. ,
Extended: No description available. ,
UTF8: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: False ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: False ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: False ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: False ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
groupHeaderTimeFormat:
{
Description: The group header time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: False ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: False ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: False ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: False ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The X12 envelope override settings. ,
Required: False ,
}
[
{
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Format: int32 ,
Required: False ,
}
integer ,
headerVersion:
{
Description: The header version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
functionalIdentifierCode:
{
Description: The functional identifier code. ,
Required: False ,
}
string ,
dateFormat:
{
Description: The date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
timeFormat:
{
Description: The time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validationOverrides:
{
Description: The X12 validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
x12DelimiterOverrides:
{
Description: The X12 delimiter override settings. ,
Required: False ,
}
[
{
protocolVersion:
{
Description: The protocol version. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sendAgreement:
{
Description: The X12 one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: False ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The X12 character set. ,
Enum:
{
NotSpecified: No description available. ,
Basic: No description available. ,
Extended: No description available. ,
UTF8: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: False ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: False ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: False ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: False ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
groupHeaderTimeFormat:
{
Description: The group header time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: False ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: False ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: False ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: False ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The X12 envelope override settings. ,
Required: False ,
}
[
{
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Format: int32 ,
Required: False ,
}
integer ,
headerVersion:
{
Description: The header version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
functionalIdentifierCode:
{
Description: The functional identifier code. ,
Required: False ,
}
string ,
dateFormat:
{
Description: The date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
timeFormat:
{
Description: The time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validationOverrides:
{
Description: The X12 validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
x12DelimiterOverrides:
{
Description: The X12 delimiter override settings. ,
Required: False ,
}
[
{
protocolVersion:
{
Description: The protocol version. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
Edifact:
{
Description: The EDIFACT agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The EDIFACT one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: False ,
}
{
serviceCodeListDirectoryVersion:
{
Description: The service code list directory version. ,
Required: False ,
}
string ,
characterEncoding:
{
Description: The character encoding. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version. ,
Format: int32 ,
Required: False ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The EDIFACT frame setting characterSet. ,
Enum:
{
NotSpecified: No description available. ,
UNOB: No description available. ,
UNOA: No description available. ,
UNOC: No description available. ,
UNOD: No description available. ,
UNOE: No description available. ,
UNOF: No description available. ,
UNOG: No description available. ,
UNOH: No description available. ,
UNOI: No description available. ,
UNOJ: No description available. ,
UNOK: No description available. ,
UNOX: No description available. ,
UNOY: No description available. ,
KECA: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The EDIFACT frame setting segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: False ,
}
{
groupAssociationAssignedCode:
{
Description: The group association assigned code. ,
Required: False ,
}
string ,
communicationAgreementId:
{
Description: The communication agreement id. ,
Required: False ,
}
string ,
applyDelimiterStringAdvice:
{
Description: The value indicating whether to apply delimiter string advice. ,
Required: False ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
recipientReferencePasswordValue:
{
Description: The recipient reference password value. ,
Required: False ,
}
string ,
recipientReferencePasswordQualifier:
{
Description: The recipient reference password qualifier. ,
Required: False ,
}
string ,
applicationReferenceId:
{
Description: The application reference id. ,
Required: False ,
}
string ,
processingPriorityCode:
{
Description: The processing priority code. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberPrefix:
{
Description: The interchange control number prefix. ,
Required: False ,
}
string ,
interchangeControlNumberSuffix:
{
Description: The interchange control number suffix. ,
Required: False ,
}
string ,
senderReverseRoutingAddress:
{
Description: The sender reverse routing address. ,
Required: False ,
}
string ,
receiverReverseRoutingAddress:
{
Description: The receiver reverse routing address. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControllingAgencyCode:
{
Description: The group controlling agency code. ,
Required: False ,
}
string ,
groupMessageVersion:
{
Description: The group message version. ,
Required: False ,
}
string ,
groupMessageRelease:
{
Description: The group message release. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupControlNumberPrefix:
{
Description: The group control number prefix. ,
Required: False ,
}
string ,
groupControlNumberSuffix:
{
Description: The group control number suffix. ,
Required: False ,
}
string ,
groupApplicationReceiverQualifier:
{
Description: The group application receiver qualifier. ,
Required: False ,
}
string ,
groupApplicationReceiverId:
{
Description: The group application receiver id. ,
Required: False ,
}
string ,
groupApplicationSenderQualifier:
{
Description: The group application sender qualifier. ,
Required: False ,
}
string ,
groupApplicationSenderId:
{
Description: The group application sender id. ,
Required: False ,
}
string ,
groupApplicationPassword:
{
Description: The group application password. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: False ,
}
boolean ,
senderInternalIdentification:
{
Description: The sender internal identification. ,
Required: False ,
}
string ,
senderInternalSubIdentification:
{
Description: The sender internal sub identification. ,
Required: False ,
}
string ,
receiverInternalIdentification:
{
Description: The receiver internal identification. ,
Required: False ,
}
string ,
receiverInternalSubIdentification:
{
Description: The receiver internal sub identification. ,
Required: False ,
}
string ,
}
,
acknowledgementSettings:
{
Description: The EDIFACT acknowledgement settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The EDIFACT envelope override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationQualifier:
{
Description: The receiver application qualifier. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controllingAgencyCode:
{
Description: The controlling agency code. ,
Required: False ,
}
string ,
groupHeaderMessageVersion:
{
Description: The group header message version. ,
Required: False ,
}
string ,
groupHeaderMessageRelease:
{
Description: The group header message release. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
applicationPassword:
{
Description: The application password. ,
Required: False ,
}
string ,
}
,
]
,
messageFilterList:
{
Description: The EDIFACT message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
validationOverrides:
{
Description: The EDIFACT validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
}
,
]
,
edifactDelimiterOverrides:
{
Description: The EDIFACT delimiter override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sendAgreement:
{
Description: The EDIFACT one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: False ,
}
{
serviceCodeListDirectoryVersion:
{
Description: The service code list directory version. ,
Required: False ,
}
string ,
characterEncoding:
{
Description: The character encoding. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version. ,
Format: int32 ,
Required: False ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The EDIFACT frame setting characterSet. ,
Enum:
{
NotSpecified: No description available. ,
UNOB: No description available. ,
UNOA: No description available. ,
UNOC: No description available. ,
UNOD: No description available. ,
UNOE: No description available. ,
UNOF: No description available. ,
UNOG: No description available. ,
UNOH: No description available. ,
UNOI: No description available. ,
UNOJ: No description available. ,
UNOK: No description available. ,
UNOX: No description available. ,
UNOY: No description available. ,
KECA: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The EDIFACT frame setting segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: False ,
}
{
groupAssociationAssignedCode:
{
Description: The group association assigned code. ,
Required: False ,
}
string ,
communicationAgreementId:
{
Description: The communication agreement id. ,
Required: False ,
}
string ,
applyDelimiterStringAdvice:
{
Description: The value indicating whether to apply delimiter string advice. ,
Required: False ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
recipientReferencePasswordValue:
{
Description: The recipient reference password value. ,
Required: False ,
}
string ,
recipientReferencePasswordQualifier:
{
Description: The recipient reference password qualifier. ,
Required: False ,
}
string ,
applicationReferenceId:
{
Description: The application reference id. ,
Required: False ,
}
string ,
processingPriorityCode:
{
Description: The processing priority code. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberPrefix:
{
Description: The interchange control number prefix. ,
Required: False ,
}
string ,
interchangeControlNumberSuffix:
{
Description: The interchange control number suffix. ,
Required: False ,
}
string ,
senderReverseRoutingAddress:
{
Description: The sender reverse routing address. ,
Required: False ,
}
string ,
receiverReverseRoutingAddress:
{
Description: The receiver reverse routing address. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControllingAgencyCode:
{
Description: The group controlling agency code. ,
Required: False ,
}
string ,
groupMessageVersion:
{
Description: The group message version. ,
Required: False ,
}
string ,
groupMessageRelease:
{
Description: The group message release. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupControlNumberPrefix:
{
Description: The group control number prefix. ,
Required: False ,
}
string ,
groupControlNumberSuffix:
{
Description: The group control number suffix. ,
Required: False ,
}
string ,
groupApplicationReceiverQualifier:
{
Description: The group application receiver qualifier. ,
Required: False ,
}
string ,
groupApplicationReceiverId:
{
Description: The group application receiver id. ,
Required: False ,
}
string ,
groupApplicationSenderQualifier:
{
Description: The group application sender qualifier. ,
Required: False ,
}
string ,
groupApplicationSenderId:
{
Description: The group application sender id. ,
Required: False ,
}
string ,
groupApplicationPassword:
{
Description: The group application password. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: False ,
}
boolean ,
senderInternalIdentification:
{
Description: The sender internal identification. ,
Required: False ,
}
string ,
senderInternalSubIdentification:
{
Description: The sender internal sub identification. ,
Required: False ,
}
string ,
receiverInternalIdentification:
{
Description: The receiver internal identification. ,
Required: False ,
}
string ,
receiverInternalSubIdentification:
{
Description: The receiver internal sub identification. ,
Required: False ,
}
string ,
}
,
acknowledgementSettings:
{
Description: The EDIFACT acknowledgement settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The EDIFACT envelope override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationQualifier:
{
Description: The receiver application qualifier. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controllingAgencyCode:
{
Description: The controlling agency code. ,
Required: False ,
}
string ,
groupHeaderMessageVersion:
{
Description: The group header message version. ,
Required: False ,
}
string ,
groupHeaderMessageRelease:
{
Description: The group header message release. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
applicationPassword:
{
Description: The application password. ,
Required: False ,
}
string ,
}
,
]
,
messageFilterList:
{
Description: The EDIFACT message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
validationOverrides:
{
Description: The EDIFACT validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
}
,
]
,
edifactDelimiterOverrides:
{
Description: The EDIFACT delimiter override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
IntegrationAccountAgreements_Get (new)
Description :  Gets an integration account agreement.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/agreements/{agreementName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
agreementName:
{
Description: The integration account agreement name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The integration account agreement properties. ,
Required: False ,
}
{
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
agreementType:
{
Description: The agreement type. ,
Enum:
{
NotSpecified: No description available. ,
AS2: No description available. ,
X12: No description available. ,
Edifact: No description available. ,
}
,
Required: False ,
}
enum ,
hostPartner:
{
Description: The host partner. ,
Required: False ,
}
string ,
guestPartner:
{
Description: The guest partner. ,
Required: False ,
}
string ,
hostIdentity:
{
Description: The host identity. ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
guestIdentity:
{
Description: The guest identity. ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
content:
{
Description: The agreement content. ,
Required: False ,
}
{
AS2:
{
Description: The AS2 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The AS2 one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: False ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: False ,
}
{
needMdn:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signMdn:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: False ,
}
boolean ,
sendMdnAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: False ,
}
boolean ,
receiptDeliveryUrl:
{
Description: The receipt delivery URL. ,
Required: False ,
}
string ,
dispositionNotificationTo:
{
Description: The disposition notification to header value. ,
Required: False ,
}
string ,
signOutboundMdnIfOptional:
{
Description: The value indicating whether to sign the outbound MDN if optional. ,
Required: False ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMdnToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: False ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: False ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signingCertificateName:
{
Description: The name of the signing certificate. ,
Required: False ,
}
string ,
encryptionCertificateName:
{
Description: The name of the encryption certificate. ,
Required: False ,
}
string ,
enableNrrForInboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for inbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundMdn:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: False ,
}
boolean ,
enableNrrForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundMdn:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: False ,
}
boolean ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: False ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: False ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: False ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: False ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: False ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: False ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: False ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: False ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: The encryption algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
DES3: No description available. ,
RC2: No description available. ,
AES128: No description available. ,
AES192: No description available. ,
AES256: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: False ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: False ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: False ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: False ,
}
string ,
SuspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: False ,
}
boolean ,
AutogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: False ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: False ,
}
{
SuspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: False ,
}
boolean ,
ResendIfMdnNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
sendAgreement:
{
Description: The AS2 one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: False ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: False ,
}
{
needMdn:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signMdn:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: False ,
}
boolean ,
sendMdnAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: False ,
}
boolean ,
receiptDeliveryUrl:
{
Description: The receipt delivery URL. ,
Required: False ,
}
string ,
dispositionNotificationTo:
{
Description: The disposition notification to header value. ,
Required: False ,
}
string ,
signOutboundMdnIfOptional:
{
Description: The value indicating whether to sign the outbound MDN if optional. ,
Required: False ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMdnToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: False ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: False ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signingCertificateName:
{
Description: The name of the signing certificate. ,
Required: False ,
}
string ,
encryptionCertificateName:
{
Description: The name of the encryption certificate. ,
Required: False ,
}
string ,
enableNrrForInboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for inbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundMdn:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: False ,
}
boolean ,
enableNrrForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundMdn:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: False ,
}
boolean ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: False ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: False ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: False ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: False ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: False ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: False ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: False ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: False ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: The encryption algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
DES3: No description available. ,
RC2: No description available. ,
AES128: No description available. ,
AES192: No description available. ,
AES256: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: False ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: False ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: False ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: False ,
}
string ,
SuspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: False ,
}
boolean ,
AutogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: False ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: False ,
}
{
SuspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: False ,
}
boolean ,
ResendIfMdnNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
X12:
{
Description: The X12 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The X12 one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: False ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The X12 character set. ,
Enum:
{
NotSpecified: No description available. ,
Basic: No description available. ,
Extended: No description available. ,
UTF8: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: False ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: False ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: False ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: False ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
groupHeaderTimeFormat:
{
Description: The group header time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: False ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: False ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: False ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: False ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The X12 envelope override settings. ,
Required: False ,
}
[
{
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Format: int32 ,
Required: False ,
}
integer ,
headerVersion:
{
Description: The header version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
functionalIdentifierCode:
{
Description: The functional identifier code. ,
Required: False ,
}
string ,
dateFormat:
{
Description: The date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
timeFormat:
{
Description: The time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validationOverrides:
{
Description: The X12 validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
x12DelimiterOverrides:
{
Description: The X12 delimiter override settings. ,
Required: False ,
}
[
{
protocolVersion:
{
Description: The protocol version. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sendAgreement:
{
Description: The X12 one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: False ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The X12 character set. ,
Enum:
{
NotSpecified: No description available. ,
Basic: No description available. ,
Extended: No description available. ,
UTF8: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: False ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: False ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: False ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: False ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
groupHeaderTimeFormat:
{
Description: The group header time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: False ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: False ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: False ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: False ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The X12 envelope override settings. ,
Required: False ,
}
[
{
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Format: int32 ,
Required: False ,
}
integer ,
headerVersion:
{
Description: The header version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
functionalIdentifierCode:
{
Description: The functional identifier code. ,
Required: False ,
}
string ,
dateFormat:
{
Description: The date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
timeFormat:
{
Description: The time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validationOverrides:
{
Description: The X12 validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
x12DelimiterOverrides:
{
Description: The X12 delimiter override settings. ,
Required: False ,
}
[
{
protocolVersion:
{
Description: The protocol version. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
Edifact:
{
Description: The EDIFACT agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The EDIFACT one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: False ,
}
{
serviceCodeListDirectoryVersion:
{
Description: The service code list directory version. ,
Required: False ,
}
string ,
characterEncoding:
{
Description: The character encoding. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version. ,
Format: int32 ,
Required: False ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The EDIFACT frame setting characterSet. ,
Enum:
{
NotSpecified: No description available. ,
UNOB: No description available. ,
UNOA: No description available. ,
UNOC: No description available. ,
UNOD: No description available. ,
UNOE: No description available. ,
UNOF: No description available. ,
UNOG: No description available. ,
UNOH: No description available. ,
UNOI: No description available. ,
UNOJ: No description available. ,
UNOK: No description available. ,
UNOX: No description available. ,
UNOY: No description available. ,
KECA: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The EDIFACT frame setting segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: False ,
}
{
groupAssociationAssignedCode:
{
Description: The group association assigned code. ,
Required: False ,
}
string ,
communicationAgreementId:
{
Description: The communication agreement id. ,
Required: False ,
}
string ,
applyDelimiterStringAdvice:
{
Description: The value indicating whether to apply delimiter string advice. ,
Required: False ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
recipientReferencePasswordValue:
{
Description: The recipient reference password value. ,
Required: False ,
}
string ,
recipientReferencePasswordQualifier:
{
Description: The recipient reference password qualifier. ,
Required: False ,
}
string ,
applicationReferenceId:
{
Description: The application reference id. ,
Required: False ,
}
string ,
processingPriorityCode:
{
Description: The processing priority code. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberPrefix:
{
Description: The interchange control number prefix. ,
Required: False ,
}
string ,
interchangeControlNumberSuffix:
{
Description: The interchange control number suffix. ,
Required: False ,
}
string ,
senderReverseRoutingAddress:
{
Description: The sender reverse routing address. ,
Required: False ,
}
string ,
receiverReverseRoutingAddress:
{
Description: The receiver reverse routing address. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControllingAgencyCode:
{
Description: The group controlling agency code. ,
Required: False ,
}
string ,
groupMessageVersion:
{
Description: The group message version. ,
Required: False ,
}
string ,
groupMessageRelease:
{
Description: The group message release. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupControlNumberPrefix:
{
Description: The group control number prefix. ,
Required: False ,
}
string ,
groupControlNumberSuffix:
{
Description: The group control number suffix. ,
Required: False ,
}
string ,
groupApplicationReceiverQualifier:
{
Description: The group application receiver qualifier. ,
Required: False ,
}
string ,
groupApplicationReceiverId:
{
Description: The group application receiver id. ,
Required: False ,
}
string ,
groupApplicationSenderQualifier:
{
Description: The group application sender qualifier. ,
Required: False ,
}
string ,
groupApplicationSenderId:
{
Description: The group application sender id. ,
Required: False ,
}
string ,
groupApplicationPassword:
{
Description: The group application password. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: False ,
}
boolean ,
senderInternalIdentification:
{
Description: The sender internal identification. ,
Required: False ,
}
string ,
senderInternalSubIdentification:
{
Description: The sender internal sub identification. ,
Required: False ,
}
string ,
receiverInternalIdentification:
{
Description: The receiver internal identification. ,
Required: False ,
}
string ,
receiverInternalSubIdentification:
{
Description: The receiver internal sub identification. ,
Required: False ,
}
string ,
}
,
acknowledgementSettings:
{
Description: The EDIFACT acknowledgement settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The EDIFACT envelope override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationQualifier:
{
Description: The receiver application qualifier. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controllingAgencyCode:
{
Description: The controlling agency code. ,
Required: False ,
}
string ,
groupHeaderMessageVersion:
{
Description: The group header message version. ,
Required: False ,
}
string ,
groupHeaderMessageRelease:
{
Description: The group header message release. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
applicationPassword:
{
Description: The application password. ,
Required: False ,
}
string ,
}
,
]
,
messageFilterList:
{
Description: The EDIFACT message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
validationOverrides:
{
Description: The EDIFACT validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
}
,
]
,
edifactDelimiterOverrides:
{
Description: The EDIFACT delimiter override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sendAgreement:
{
Description: The EDIFACT one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: False ,
}
{
serviceCodeListDirectoryVersion:
{
Description: The service code list directory version. ,
Required: False ,
}
string ,
characterEncoding:
{
Description: The character encoding. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version. ,
Format: int32 ,
Required: False ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The EDIFACT frame setting characterSet. ,
Enum:
{
NotSpecified: No description available. ,
UNOB: No description available. ,
UNOA: No description available. ,
UNOC: No description available. ,
UNOD: No description available. ,
UNOE: No description available. ,
UNOF: No description available. ,
UNOG: No description available. ,
UNOH: No description available. ,
UNOI: No description available. ,
UNOJ: No description available. ,
UNOK: No description available. ,
UNOX: No description available. ,
UNOY: No description available. ,
KECA: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The EDIFACT frame setting segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: False ,
}
{
groupAssociationAssignedCode:
{
Description: The group association assigned code. ,
Required: False ,
}
string ,
communicationAgreementId:
{
Description: The communication agreement id. ,
Required: False ,
}
string ,
applyDelimiterStringAdvice:
{
Description: The value indicating whether to apply delimiter string advice. ,
Required: False ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
recipientReferencePasswordValue:
{
Description: The recipient reference password value. ,
Required: False ,
}
string ,
recipientReferencePasswordQualifier:
{
Description: The recipient reference password qualifier. ,
Required: False ,
}
string ,
applicationReferenceId:
{
Description: The application reference id. ,
Required: False ,
}
string ,
processingPriorityCode:
{
Description: The processing priority code. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberPrefix:
{
Description: The interchange control number prefix. ,
Required: False ,
}
string ,
interchangeControlNumberSuffix:
{
Description: The interchange control number suffix. ,
Required: False ,
}
string ,
senderReverseRoutingAddress:
{
Description: The sender reverse routing address. ,
Required: False ,
}
string ,
receiverReverseRoutingAddress:
{
Description: The receiver reverse routing address. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControllingAgencyCode:
{
Description: The group controlling agency code. ,
Required: False ,
}
string ,
groupMessageVersion:
{
Description: The group message version. ,
Required: False ,
}
string ,
groupMessageRelease:
{
Description: The group message release. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupControlNumberPrefix:
{
Description: The group control number prefix. ,
Required: False ,
}
string ,
groupControlNumberSuffix:
{
Description: The group control number suffix. ,
Required: False ,
}
string ,
groupApplicationReceiverQualifier:
{
Description: The group application receiver qualifier. ,
Required: False ,
}
string ,
groupApplicationReceiverId:
{
Description: The group application receiver id. ,
Required: False ,
}
string ,
groupApplicationSenderQualifier:
{
Description: The group application sender qualifier. ,
Required: False ,
}
string ,
groupApplicationSenderId:
{
Description: The group application sender id. ,
Required: False ,
}
string ,
groupApplicationPassword:
{
Description: The group application password. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: False ,
}
boolean ,
senderInternalIdentification:
{
Description: The sender internal identification. ,
Required: False ,
}
string ,
senderInternalSubIdentification:
{
Description: The sender internal sub identification. ,
Required: False ,
}
string ,
receiverInternalIdentification:
{
Description: The receiver internal identification. ,
Required: False ,
}
string ,
receiverInternalSubIdentification:
{
Description: The receiver internal sub identification. ,
Required: False ,
}
string ,
}
,
acknowledgementSettings:
{
Description: The EDIFACT acknowledgement settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The EDIFACT envelope override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationQualifier:
{
Description: The receiver application qualifier. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controllingAgencyCode:
{
Description: The controlling agency code. ,
Required: False ,
}
string ,
groupHeaderMessageVersion:
{
Description: The group header message version. ,
Required: False ,
}
string ,
groupHeaderMessageRelease:
{
Description: The group header message release. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
applicationPassword:
{
Description: The application password. ,
Required: False ,
}
string ,
}
,
]
,
messageFilterList:
{
Description: The EDIFACT message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
validationOverrides:
{
Description: The EDIFACT validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
}
,
]
,
edifactDelimiterOverrides:
{
Description: The EDIFACT delimiter override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}
,
}
,
}
IntegrationAccountAgreements_CreateOrUpdate (new)
Description :  Creates or updates an integration account agreement.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/agreements/{agreementName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
agreementName:
{
Description: The integration account agreement name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
agreement:
{
Description: The integration account agreement. ,
Required: True ,
}
{
properties:
{
Description: The integration account agreement properties. ,
Required: False ,
}
{
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
agreementType:
{
Description: The agreement type. ,
Enum:
{
NotSpecified: No description available. ,
AS2: No description available. ,
X12: No description available. ,
Edifact: No description available. ,
}
,
Required: False ,
}
enum ,
hostPartner:
{
Description: The host partner. ,
Required: False ,
}
string ,
guestPartner:
{
Description: The guest partner. ,
Required: False ,
}
string ,
hostIdentity:
{
Description: The host identity. ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
guestIdentity:
{
Description: The guest identity. ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
content:
{
Description: The agreement content. ,
Required: False ,
}
{
AS2:
{
Description: The AS2 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The AS2 one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: False ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: False ,
}
{
needMdn:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signMdn:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: False ,
}
boolean ,
sendMdnAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: False ,
}
boolean ,
receiptDeliveryUrl:
{
Description: The receipt delivery URL. ,
Required: False ,
}
string ,
dispositionNotificationTo:
{
Description: The disposition notification to header value. ,
Required: False ,
}
string ,
signOutboundMdnIfOptional:
{
Description: The value indicating whether to sign the outbound MDN if optional. ,
Required: False ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMdnToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: False ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: False ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signingCertificateName:
{
Description: The name of the signing certificate. ,
Required: False ,
}
string ,
encryptionCertificateName:
{
Description: The name of the encryption certificate. ,
Required: False ,
}
string ,
enableNrrForInboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for inbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundMdn:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: False ,
}
boolean ,
enableNrrForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundMdn:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: False ,
}
boolean ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: False ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: False ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: False ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: False ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: False ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: False ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: False ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: False ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: The encryption algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
DES3: No description available. ,
RC2: No description available. ,
AES128: No description available. ,
AES192: No description available. ,
AES256: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: False ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: False ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: False ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: False ,
}
string ,
SuspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: False ,
}
boolean ,
AutogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: False ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: False ,
}
{
SuspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: False ,
}
boolean ,
ResendIfMdnNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
sendAgreement:
{
Description: The AS2 one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: False ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: False ,
}
{
needMdn:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signMdn:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: False ,
}
boolean ,
sendMdnAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: False ,
}
boolean ,
receiptDeliveryUrl:
{
Description: The receipt delivery URL. ,
Required: False ,
}
string ,
dispositionNotificationTo:
{
Description: The disposition notification to header value. ,
Required: False ,
}
string ,
signOutboundMdnIfOptional:
{
Description: The value indicating whether to sign the outbound MDN if optional. ,
Required: False ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMdnToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: False ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: False ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signingCertificateName:
{
Description: The name of the signing certificate. ,
Required: False ,
}
string ,
encryptionCertificateName:
{
Description: The name of the encryption certificate. ,
Required: False ,
}
string ,
enableNrrForInboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for inbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundMdn:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: False ,
}
boolean ,
enableNrrForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundMdn:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: False ,
}
boolean ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: False ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: False ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: False ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: False ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: False ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: False ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: False ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: False ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: The encryption algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
DES3: No description available. ,
RC2: No description available. ,
AES128: No description available. ,
AES192: No description available. ,
AES256: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: False ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: False ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: False ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: False ,
}
string ,
SuspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: False ,
}
boolean ,
AutogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: False ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: False ,
}
{
SuspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: False ,
}
boolean ,
ResendIfMdnNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
X12:
{
Description: The X12 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The X12 one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: False ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The X12 character set. ,
Enum:
{
NotSpecified: No description available. ,
Basic: No description available. ,
Extended: No description available. ,
UTF8: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: False ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: False ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: False ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: False ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
groupHeaderTimeFormat:
{
Description: The group header time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: False ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: False ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: False ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: False ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The X12 envelope override settings. ,
Required: False ,
}
[
{
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Format: int32 ,
Required: False ,
}
integer ,
headerVersion:
{
Description: The header version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
functionalIdentifierCode:
{
Description: The functional identifier code. ,
Required: False ,
}
string ,
dateFormat:
{
Description: The date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
timeFormat:
{
Description: The time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validationOverrides:
{
Description: The X12 validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
x12DelimiterOverrides:
{
Description: The X12 delimiter override settings. ,
Required: False ,
}
[
{
protocolVersion:
{
Description: The protocol version. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sendAgreement:
{
Description: The X12 one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: False ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The X12 character set. ,
Enum:
{
NotSpecified: No description available. ,
Basic: No description available. ,
Extended: No description available. ,
UTF8: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: False ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: False ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: False ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: False ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
groupHeaderTimeFormat:
{
Description: The group header time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: False ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: False ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: False ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: False ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The X12 envelope override settings. ,
Required: False ,
}
[
{
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Format: int32 ,
Required: False ,
}
integer ,
headerVersion:
{
Description: The header version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
functionalIdentifierCode:
{
Description: The functional identifier code. ,
Required: False ,
}
string ,
dateFormat:
{
Description: The date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
timeFormat:
{
Description: The time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validationOverrides:
{
Description: The X12 validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
x12DelimiterOverrides:
{
Description: The X12 delimiter override settings. ,
Required: False ,
}
[
{
protocolVersion:
{
Description: The protocol version. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
Edifact:
{
Description: The EDIFACT agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The EDIFACT one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: False ,
}
{
serviceCodeListDirectoryVersion:
{
Description: The service code list directory version. ,
Required: False ,
}
string ,
characterEncoding:
{
Description: The character encoding. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version. ,
Format: int32 ,
Required: False ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The EDIFACT frame setting characterSet. ,
Enum:
{
NotSpecified: No description available. ,
UNOB: No description available. ,
UNOA: No description available. ,
UNOC: No description available. ,
UNOD: No description available. ,
UNOE: No description available. ,
UNOF: No description available. ,
UNOG: No description available. ,
UNOH: No description available. ,
UNOI: No description available. ,
UNOJ: No description available. ,
UNOK: No description available. ,
UNOX: No description available. ,
UNOY: No description available. ,
KECA: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The EDIFACT frame setting segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: False ,
}
{
groupAssociationAssignedCode:
{
Description: The group association assigned code. ,
Required: False ,
}
string ,
communicationAgreementId:
{
Description: The communication agreement id. ,
Required: False ,
}
string ,
applyDelimiterStringAdvice:
{
Description: The value indicating whether to apply delimiter string advice. ,
Required: False ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
recipientReferencePasswordValue:
{
Description: The recipient reference password value. ,
Required: False ,
}
string ,
recipientReferencePasswordQualifier:
{
Description: The recipient reference password qualifier. ,
Required: False ,
}
string ,
applicationReferenceId:
{
Description: The application reference id. ,
Required: False ,
}
string ,
processingPriorityCode:
{
Description: The processing priority code. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberPrefix:
{
Description: The interchange control number prefix. ,
Required: False ,
}
string ,
interchangeControlNumberSuffix:
{
Description: The interchange control number suffix. ,
Required: False ,
}
string ,
senderReverseRoutingAddress:
{
Description: The sender reverse routing address. ,
Required: False ,
}
string ,
receiverReverseRoutingAddress:
{
Description: The receiver reverse routing address. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControllingAgencyCode:
{
Description: The group controlling agency code. ,
Required: False ,
}
string ,
groupMessageVersion:
{
Description: The group message version. ,
Required: False ,
}
string ,
groupMessageRelease:
{
Description: The group message release. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupControlNumberPrefix:
{
Description: The group control number prefix. ,
Required: False ,
}
string ,
groupControlNumberSuffix:
{
Description: The group control number suffix. ,
Required: False ,
}
string ,
groupApplicationReceiverQualifier:
{
Description: The group application receiver qualifier. ,
Required: False ,
}
string ,
groupApplicationReceiverId:
{
Description: The group application receiver id. ,
Required: False ,
}
string ,
groupApplicationSenderQualifier:
{
Description: The group application sender qualifier. ,
Required: False ,
}
string ,
groupApplicationSenderId:
{
Description: The group application sender id. ,
Required: False ,
}
string ,
groupApplicationPassword:
{
Description: The group application password. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: False ,
}
boolean ,
senderInternalIdentification:
{
Description: The sender internal identification. ,
Required: False ,
}
string ,
senderInternalSubIdentification:
{
Description: The sender internal sub identification. ,
Required: False ,
}
string ,
receiverInternalIdentification:
{
Description: The receiver internal identification. ,
Required: False ,
}
string ,
receiverInternalSubIdentification:
{
Description: The receiver internal sub identification. ,
Required: False ,
}
string ,
}
,
acknowledgementSettings:
{
Description: The EDIFACT acknowledgement settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The EDIFACT envelope override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationQualifier:
{
Description: The receiver application qualifier. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controllingAgencyCode:
{
Description: The controlling agency code. ,
Required: False ,
}
string ,
groupHeaderMessageVersion:
{
Description: The group header message version. ,
Required: False ,
}
string ,
groupHeaderMessageRelease:
{
Description: The group header message release. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
applicationPassword:
{
Description: The application password. ,
Required: False ,
}
string ,
}
,
]
,
messageFilterList:
{
Description: The EDIFACT message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
validationOverrides:
{
Description: The EDIFACT validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
}
,
]
,
edifactDelimiterOverrides:
{
Description: The EDIFACT delimiter override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sendAgreement:
{
Description: The EDIFACT one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: False ,
}
{
serviceCodeListDirectoryVersion:
{
Description: The service code list directory version. ,
Required: False ,
}
string ,
characterEncoding:
{
Description: The character encoding. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version. ,
Format: int32 ,
Required: False ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The EDIFACT frame setting characterSet. ,
Enum:
{
NotSpecified: No description available. ,
UNOB: No description available. ,
UNOA: No description available. ,
UNOC: No description available. ,
UNOD: No description available. ,
UNOE: No description available. ,
UNOF: No description available. ,
UNOG: No description available. ,
UNOH: No description available. ,
UNOI: No description available. ,
UNOJ: No description available. ,
UNOK: No description available. ,
UNOX: No description available. ,
UNOY: No description available. ,
KECA: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The EDIFACT frame setting segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: False ,
}
{
groupAssociationAssignedCode:
{
Description: The group association assigned code. ,
Required: False ,
}
string ,
communicationAgreementId:
{
Description: The communication agreement id. ,
Required: False ,
}
string ,
applyDelimiterStringAdvice:
{
Description: The value indicating whether to apply delimiter string advice. ,
Required: False ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
recipientReferencePasswordValue:
{
Description: The recipient reference password value. ,
Required: False ,
}
string ,
recipientReferencePasswordQualifier:
{
Description: The recipient reference password qualifier. ,
Required: False ,
}
string ,
applicationReferenceId:
{
Description: The application reference id. ,
Required: False ,
}
string ,
processingPriorityCode:
{
Description: The processing priority code. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberPrefix:
{
Description: The interchange control number prefix. ,
Required: False ,
}
string ,
interchangeControlNumberSuffix:
{
Description: The interchange control number suffix. ,
Required: False ,
}
string ,
senderReverseRoutingAddress:
{
Description: The sender reverse routing address. ,
Required: False ,
}
string ,
receiverReverseRoutingAddress:
{
Description: The receiver reverse routing address. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControllingAgencyCode:
{
Description: The group controlling agency code. ,
Required: False ,
}
string ,
groupMessageVersion:
{
Description: The group message version. ,
Required: False ,
}
string ,
groupMessageRelease:
{
Description: The group message release. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupControlNumberPrefix:
{
Description: The group control number prefix. ,
Required: False ,
}
string ,
groupControlNumberSuffix:
{
Description: The group control number suffix. ,
Required: False ,
}
string ,
groupApplicationReceiverQualifier:
{
Description: The group application receiver qualifier. ,
Required: False ,
}
string ,
groupApplicationReceiverId:
{
Description: The group application receiver id. ,
Required: False ,
}
string ,
groupApplicationSenderQualifier:
{
Description: The group application sender qualifier. ,
Required: False ,
}
string ,
groupApplicationSenderId:
{
Description: The group application sender id. ,
Required: False ,
}
string ,
groupApplicationPassword:
{
Description: The group application password. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: False ,
}
boolean ,
senderInternalIdentification:
{
Description: The sender internal identification. ,
Required: False ,
}
string ,
senderInternalSubIdentification:
{
Description: The sender internal sub identification. ,
Required: False ,
}
string ,
receiverInternalIdentification:
{
Description: The receiver internal identification. ,
Required: False ,
}
string ,
receiverInternalSubIdentification:
{
Description: The receiver internal sub identification. ,
Required: False ,
}
string ,
}
,
acknowledgementSettings:
{
Description: The EDIFACT acknowledgement settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The EDIFACT envelope override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationQualifier:
{
Description: The receiver application qualifier. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controllingAgencyCode:
{
Description: The controlling agency code. ,
Required: False ,
}
string ,
groupHeaderMessageVersion:
{
Description: The group header message version. ,
Required: False ,
}
string ,
groupHeaderMessageRelease:
{
Description: The group header message release. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
applicationPassword:
{
Description: The application password. ,
Required: False ,
}
string ,
}
,
]
,
messageFilterList:
{
Description: The EDIFACT message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
validationOverrides:
{
Description: The EDIFACT validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
}
,
]
,
edifactDelimiterOverrides:
{
Description: The EDIFACT delimiter override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account agreement properties. ,
Required: False ,
}
{
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
agreementType:
{
Description: The agreement type. ,
Enum:
{
NotSpecified: No description available. ,
AS2: No description available. ,
X12: No description available. ,
Edifact: No description available. ,
}
,
Required: False ,
}
enum ,
hostPartner:
{
Description: The host partner. ,
Required: False ,
}
string ,
guestPartner:
{
Description: The guest partner. ,
Required: False ,
}
string ,
hostIdentity:
{
Description: The host identity. ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
guestIdentity:
{
Description: The guest identity. ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
content:
{
Description: The agreement content. ,
Required: False ,
}
{
AS2:
{
Description: The AS2 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The AS2 one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: False ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: False ,
}
{
needMdn:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signMdn:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: False ,
}
boolean ,
sendMdnAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: False ,
}
boolean ,
receiptDeliveryUrl:
{
Description: The receipt delivery URL. ,
Required: False ,
}
string ,
dispositionNotificationTo:
{
Description: The disposition notification to header value. ,
Required: False ,
}
string ,
signOutboundMdnIfOptional:
{
Description: The value indicating whether to sign the outbound MDN if optional. ,
Required: False ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMdnToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: False ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: False ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signingCertificateName:
{
Description: The name of the signing certificate. ,
Required: False ,
}
string ,
encryptionCertificateName:
{
Description: The name of the encryption certificate. ,
Required: False ,
}
string ,
enableNrrForInboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for inbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundMdn:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: False ,
}
boolean ,
enableNrrForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundMdn:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: False ,
}
boolean ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: False ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: False ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: False ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: False ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: False ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: False ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: False ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: False ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: The encryption algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
DES3: No description available. ,
RC2: No description available. ,
AES128: No description available. ,
AES192: No description available. ,
AES256: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: False ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: False ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: False ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: False ,
}
string ,
SuspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: False ,
}
boolean ,
AutogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: False ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: False ,
}
{
SuspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: False ,
}
boolean ,
ResendIfMdnNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
sendAgreement:
{
Description: The AS2 one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: False ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: False ,
}
{
needMdn:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signMdn:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: False ,
}
boolean ,
sendMdnAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: False ,
}
boolean ,
receiptDeliveryUrl:
{
Description: The receipt delivery URL. ,
Required: False ,
}
string ,
dispositionNotificationTo:
{
Description: The disposition notification to header value. ,
Required: False ,
}
string ,
signOutboundMdnIfOptional:
{
Description: The value indicating whether to sign the outbound MDN if optional. ,
Required: False ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMdnToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: False ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: False ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signingCertificateName:
{
Description: The name of the signing certificate. ,
Required: False ,
}
string ,
encryptionCertificateName:
{
Description: The name of the encryption certificate. ,
Required: False ,
}
string ,
enableNrrForInboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for inbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundMdn:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: False ,
}
boolean ,
enableNrrForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundMdn:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: False ,
}
boolean ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: False ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: False ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: False ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: False ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: False ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: False ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: False ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: False ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: The encryption algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
DES3: No description available. ,
RC2: No description available. ,
AES128: No description available. ,
AES192: No description available. ,
AES256: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: False ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: False ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: False ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: False ,
}
string ,
SuspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: False ,
}
boolean ,
AutogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: False ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: False ,
}
{
SuspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: False ,
}
boolean ,
ResendIfMdnNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
X12:
{
Description: The X12 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The X12 one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: False ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The X12 character set. ,
Enum:
{
NotSpecified: No description available. ,
Basic: No description available. ,
Extended: No description available. ,
UTF8: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: False ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: False ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: False ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: False ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
groupHeaderTimeFormat:
{
Description: The group header time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: False ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: False ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: False ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: False ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The X12 envelope override settings. ,
Required: False ,
}
[
{
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Format: int32 ,
Required: False ,
}
integer ,
headerVersion:
{
Description: The header version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
functionalIdentifierCode:
{
Description: The functional identifier code. ,
Required: False ,
}
string ,
dateFormat:
{
Description: The date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
timeFormat:
{
Description: The time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validationOverrides:
{
Description: The X12 validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
x12DelimiterOverrides:
{
Description: The X12 delimiter override settings. ,
Required: False ,
}
[
{
protocolVersion:
{
Description: The protocol version. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sendAgreement:
{
Description: The X12 one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: False ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The X12 character set. ,
Enum:
{
NotSpecified: No description available. ,
Basic: No description available. ,
Extended: No description available. ,
UTF8: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: False ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: False ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: False ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: False ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
groupHeaderTimeFormat:
{
Description: The group header time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: False ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: False ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: False ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: False ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The X12 envelope override settings. ,
Required: False ,
}
[
{
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Format: int32 ,
Required: False ,
}
integer ,
headerVersion:
{
Description: The header version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
functionalIdentifierCode:
{
Description: The functional identifier code. ,
Required: False ,
}
string ,
dateFormat:
{
Description: The date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
timeFormat:
{
Description: The time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validationOverrides:
{
Description: The X12 validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
x12DelimiterOverrides:
{
Description: The X12 delimiter override settings. ,
Required: False ,
}
[
{
protocolVersion:
{
Description: The protocol version. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
Edifact:
{
Description: The EDIFACT agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The EDIFACT one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: False ,
}
{
serviceCodeListDirectoryVersion:
{
Description: The service code list directory version. ,
Required: False ,
}
string ,
characterEncoding:
{
Description: The character encoding. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version. ,
Format: int32 ,
Required: False ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The EDIFACT frame setting characterSet. ,
Enum:
{
NotSpecified: No description available. ,
UNOB: No description available. ,
UNOA: No description available. ,
UNOC: No description available. ,
UNOD: No description available. ,
UNOE: No description available. ,
UNOF: No description available. ,
UNOG: No description available. ,
UNOH: No description available. ,
UNOI: No description available. ,
UNOJ: No description available. ,
UNOK: No description available. ,
UNOX: No description available. ,
UNOY: No description available. ,
KECA: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The EDIFACT frame setting segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: False ,
}
{
groupAssociationAssignedCode:
{
Description: The group association assigned code. ,
Required: False ,
}
string ,
communicationAgreementId:
{
Description: The communication agreement id. ,
Required: False ,
}
string ,
applyDelimiterStringAdvice:
{
Description: The value indicating whether to apply delimiter string advice. ,
Required: False ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
recipientReferencePasswordValue:
{
Description: The recipient reference password value. ,
Required: False ,
}
string ,
recipientReferencePasswordQualifier:
{
Description: The recipient reference password qualifier. ,
Required: False ,
}
string ,
applicationReferenceId:
{
Description: The application reference id. ,
Required: False ,
}
string ,
processingPriorityCode:
{
Description: The processing priority code. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberPrefix:
{
Description: The interchange control number prefix. ,
Required: False ,
}
string ,
interchangeControlNumberSuffix:
{
Description: The interchange control number suffix. ,
Required: False ,
}
string ,
senderReverseRoutingAddress:
{
Description: The sender reverse routing address. ,
Required: False ,
}
string ,
receiverReverseRoutingAddress:
{
Description: The receiver reverse routing address. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControllingAgencyCode:
{
Description: The group controlling agency code. ,
Required: False ,
}
string ,
groupMessageVersion:
{
Description: The group message version. ,
Required: False ,
}
string ,
groupMessageRelease:
{
Description: The group message release. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupControlNumberPrefix:
{
Description: The group control number prefix. ,
Required: False ,
}
string ,
groupControlNumberSuffix:
{
Description: The group control number suffix. ,
Required: False ,
}
string ,
groupApplicationReceiverQualifier:
{
Description: The group application receiver qualifier. ,
Required: False ,
}
string ,
groupApplicationReceiverId:
{
Description: The group application receiver id. ,
Required: False ,
}
string ,
groupApplicationSenderQualifier:
{
Description: The group application sender qualifier. ,
Required: False ,
}
string ,
groupApplicationSenderId:
{
Description: The group application sender id. ,
Required: False ,
}
string ,
groupApplicationPassword:
{
Description: The group application password. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: False ,
}
boolean ,
senderInternalIdentification:
{
Description: The sender internal identification. ,
Required: False ,
}
string ,
senderInternalSubIdentification:
{
Description: The sender internal sub identification. ,
Required: False ,
}
string ,
receiverInternalIdentification:
{
Description: The receiver internal identification. ,
Required: False ,
}
string ,
receiverInternalSubIdentification:
{
Description: The receiver internal sub identification. ,
Required: False ,
}
string ,
}
,
acknowledgementSettings:
{
Description: The EDIFACT acknowledgement settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The EDIFACT envelope override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationQualifier:
{
Description: The receiver application qualifier. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controllingAgencyCode:
{
Description: The controlling agency code. ,
Required: False ,
}
string ,
groupHeaderMessageVersion:
{
Description: The group header message version. ,
Required: False ,
}
string ,
groupHeaderMessageRelease:
{
Description: The group header message release. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
applicationPassword:
{
Description: The application password. ,
Required: False ,
}
string ,
}
,
]
,
messageFilterList:
{
Description: The EDIFACT message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
validationOverrides:
{
Description: The EDIFACT validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
}
,
]
,
edifactDelimiterOverrides:
{
Description: The EDIFACT delimiter override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sendAgreement:
{
Description: The EDIFACT one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: False ,
}
{
serviceCodeListDirectoryVersion:
{
Description: The service code list directory version. ,
Required: False ,
}
string ,
characterEncoding:
{
Description: The character encoding. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version. ,
Format: int32 ,
Required: False ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The EDIFACT frame setting characterSet. ,
Enum:
{
NotSpecified: No description available. ,
UNOB: No description available. ,
UNOA: No description available. ,
UNOC: No description available. ,
UNOD: No description available. ,
UNOE: No description available. ,
UNOF: No description available. ,
UNOG: No description available. ,
UNOH: No description available. ,
UNOI: No description available. ,
UNOJ: No description available. ,
UNOK: No description available. ,
UNOX: No description available. ,
UNOY: No description available. ,
KECA: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The EDIFACT frame setting segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: False ,
}
{
groupAssociationAssignedCode:
{
Description: The group association assigned code. ,
Required: False ,
}
string ,
communicationAgreementId:
{
Description: The communication agreement id. ,
Required: False ,
}
string ,
applyDelimiterStringAdvice:
{
Description: The value indicating whether to apply delimiter string advice. ,
Required: False ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
recipientReferencePasswordValue:
{
Description: The recipient reference password value. ,
Required: False ,
}
string ,
recipientReferencePasswordQualifier:
{
Description: The recipient reference password qualifier. ,
Required: False ,
}
string ,
applicationReferenceId:
{
Description: The application reference id. ,
Required: False ,
}
string ,
processingPriorityCode:
{
Description: The processing priority code. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberPrefix:
{
Description: The interchange control number prefix. ,
Required: False ,
}
string ,
interchangeControlNumberSuffix:
{
Description: The interchange control number suffix. ,
Required: False ,
}
string ,
senderReverseRoutingAddress:
{
Description: The sender reverse routing address. ,
Required: False ,
}
string ,
receiverReverseRoutingAddress:
{
Description: The receiver reverse routing address. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControllingAgencyCode:
{
Description: The group controlling agency code. ,
Required: False ,
}
string ,
groupMessageVersion:
{
Description: The group message version. ,
Required: False ,
}
string ,
groupMessageRelease:
{
Description: The group message release. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupControlNumberPrefix:
{
Description: The group control number prefix. ,
Required: False ,
}
string ,
groupControlNumberSuffix:
{
Description: The group control number suffix. ,
Required: False ,
}
string ,
groupApplicationReceiverQualifier:
{
Description: The group application receiver qualifier. ,
Required: False ,
}
string ,
groupApplicationReceiverId:
{
Description: The group application receiver id. ,
Required: False ,
}
string ,
groupApplicationSenderQualifier:
{
Description: The group application sender qualifier. ,
Required: False ,
}
string ,
groupApplicationSenderId:
{
Description: The group application sender id. ,
Required: False ,
}
string ,
groupApplicationPassword:
{
Description: The group application password. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: False ,
}
boolean ,
senderInternalIdentification:
{
Description: The sender internal identification. ,
Required: False ,
}
string ,
senderInternalSubIdentification:
{
Description: The sender internal sub identification. ,
Required: False ,
}
string ,
receiverInternalIdentification:
{
Description: The receiver internal identification. ,
Required: False ,
}
string ,
receiverInternalSubIdentification:
{
Description: The receiver internal sub identification. ,
Required: False ,
}
string ,
}
,
acknowledgementSettings:
{
Description: The EDIFACT acknowledgement settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The EDIFACT envelope override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationQualifier:
{
Description: The receiver application qualifier. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controllingAgencyCode:
{
Description: The controlling agency code. ,
Required: False ,
}
string ,
groupHeaderMessageVersion:
{
Description: The group header message version. ,
Required: False ,
}
string ,
groupHeaderMessageRelease:
{
Description: The group header message release. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
applicationPassword:
{
Description: The application password. ,
Required: False ,
}
string ,
}
,
]
,
messageFilterList:
{
Description: The EDIFACT message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
validationOverrides:
{
Description: The EDIFACT validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
}
,
]
,
edifactDelimiterOverrides:
{
Description: The EDIFACT delimiter override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration account agreement properties. ,
Required: False ,
}
{
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
agreementType:
{
Description: The agreement type. ,
Enum:
{
NotSpecified: No description available. ,
AS2: No description available. ,
X12: No description available. ,
Edifact: No description available. ,
}
,
Required: False ,
}
enum ,
hostPartner:
{
Description: The host partner. ,
Required: False ,
}
string ,
guestPartner:
{
Description: The guest partner. ,
Required: False ,
}
string ,
hostIdentity:
{
Description: The host identity. ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
guestIdentity:
{
Description: The guest identity. ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
content:
{
Description: The agreement content. ,
Required: False ,
}
{
AS2:
{
Description: The AS2 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The AS2 one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: False ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: False ,
}
{
needMdn:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signMdn:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: False ,
}
boolean ,
sendMdnAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: False ,
}
boolean ,
receiptDeliveryUrl:
{
Description: The receipt delivery URL. ,
Required: False ,
}
string ,
dispositionNotificationTo:
{
Description: The disposition notification to header value. ,
Required: False ,
}
string ,
signOutboundMdnIfOptional:
{
Description: The value indicating whether to sign the outbound MDN if optional. ,
Required: False ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMdnToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: False ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: False ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signingCertificateName:
{
Description: The name of the signing certificate. ,
Required: False ,
}
string ,
encryptionCertificateName:
{
Description: The name of the encryption certificate. ,
Required: False ,
}
string ,
enableNrrForInboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for inbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundMdn:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: False ,
}
boolean ,
enableNrrForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundMdn:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: False ,
}
boolean ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: False ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: False ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: False ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: False ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: False ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: False ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: False ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: False ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: The encryption algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
DES3: No description available. ,
RC2: No description available. ,
AES128: No description available. ,
AES192: No description available. ,
AES256: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: False ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: False ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: False ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: False ,
}
string ,
SuspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: False ,
}
boolean ,
AutogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: False ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: False ,
}
{
SuspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: False ,
}
boolean ,
ResendIfMdnNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
sendAgreement:
{
Description: The AS2 one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: False ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: False ,
}
{
needMdn:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signMdn:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: False ,
}
boolean ,
sendMdnAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: False ,
}
boolean ,
receiptDeliveryUrl:
{
Description: The receipt delivery URL. ,
Required: False ,
}
string ,
dispositionNotificationTo:
{
Description: The disposition notification to header value. ,
Required: False ,
}
string ,
signOutboundMdnIfOptional:
{
Description: The value indicating whether to sign the outbound MDN if optional. ,
Required: False ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMdnToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: False ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: False ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signingCertificateName:
{
Description: The name of the signing certificate. ,
Required: False ,
}
string ,
encryptionCertificateName:
{
Description: The name of the encryption certificate. ,
Required: False ,
}
string ,
enableNrrForInboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for inbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundMdn:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: False ,
}
boolean ,
enableNrrForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundMdn:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: False ,
}
boolean ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: False ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: False ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: False ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: False ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: False ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: False ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: False ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: False ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: The encryption algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
DES3: No description available. ,
RC2: No description available. ,
AES128: No description available. ,
AES192: No description available. ,
AES256: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: False ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: False ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: False ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: False ,
}
string ,
SuspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: False ,
}
boolean ,
AutogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: False ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: False ,
}
{
SuspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: False ,
}
boolean ,
ResendIfMdnNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
X12:
{
Description: The X12 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The X12 one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: False ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The X12 character set. ,
Enum:
{
NotSpecified: No description available. ,
Basic: No description available. ,
Extended: No description available. ,
UTF8: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: False ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: False ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: False ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: False ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
groupHeaderTimeFormat:
{
Description: The group header time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: False ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: False ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: False ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: False ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The X12 envelope override settings. ,
Required: False ,
}
[
{
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Format: int32 ,
Required: False ,
}
integer ,
headerVersion:
{
Description: The header version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
functionalIdentifierCode:
{
Description: The functional identifier code. ,
Required: False ,
}
string ,
dateFormat:
{
Description: The date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
timeFormat:
{
Description: The time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validationOverrides:
{
Description: The X12 validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
x12DelimiterOverrides:
{
Description: The X12 delimiter override settings. ,
Required: False ,
}
[
{
protocolVersion:
{
Description: The protocol version. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sendAgreement:
{
Description: The X12 one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: False ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The X12 character set. ,
Enum:
{
NotSpecified: No description available. ,
Basic: No description available. ,
Extended: No description available. ,
UTF8: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: False ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: False ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: False ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: False ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
groupHeaderTimeFormat:
{
Description: The group header time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: False ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: False ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: False ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: False ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The X12 envelope override settings. ,
Required: False ,
}
[
{
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Format: int32 ,
Required: False ,
}
integer ,
headerVersion:
{
Description: The header version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
functionalIdentifierCode:
{
Description: The functional identifier code. ,
Required: False ,
}
string ,
dateFormat:
{
Description: The date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
timeFormat:
{
Description: The time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validationOverrides:
{
Description: The X12 validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
x12DelimiterOverrides:
{
Description: The X12 delimiter override settings. ,
Required: False ,
}
[
{
protocolVersion:
{
Description: The protocol version. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
Edifact:
{
Description: The EDIFACT agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The EDIFACT one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: False ,
}
{
serviceCodeListDirectoryVersion:
{
Description: The service code list directory version. ,
Required: False ,
}
string ,
characterEncoding:
{
Description: The character encoding. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version. ,
Format: int32 ,
Required: False ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The EDIFACT frame setting characterSet. ,
Enum:
{
NotSpecified: No description available. ,
UNOB: No description available. ,
UNOA: No description available. ,
UNOC: No description available. ,
UNOD: No description available. ,
UNOE: No description available. ,
UNOF: No description available. ,
UNOG: No description available. ,
UNOH: No description available. ,
UNOI: No description available. ,
UNOJ: No description available. ,
UNOK: No description available. ,
UNOX: No description available. ,
UNOY: No description available. ,
KECA: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The EDIFACT frame setting segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: False ,
}
{
groupAssociationAssignedCode:
{
Description: The group association assigned code. ,
Required: False ,
}
string ,
communicationAgreementId:
{
Description: The communication agreement id. ,
Required: False ,
}
string ,
applyDelimiterStringAdvice:
{
Description: The value indicating whether to apply delimiter string advice. ,
Required: False ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
recipientReferencePasswordValue:
{
Description: The recipient reference password value. ,
Required: False ,
}
string ,
recipientReferencePasswordQualifier:
{
Description: The recipient reference password qualifier. ,
Required: False ,
}
string ,
applicationReferenceId:
{
Description: The application reference id. ,
Required: False ,
}
string ,
processingPriorityCode:
{
Description: The processing priority code. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberPrefix:
{
Description: The interchange control number prefix. ,
Required: False ,
}
string ,
interchangeControlNumberSuffix:
{
Description: The interchange control number suffix. ,
Required: False ,
}
string ,
senderReverseRoutingAddress:
{
Description: The sender reverse routing address. ,
Required: False ,
}
string ,
receiverReverseRoutingAddress:
{
Description: The receiver reverse routing address. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControllingAgencyCode:
{
Description: The group controlling agency code. ,
Required: False ,
}
string ,
groupMessageVersion:
{
Description: The group message version. ,
Required: False ,
}
string ,
groupMessageRelease:
{
Description: The group message release. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupControlNumberPrefix:
{
Description: The group control number prefix. ,
Required: False ,
}
string ,
groupControlNumberSuffix:
{
Description: The group control number suffix. ,
Required: False ,
}
string ,
groupApplicationReceiverQualifier:
{
Description: The group application receiver qualifier. ,
Required: False ,
}
string ,
groupApplicationReceiverId:
{
Description: The group application receiver id. ,
Required: False ,
}
string ,
groupApplicationSenderQualifier:
{
Description: The group application sender qualifier. ,
Required: False ,
}
string ,
groupApplicationSenderId:
{
Description: The group application sender id. ,
Required: False ,
}
string ,
groupApplicationPassword:
{
Description: The group application password. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: False ,
}
boolean ,
senderInternalIdentification:
{
Description: The sender internal identification. ,
Required: False ,
}
string ,
senderInternalSubIdentification:
{
Description: The sender internal sub identification. ,
Required: False ,
}
string ,
receiverInternalIdentification:
{
Description: The receiver internal identification. ,
Required: False ,
}
string ,
receiverInternalSubIdentification:
{
Description: The receiver internal sub identification. ,
Required: False ,
}
string ,
}
,
acknowledgementSettings:
{
Description: The EDIFACT acknowledgement settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The EDIFACT envelope override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationQualifier:
{
Description: The receiver application qualifier. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controllingAgencyCode:
{
Description: The controlling agency code. ,
Required: False ,
}
string ,
groupHeaderMessageVersion:
{
Description: The group header message version. ,
Required: False ,
}
string ,
groupHeaderMessageRelease:
{
Description: The group header message release. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
applicationPassword:
{
Description: The application password. ,
Required: False ,
}
string ,
}
,
]
,
messageFilterList:
{
Description: The EDIFACT message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
validationOverrides:
{
Description: The EDIFACT validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
}
,
]
,
edifactDelimiterOverrides:
{
Description: The EDIFACT delimiter override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sendAgreement:
{
Description: The EDIFACT one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: False ,
}
{
serviceCodeListDirectoryVersion:
{
Description: The service code list directory version. ,
Required: False ,
}
string ,
characterEncoding:
{
Description: The character encoding. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version. ,
Format: int32 ,
Required: False ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The EDIFACT frame setting characterSet. ,
Enum:
{
NotSpecified: No description available. ,
UNOB: No description available. ,
UNOA: No description available. ,
UNOC: No description available. ,
UNOD: No description available. ,
UNOE: No description available. ,
UNOF: No description available. ,
UNOG: No description available. ,
UNOH: No description available. ,
UNOI: No description available. ,
UNOJ: No description available. ,
UNOK: No description available. ,
UNOX: No description available. ,
UNOY: No description available. ,
KECA: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The EDIFACT frame setting segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: False ,
}
{
groupAssociationAssignedCode:
{
Description: The group association assigned code. ,
Required: False ,
}
string ,
communicationAgreementId:
{
Description: The communication agreement id. ,
Required: False ,
}
string ,
applyDelimiterStringAdvice:
{
Description: The value indicating whether to apply delimiter string advice. ,
Required: False ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
recipientReferencePasswordValue:
{
Description: The recipient reference password value. ,
Required: False ,
}
string ,
recipientReferencePasswordQualifier:
{
Description: The recipient reference password qualifier. ,
Required: False ,
}
string ,
applicationReferenceId:
{
Description: The application reference id. ,
Required: False ,
}
string ,
processingPriorityCode:
{
Description: The processing priority code. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberPrefix:
{
Description: The interchange control number prefix. ,
Required: False ,
}
string ,
interchangeControlNumberSuffix:
{
Description: The interchange control number suffix. ,
Required: False ,
}
string ,
senderReverseRoutingAddress:
{
Description: The sender reverse routing address. ,
Required: False ,
}
string ,
receiverReverseRoutingAddress:
{
Description: The receiver reverse routing address. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControllingAgencyCode:
{
Description: The group controlling agency code. ,
Required: False ,
}
string ,
groupMessageVersion:
{
Description: The group message version. ,
Required: False ,
}
string ,
groupMessageRelease:
{
Description: The group message release. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupControlNumberPrefix:
{
Description: The group control number prefix. ,
Required: False ,
}
string ,
groupControlNumberSuffix:
{
Description: The group control number suffix. ,
Required: False ,
}
string ,
groupApplicationReceiverQualifier:
{
Description: The group application receiver qualifier. ,
Required: False ,
}
string ,
groupApplicationReceiverId:
{
Description: The group application receiver id. ,
Required: False ,
}
string ,
groupApplicationSenderQualifier:
{
Description: The group application sender qualifier. ,
Required: False ,
}
string ,
groupApplicationSenderId:
{
Description: The group application sender id. ,
Required: False ,
}
string ,
groupApplicationPassword:
{
Description: The group application password. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: False ,
}
boolean ,
senderInternalIdentification:
{
Description: The sender internal identification. ,
Required: False ,
}
string ,
senderInternalSubIdentification:
{
Description: The sender internal sub identification. ,
Required: False ,
}
string ,
receiverInternalIdentification:
{
Description: The receiver internal identification. ,
Required: False ,
}
string ,
receiverInternalSubIdentification:
{
Description: The receiver internal sub identification. ,
Required: False ,
}
string ,
}
,
acknowledgementSettings:
{
Description: The EDIFACT acknowledgement settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The EDIFACT envelope override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationQualifier:
{
Description: The receiver application qualifier. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controllingAgencyCode:
{
Description: The controlling agency code. ,
Required: False ,
}
string ,
groupHeaderMessageVersion:
{
Description: The group header message version. ,
Required: False ,
}
string ,
groupHeaderMessageRelease:
{
Description: The group header message release. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
applicationPassword:
{
Description: The application password. ,
Required: False ,
}
string ,
}
,
]
,
messageFilterList:
{
Description: The EDIFACT message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
validationOverrides:
{
Description: The EDIFACT validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
}
,
]
,
edifactDelimiterOverrides:
{
Description: The EDIFACT delimiter override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}
,
}
,
}
IntegrationAccountAgreements_Delete (new)
Description :  Deletes an integration account agreement.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/agreements/{agreementName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
agreementName:
{
Description: The integration account agreement name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
IntegrationAccountCertificates_List (new)
Description :  Gets a list of integration account certificates.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/certificates
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration account certificates. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account certificate properties. ,
Required: False ,
}
{
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
key:
{
Description: The key details in the key vault. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: The private key name in key vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The private key version in key vault. ,
Required: False ,
}
string ,
}
,
publicCertificate:
{
Description: The public certificate. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
IntegrationAccountCertificates_Get (new)
Description :  Gets an integration account certificate.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/certificates/{certificateName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
certificateName:
{
Description: The integration account certificate name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The integration account certificate properties. ,
Required: False ,
}
{
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
key:
{
Description: The key details in the key vault. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: The private key name in key vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The private key version in key vault. ,
Required: False ,
}
string ,
}
,
publicCertificate:
{
Description: The public certificate. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountCertificates_CreateOrUpdate (new)
Description :  Creates or updates an integration account certificate.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/certificates/{certificateName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
certificateName:
{
Description: The integration account certificate name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
certificate:
{
Description: The integration account certificate. ,
Required: True ,
}
{
properties:
{
Description: The integration account certificate properties. ,
Required: False ,
}
{
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
key:
{
Description: The key details in the key vault. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: The private key name in key vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The private key version in key vault. ,
Required: False ,
}
string ,
}
,
publicCertificate:
{
Description: The public certificate. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account certificate properties. ,
Required: False ,
}
{
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
key:
{
Description: The key details in the key vault. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: The private key name in key vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The private key version in key vault. ,
Required: False ,
}
string ,
}
,
publicCertificate:
{
Description: The public certificate. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration account certificate properties. ,
Required: False ,
}
{
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
key:
{
Description: The key details in the key vault. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: The private key name in key vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The private key version in key vault. ,
Required: False ,
}
string ,
}
,
publicCertificate:
{
Description: The public certificate. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountCertificates_Delete (new)
Description :  Deletes an integration account certificate.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/certificates/{certificateName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
certificateName:
{
Description: The integration account certificate name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
IntegrationAccounts_ListBySubscription (removed)
Description :  Gets a list of integration accounts by subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Logic/integrationAccounts
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration accounts. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
object ,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Shared: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
IntegrationAccounts_ListByResourceGroup (removed)
Description :  Gets a list of integration accounts by resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration accounts. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
object ,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Shared: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
IntegrationAccounts_Get (removed)
Description :  Gets an integration account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
object ,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Shared: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
IntegrationAccounts_CreateOrUpdate (removed)
Description :  Creates or updates an integration account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
integrationAccount:
{
Description: The integration account. ,
Required: True ,
}
{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
object ,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Shared: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
object ,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Shared: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
object ,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Shared: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
IntegrationAccounts_Update (removed)
Description :  Updates an integration account.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
integrationAccount:
{
Description: The integration account. ,
Required: True ,
}
{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
object ,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Shared: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
object ,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Shared: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
IntegrationAccounts_Delete (removed)
Description :  Deletes an integration account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
IntegrationAccounts_ListCallbackUrl (removed)
Description :  Lists the integration account callback URL.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/listCallbackUrl
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
parameters:
{
Description: The callback URL parameters. ,
Required: True ,
}
{
NotAfter:
{
Description: The expiry time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The URL value. ,
Required: False ,
}
string ,
}
IntegrationAccountSchemas_List (removed)
Description :  Gets a list of integration account schemas.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/schemas
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration account schemas. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account schema properties. ,
Required: False ,
}
{
schemaType:
{
Description: The schema type. ,
Enum:
{
NotSpecified: No description available. ,
Xml: No description available. ,
}
,
Required: False ,
}
enum ,
targetNamespace:
{
Description: The target namespace. ,
Required: False ,
}
string ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
content:
{
Description: The content. ,
Required: False ,
}
object ,
contentType:
{
Description: The content type. ,
Required: False ,
}
string ,
contentLink:
{
Description: The content link. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The content hash algorithm. ,
Required: False ,
}
string ,
value:
{
Description: The content hash value. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
IntegrationAccountSchemas_Get (removed)
Description :  Gets an integration account schema.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/schemas/{schemaName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
schemaName:
{
Description: The integration account schema name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The integration account schema properties. ,
Required: False ,
}
{
schemaType:
{
Description: The schema type. ,
Enum:
{
NotSpecified: No description available. ,
Xml: No description available. ,
}
,
Required: False ,
}
enum ,
targetNamespace:
{
Description: The target namespace. ,
Required: False ,
}
string ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
content:
{
Description: The content. ,
Required: False ,
}
object ,
contentType:
{
Description: The content type. ,
Required: False ,
}
string ,
contentLink:
{
Description: The content link. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The content hash algorithm. ,
Required: False ,
}
string ,
value:
{
Description: The content hash value. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
IntegrationAccountSchemas_CreateOrUpdate (removed)
Description :  Creates or updates an integration account schema.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/schemas/{schemaName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
schemaName:
{
Description: The integration account schema name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
schema:
{
Description: The integration account schema. ,
Required: True ,
}
{
properties:
{
Description: The integration account schema properties. ,
Required: False ,
}
{
schemaType:
{
Description: The schema type. ,
Enum:
{
NotSpecified: No description available. ,
Xml: No description available. ,
}
,
Required: False ,
}
enum ,
targetNamespace:
{
Description: The target namespace. ,
Required: False ,
}
string ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
content:
{
Description: The content. ,
Required: False ,
}
object ,
contentType:
{
Description: The content type. ,
Required: False ,
}
string ,
contentLink:
{
Description: The content link. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The content hash algorithm. ,
Required: False ,
}
string ,
value:
{
Description: The content hash value. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account schema properties. ,
Required: False ,
}
{
schemaType:
{
Description: The schema type. ,
Enum:
{
NotSpecified: No description available. ,
Xml: No description available. ,
}
,
Required: False ,
}
enum ,
targetNamespace:
{
Description: The target namespace. ,
Required: False ,
}
string ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
content:
{
Description: The content. ,
Required: False ,
}
object ,
contentType:
{
Description: The content type. ,
Required: False ,
}
string ,
contentLink:
{
Description: The content link. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The content hash algorithm. ,
Required: False ,
}
string ,
value:
{
Description: The content hash value. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration account schema properties. ,
Required: False ,
}
{
schemaType:
{
Description: The schema type. ,
Enum:
{
NotSpecified: No description available. ,
Xml: No description available. ,
}
,
Required: False ,
}
enum ,
targetNamespace:
{
Description: The target namespace. ,
Required: False ,
}
string ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
content:
{
Description: The content. ,
Required: False ,
}
object ,
contentType:
{
Description: The content type. ,
Required: False ,
}
string ,
contentLink:
{
Description: The content link. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The content hash algorithm. ,
Required: False ,
}
string ,
value:
{
Description: The content hash value. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
IntegrationAccountSchemas_Delete (removed)
Description :  Deletes an integration account schema.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/schemas/{schemaName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
schemaName:
{
Description: The integration account schema name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
IntegrationAccountMaps_List (removed)
Description :  Gets a list of integration account maps.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/maps
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration account maps. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account map properties. ,
Required: False ,
}
{
mapType:
{
Description: The map type. ,
Enum:
{
NotSpecified: No description available. ,
Xslt: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
content:
{
Description: The content. ,
Required: False ,
}
object ,
contentType:
{
Description: The content type. ,
Required: False ,
}
string ,
contentLink:
{
Description: The content link. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The content hash algorithm. ,
Required: False ,
}
string ,
value:
{
Description: The content hash value. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
IntegrationAccountMaps_Get (removed)
Description :  Gets an integration account map.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/maps/{mapName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
mapName:
{
Description: The integration account map name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The integration account map properties. ,
Required: False ,
}
{
mapType:
{
Description: The map type. ,
Enum:
{
NotSpecified: No description available. ,
Xslt: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
content:
{
Description: The content. ,
Required: False ,
}
object ,
contentType:
{
Description: The content type. ,
Required: False ,
}
string ,
contentLink:
{
Description: The content link. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The content hash algorithm. ,
Required: False ,
}
string ,
value:
{
Description: The content hash value. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
IntegrationAccountMaps_CreateOrUpdate (removed)
Description :  Creates or updates an integration account map.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/maps/{mapName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
mapName:
{
Description: The integration account map name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
map:
{
Description: The integration account map. ,
Required: True ,
}
{
properties:
{
Description: The integration account map properties. ,
Required: False ,
}
{
mapType:
{
Description: The map type. ,
Enum:
{
NotSpecified: No description available. ,
Xslt: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
content:
{
Description: The content. ,
Required: False ,
}
object ,
contentType:
{
Description: The content type. ,
Required: False ,
}
string ,
contentLink:
{
Description: The content link. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The content hash algorithm. ,
Required: False ,
}
string ,
value:
{
Description: The content hash value. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account map properties. ,
Required: False ,
}
{
mapType:
{
Description: The map type. ,
Enum:
{
NotSpecified: No description available. ,
Xslt: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
content:
{
Description: The content. ,
Required: False ,
}
object ,
contentType:
{
Description: The content type. ,
Required: False ,
}
string ,
contentLink:
{
Description: The content link. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The content hash algorithm. ,
Required: False ,
}
string ,
value:
{
Description: The content hash value. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration account map properties. ,
Required: False ,
}
{
mapType:
{
Description: The map type. ,
Enum:
{
NotSpecified: No description available. ,
Xslt: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
content:
{
Description: The content. ,
Required: False ,
}
object ,
contentType:
{
Description: The content type. ,
Required: False ,
}
string ,
contentLink:
{
Description: The content link. ,
Required: False ,
}
{
uri:
{
Description: The content link URI. ,
Required: False ,
}
string ,
contentVersion:
{
Description: The content version. ,
Required: False ,
}
string ,
contentSize:
{
Description: The content size. ,
Format: int64 ,
Required: False ,
}
integer ,
contentHash:
{
Description: The content hash. ,
Required: False ,
}
{
algorithm:
{
Description: The content hash algorithm. ,
Required: False ,
}
string ,
value:
{
Description: The content hash value. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
IntegrationAccountMaps_Delete (removed)
Description :  Deletes an integration account map.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/maps/{mapName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
mapName:
{
Description: The integration account map name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
IntegrationAccountPartners_List (removed)
Description :  Gets a list of integration account partners.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/partners
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration account partners. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account partner properties. ,
Required: False ,
}
{
partnerType:
{
Description: The partner type. ,
Enum:
{
NotSpecified: No description available. ,
B2B: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
content:
{
Description: The partner content. ,
Required: False ,
}
{
b2b:
{
Description: The B2B partner content. ,
Required: False ,
}
{
businessIdentities:
{
Description: The list of partner business identities. ,
Required: False ,
}
[
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
IntegrationAccountPartners_Get (removed)
Description :  Gets an integration account partner.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/partners/{partnerName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
partnerName:
{
Description: The integration account partner name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The integration account partner properties. ,
Required: False ,
}
{
partnerType:
{
Description: The partner type. ,
Enum:
{
NotSpecified: No description available. ,
B2B: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
content:
{
Description: The partner content. ,
Required: False ,
}
{
b2b:
{
Description: The B2B partner content. ,
Required: False ,
}
{
businessIdentities:
{
Description: The list of partner business identities. ,
Required: False ,
}
[
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}
IntegrationAccountPartners_CreateOrUpdate (removed)
Description :  Creates or updates an integration account partner.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/partners/{partnerName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
partnerName:
{
Description: The integration account partner name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
partner:
{
Description: The integration account partner. ,
Required: True ,
}
{
properties:
{
Description: The integration account partner properties. ,
Required: False ,
}
{
partnerType:
{
Description: The partner type. ,
Enum:
{
NotSpecified: No description available. ,
B2B: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
content:
{
Description: The partner content. ,
Required: False ,
}
{
b2b:
{
Description: The B2B partner content. ,
Required: False ,
}
{
businessIdentities:
{
Description: The list of partner business identities. ,
Required: False ,
}
[
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account partner properties. ,
Required: False ,
}
{
partnerType:
{
Description: The partner type. ,
Enum:
{
NotSpecified: No description available. ,
B2B: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
content:
{
Description: The partner content. ,
Required: False ,
}
{
b2b:
{
Description: The B2B partner content. ,
Required: False ,
}
{
businessIdentities:
{
Description: The list of partner business identities. ,
Required: False ,
}
[
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration account partner properties. ,
Required: False ,
}
{
partnerType:
{
Description: The partner type. ,
Enum:
{
NotSpecified: No description available. ,
B2B: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
content:
{
Description: The partner content. ,
Required: False ,
}
{
b2b:
{
Description: The B2B partner content. ,
Required: False ,
}
{
businessIdentities:
{
Description: The list of partner business identities. ,
Required: False ,
}
[
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}
IntegrationAccountPartners_Delete (removed)
Description :  Deletes an integration account partner.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/partners/{partnerName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
partnerName:
{
Description: The integration account partner name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
IntegrationAccountAgreements_List (removed)
Description :  Gets a list of integration account agreements.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/agreements
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration account agreements. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account agreement properties. ,
Required: False ,
}
{
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
agreementType:
{
Description: The agreement type. ,
Enum:
{
NotSpecified: No description available. ,
AS2: No description available. ,
X12: No description available. ,
Edifact: No description available. ,
}
,
Required: False ,
}
enum ,
hostPartner:
{
Description: The host partner. ,
Required: False ,
}
string ,
guestPartner:
{
Description: The guest partner. ,
Required: False ,
}
string ,
hostIdentity:
{
Description: The host identity. ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
guestIdentity:
{
Description: The guest identity. ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
content:
{
Description: The agreement content. ,
Required: False ,
}
{
AS2:
{
Description: The AS2 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The AS2 one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: False ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: False ,
}
{
needMdn:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signMdn:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: False ,
}
boolean ,
sendMdnAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: False ,
}
boolean ,
receiptDeliveryUrl:
{
Description: The receipt delivery URL. ,
Required: False ,
}
string ,
dispositionNotificationTo:
{
Description: The disposition notification to header value. ,
Required: False ,
}
string ,
signOutboundMdnIfOptional:
{
Description: The value indicating whether to sign the outbound MDN if optional. ,
Required: False ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMdnToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: False ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: False ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signingCertificateName:
{
Description: The name of the signing certificate. ,
Required: False ,
}
string ,
encryptionCertificateName:
{
Description: The name of the encryption certificate. ,
Required: False ,
}
string ,
enableNrrForInboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for inbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundMdn:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: False ,
}
boolean ,
enableNrrForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundMdn:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: False ,
}
boolean ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: False ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: False ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: False ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: False ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: False ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: False ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: False ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: False ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: The encryption algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
DES3: No description available. ,
RC2: No description available. ,
AES128: No description available. ,
AES192: No description available. ,
AES256: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: False ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: False ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: False ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: False ,
}
string ,
SuspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: False ,
}
boolean ,
AutogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: False ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: False ,
}
{
SuspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: False ,
}
boolean ,
ResendIfMdnNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
sendAgreement:
{
Description: The AS2 one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: False ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: False ,
}
{
needMdn:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signMdn:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: False ,
}
boolean ,
sendMdnAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: False ,
}
boolean ,
receiptDeliveryUrl:
{
Description: The receipt delivery URL. ,
Required: False ,
}
string ,
dispositionNotificationTo:
{
Description: The disposition notification to header value. ,
Required: False ,
}
string ,
signOutboundMdnIfOptional:
{
Description: The value indicating whether to sign the outbound MDN if optional. ,
Required: False ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMdnToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: False ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: False ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signingCertificateName:
{
Description: The name of the signing certificate. ,
Required: False ,
}
string ,
encryptionCertificateName:
{
Description: The name of the encryption certificate. ,
Required: False ,
}
string ,
enableNrrForInboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for inbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundMdn:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: False ,
}
boolean ,
enableNrrForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundMdn:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: False ,
}
boolean ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: False ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: False ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: False ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: False ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: False ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: False ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: False ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: False ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: The encryption algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
DES3: No description available. ,
RC2: No description available. ,
AES128: No description available. ,
AES192: No description available. ,
AES256: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: False ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: False ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: False ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: False ,
}
string ,
SuspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: False ,
}
boolean ,
AutogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: False ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: False ,
}
{
SuspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: False ,
}
boolean ,
ResendIfMdnNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
X12:
{
Description: The X12 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The X12 one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: False ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The X12 character set. ,
Enum:
{
NotSpecified: No description available. ,
Basic: No description available. ,
Extended: No description available. ,
UTF8: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: False ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: False ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: False ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: False ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
groupHeaderTimeFormat:
{
Description: The group header time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: False ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: False ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: False ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: False ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The X12 envelope override settings. ,
Required: False ,
}
[
{
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Format: int32 ,
Required: False ,
}
integer ,
headerVersion:
{
Description: The header version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
functionalIdentifierCode:
{
Description: The functional identifier code. ,
Required: False ,
}
string ,
dateFormat:
{
Description: The date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
timeFormat:
{
Description: The time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validationOverrides:
{
Description: The X12 validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
x12DelimiterOverrides:
{
Description: The X12 delimiter override settings. ,
Required: False ,
}
[
{
protocolVersion:
{
Description: The protocol version. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sendAgreement:
{
Description: The X12 one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: False ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The X12 character set. ,
Enum:
{
NotSpecified: No description available. ,
Basic: No description available. ,
Extended: No description available. ,
UTF8: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: False ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: False ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: False ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: False ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
groupHeaderTimeFormat:
{
Description: The group header time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: False ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: False ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: False ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: False ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The X12 envelope override settings. ,
Required: False ,
}
[
{
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Format: int32 ,
Required: False ,
}
integer ,
headerVersion:
{
Description: The header version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
functionalIdentifierCode:
{
Description: The functional identifier code. ,
Required: False ,
}
string ,
dateFormat:
{
Description: The date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
timeFormat:
{
Description: The time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validationOverrides:
{
Description: The X12 validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
x12DelimiterOverrides:
{
Description: The X12 delimiter override settings. ,
Required: False ,
}
[
{
protocolVersion:
{
Description: The protocol version. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
Edifact:
{
Description: The EDIFACT agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The EDIFACT one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: False ,
}
{
serviceCodeListDirectoryVersion:
{
Description: The service code list directory version. ,
Required: False ,
}
string ,
characterEncoding:
{
Description: The character encoding. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version. ,
Format: int32 ,
Required: False ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The EDIFACT frame setting characterSet. ,
Enum:
{
NotSpecified: No description available. ,
UNOB: No description available. ,
UNOA: No description available. ,
UNOC: No description available. ,
UNOD: No description available. ,
UNOE: No description available. ,
UNOF: No description available. ,
UNOG: No description available. ,
UNOH: No description available. ,
UNOI: No description available. ,
UNOJ: No description available. ,
UNOK: No description available. ,
UNOX: No description available. ,
UNOY: No description available. ,
KECA: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The EDIFACT frame setting segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: False ,
}
{
groupAssociationAssignedCode:
{
Description: The group association assigned code. ,
Required: False ,
}
string ,
communicationAgreementId:
{
Description: The communication agreement id. ,
Required: False ,
}
string ,
applyDelimiterStringAdvice:
{
Description: The value indicating whether to apply delimiter string advice. ,
Required: False ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
recipientReferencePasswordValue:
{
Description: The recipient reference password value. ,
Required: False ,
}
string ,
recipientReferencePasswordQualifier:
{
Description: The recipient reference password qualifier. ,
Required: False ,
}
string ,
applicationReferenceId:
{
Description: The application reference id. ,
Required: False ,
}
string ,
processingPriorityCode:
{
Description: The processing priority code. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberPrefix:
{
Description: The interchange control number prefix. ,
Required: False ,
}
string ,
interchangeControlNumberSuffix:
{
Description: The interchange control number suffix. ,
Required: False ,
}
string ,
senderReverseRoutingAddress:
{
Description: The sender reverse routing address. ,
Required: False ,
}
string ,
receiverReverseRoutingAddress:
{
Description: The receiver reverse routing address. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControllingAgencyCode:
{
Description: The group controlling agency code. ,
Required: False ,
}
string ,
groupMessageVersion:
{
Description: The group message version. ,
Required: False ,
}
string ,
groupMessageRelease:
{
Description: The group message release. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupControlNumberPrefix:
{
Description: The group control number prefix. ,
Required: False ,
}
string ,
groupControlNumberSuffix:
{
Description: The group control number suffix. ,
Required: False ,
}
string ,
groupApplicationReceiverQualifier:
{
Description: The group application receiver qualifier. ,
Required: False ,
}
string ,
groupApplicationReceiverId:
{
Description: The group application receiver id. ,
Required: False ,
}
string ,
groupApplicationSenderQualifier:
{
Description: The group application sender qualifier. ,
Required: False ,
}
string ,
groupApplicationSenderId:
{
Description: The group application sender id. ,
Required: False ,
}
string ,
groupApplicationPassword:
{
Description: The group application password. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: False ,
}
boolean ,
senderInternalIdentification:
{
Description: The sender internal identification. ,
Required: False ,
}
string ,
senderInternalSubIdentification:
{
Description: The sender internal sub identification. ,
Required: False ,
}
string ,
receiverInternalIdentification:
{
Description: The receiver internal identification. ,
Required: False ,
}
string ,
receiverInternalSubIdentification:
{
Description: The receiver internal sub identification. ,
Required: False ,
}
string ,
}
,
acknowledgementSettings:
{
Description: The EDIFACT acknowledgement settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The EDIFACT envelope override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationQualifier:
{
Description: The receiver application qualifier. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controllingAgencyCode:
{
Description: The controlling agency code. ,
Required: False ,
}
string ,
groupHeaderMessageVersion:
{
Description: The group header message version. ,
Required: False ,
}
string ,
groupHeaderMessageRelease:
{
Description: The group header message release. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
applicationPassword:
{
Description: The application password. ,
Required: False ,
}
string ,
}
,
]
,
messageFilterList:
{
Description: The EDIFACT message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
validationOverrides:
{
Description: The EDIFACT validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
}
,
]
,
edifactDelimiterOverrides:
{
Description: The EDIFACT delimiter override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sendAgreement:
{
Description: The EDIFACT one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: False ,
}
{
serviceCodeListDirectoryVersion:
{
Description: The service code list directory version. ,
Required: False ,
}
string ,
characterEncoding:
{
Description: The character encoding. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version. ,
Format: int32 ,
Required: False ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The EDIFACT frame setting characterSet. ,
Enum:
{
NotSpecified: No description available. ,
UNOB: No description available. ,
UNOA: No description available. ,
UNOC: No description available. ,
UNOD: No description available. ,
UNOE: No description available. ,
UNOF: No description available. ,
UNOG: No description available. ,
UNOH: No description available. ,
UNOI: No description available. ,
UNOJ: No description available. ,
UNOK: No description available. ,
UNOX: No description available. ,
UNOY: No description available. ,
KECA: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The EDIFACT frame setting segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: False ,
}
{
groupAssociationAssignedCode:
{
Description: The group association assigned code. ,
Required: False ,
}
string ,
communicationAgreementId:
{
Description: The communication agreement id. ,
Required: False ,
}
string ,
applyDelimiterStringAdvice:
{
Description: The value indicating whether to apply delimiter string advice. ,
Required: False ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
recipientReferencePasswordValue:
{
Description: The recipient reference password value. ,
Required: False ,
}
string ,
recipientReferencePasswordQualifier:
{
Description: The recipient reference password qualifier. ,
Required: False ,
}
string ,
applicationReferenceId:
{
Description: The application reference id. ,
Required: False ,
}
string ,
processingPriorityCode:
{
Description: The processing priority code. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberPrefix:
{
Description: The interchange control number prefix. ,
Required: False ,
}
string ,
interchangeControlNumberSuffix:
{
Description: The interchange control number suffix. ,
Required: False ,
}
string ,
senderReverseRoutingAddress:
{
Description: The sender reverse routing address. ,
Required: False ,
}
string ,
receiverReverseRoutingAddress:
{
Description: The receiver reverse routing address. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControllingAgencyCode:
{
Description: The group controlling agency code. ,
Required: False ,
}
string ,
groupMessageVersion:
{
Description: The group message version. ,
Required: False ,
}
string ,
groupMessageRelease:
{
Description: The group message release. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupControlNumberPrefix:
{
Description: The group control number prefix. ,
Required: False ,
}
string ,
groupControlNumberSuffix:
{
Description: The group control number suffix. ,
Required: False ,
}
string ,
groupApplicationReceiverQualifier:
{
Description: The group application receiver qualifier. ,
Required: False ,
}
string ,
groupApplicationReceiverId:
{
Description: The group application receiver id. ,
Required: False ,
}
string ,
groupApplicationSenderQualifier:
{
Description: The group application sender qualifier. ,
Required: False ,
}
string ,
groupApplicationSenderId:
{
Description: The group application sender id. ,
Required: False ,
}
string ,
groupApplicationPassword:
{
Description: The group application password. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: False ,
}
boolean ,
senderInternalIdentification:
{
Description: The sender internal identification. ,
Required: False ,
}
string ,
senderInternalSubIdentification:
{
Description: The sender internal sub identification. ,
Required: False ,
}
string ,
receiverInternalIdentification:
{
Description: The receiver internal identification. ,
Required: False ,
}
string ,
receiverInternalSubIdentification:
{
Description: The receiver internal sub identification. ,
Required: False ,
}
string ,
}
,
acknowledgementSettings:
{
Description: The EDIFACT acknowledgement settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The EDIFACT envelope override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationQualifier:
{
Description: The receiver application qualifier. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controllingAgencyCode:
{
Description: The controlling agency code. ,
Required: False ,
}
string ,
groupHeaderMessageVersion:
{
Description: The group header message version. ,
Required: False ,
}
string ,
groupHeaderMessageRelease:
{
Description: The group header message release. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
applicationPassword:
{
Description: The application password. ,
Required: False ,
}
string ,
}
,
]
,
messageFilterList:
{
Description: The EDIFACT message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
validationOverrides:
{
Description: The EDIFACT validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
}
,
]
,
edifactDelimiterOverrides:
{
Description: The EDIFACT delimiter override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
IntegrationAccountAgreements_Get (removed)
Description :  Gets an integration account agreement.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/agreements/{agreementName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
agreementName:
{
Description: The integration account agreement name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The integration account agreement properties. ,
Required: False ,
}
{
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
agreementType:
{
Description: The agreement type. ,
Enum:
{
NotSpecified: No description available. ,
AS2: No description available. ,
X12: No description available. ,
Edifact: No description available. ,
}
,
Required: False ,
}
enum ,
hostPartner:
{
Description: The host partner. ,
Required: False ,
}
string ,
guestPartner:
{
Description: The guest partner. ,
Required: False ,
}
string ,
hostIdentity:
{
Description: The host identity. ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
guestIdentity:
{
Description: The guest identity. ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
content:
{
Description: The agreement content. ,
Required: False ,
}
{
AS2:
{
Description: The AS2 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The AS2 one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: False ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: False ,
}
{
needMdn:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signMdn:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: False ,
}
boolean ,
sendMdnAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: False ,
}
boolean ,
receiptDeliveryUrl:
{
Description: The receipt delivery URL. ,
Required: False ,
}
string ,
dispositionNotificationTo:
{
Description: The disposition notification to header value. ,
Required: False ,
}
string ,
signOutboundMdnIfOptional:
{
Description: The value indicating whether to sign the outbound MDN if optional. ,
Required: False ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMdnToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: False ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: False ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signingCertificateName:
{
Description: The name of the signing certificate. ,
Required: False ,
}
string ,
encryptionCertificateName:
{
Description: The name of the encryption certificate. ,
Required: False ,
}
string ,
enableNrrForInboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for inbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundMdn:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: False ,
}
boolean ,
enableNrrForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundMdn:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: False ,
}
boolean ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: False ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: False ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: False ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: False ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: False ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: False ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: False ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: False ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: The encryption algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
DES3: No description available. ,
RC2: No description available. ,
AES128: No description available. ,
AES192: No description available. ,
AES256: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: False ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: False ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: False ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: False ,
}
string ,
SuspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: False ,
}
boolean ,
AutogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: False ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: False ,
}
{
SuspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: False ,
}
boolean ,
ResendIfMdnNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
sendAgreement:
{
Description: The AS2 one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: False ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: False ,
}
{
needMdn:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signMdn:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: False ,
}
boolean ,
sendMdnAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: False ,
}
boolean ,
receiptDeliveryUrl:
{
Description: The receipt delivery URL. ,
Required: False ,
}
string ,
dispositionNotificationTo:
{
Description: The disposition notification to header value. ,
Required: False ,
}
string ,
signOutboundMdnIfOptional:
{
Description: The value indicating whether to sign the outbound MDN if optional. ,
Required: False ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMdnToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: False ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: False ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signingCertificateName:
{
Description: The name of the signing certificate. ,
Required: False ,
}
string ,
encryptionCertificateName:
{
Description: The name of the encryption certificate. ,
Required: False ,
}
string ,
enableNrrForInboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for inbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundMdn:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: False ,
}
boolean ,
enableNrrForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundMdn:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: False ,
}
boolean ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: False ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: False ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: False ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: False ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: False ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: False ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: False ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: False ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: The encryption algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
DES3: No description available. ,
RC2: No description available. ,
AES128: No description available. ,
AES192: No description available. ,
AES256: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: False ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: False ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: False ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: False ,
}
string ,
SuspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: False ,
}
boolean ,
AutogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: False ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: False ,
}
{
SuspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: False ,
}
boolean ,
ResendIfMdnNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
X12:
{
Description: The X12 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The X12 one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: False ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The X12 character set. ,
Enum:
{
NotSpecified: No description available. ,
Basic: No description available. ,
Extended: No description available. ,
UTF8: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: False ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: False ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: False ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: False ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
groupHeaderTimeFormat:
{
Description: The group header time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: False ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: False ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: False ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: False ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The X12 envelope override settings. ,
Required: False ,
}
[
{
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Format: int32 ,
Required: False ,
}
integer ,
headerVersion:
{
Description: The header version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
functionalIdentifierCode:
{
Description: The functional identifier code. ,
Required: False ,
}
string ,
dateFormat:
{
Description: The date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
timeFormat:
{
Description: The time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validationOverrides:
{
Description: The X12 validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
x12DelimiterOverrides:
{
Description: The X12 delimiter override settings. ,
Required: False ,
}
[
{
protocolVersion:
{
Description: The protocol version. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sendAgreement:
{
Description: The X12 one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: False ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The X12 character set. ,
Enum:
{
NotSpecified: No description available. ,
Basic: No description available. ,
Extended: No description available. ,
UTF8: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: False ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: False ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: False ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: False ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
groupHeaderTimeFormat:
{
Description: The group header time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: False ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: False ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: False ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: False ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The X12 envelope override settings. ,
Required: False ,
}
[
{
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Format: int32 ,
Required: False ,
}
integer ,
headerVersion:
{
Description: The header version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
functionalIdentifierCode:
{
Description: The functional identifier code. ,
Required: False ,
}
string ,
dateFormat:
{
Description: The date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
timeFormat:
{
Description: The time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validationOverrides:
{
Description: The X12 validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
x12DelimiterOverrides:
{
Description: The X12 delimiter override settings. ,
Required: False ,
}
[
{
protocolVersion:
{
Description: The protocol version. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
Edifact:
{
Description: The EDIFACT agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The EDIFACT one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: False ,
}
{
serviceCodeListDirectoryVersion:
{
Description: The service code list directory version. ,
Required: False ,
}
string ,
characterEncoding:
{
Description: The character encoding. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version. ,
Format: int32 ,
Required: False ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The EDIFACT frame setting characterSet. ,
Enum:
{
NotSpecified: No description available. ,
UNOB: No description available. ,
UNOA: No description available. ,
UNOC: No description available. ,
UNOD: No description available. ,
UNOE: No description available. ,
UNOF: No description available. ,
UNOG: No description available. ,
UNOH: No description available. ,
UNOI: No description available. ,
UNOJ: No description available. ,
UNOK: No description available. ,
UNOX: No description available. ,
UNOY: No description available. ,
KECA: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The EDIFACT frame setting segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: False ,
}
{
groupAssociationAssignedCode:
{
Description: The group association assigned code. ,
Required: False ,
}
string ,
communicationAgreementId:
{
Description: The communication agreement id. ,
Required: False ,
}
string ,
applyDelimiterStringAdvice:
{
Description: The value indicating whether to apply delimiter string advice. ,
Required: False ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
recipientReferencePasswordValue:
{
Description: The recipient reference password value. ,
Required: False ,
}
string ,
recipientReferencePasswordQualifier:
{
Description: The recipient reference password qualifier. ,
Required: False ,
}
string ,
applicationReferenceId:
{
Description: The application reference id. ,
Required: False ,
}
string ,
processingPriorityCode:
{
Description: The processing priority code. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberPrefix:
{
Description: The interchange control number prefix. ,
Required: False ,
}
string ,
interchangeControlNumberSuffix:
{
Description: The interchange control number suffix. ,
Required: False ,
}
string ,
senderReverseRoutingAddress:
{
Description: The sender reverse routing address. ,
Required: False ,
}
string ,
receiverReverseRoutingAddress:
{
Description: The receiver reverse routing address. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControllingAgencyCode:
{
Description: The group controlling agency code. ,
Required: False ,
}
string ,
groupMessageVersion:
{
Description: The group message version. ,
Required: False ,
}
string ,
groupMessageRelease:
{
Description: The group message release. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupControlNumberPrefix:
{
Description: The group control number prefix. ,
Required: False ,
}
string ,
groupControlNumberSuffix:
{
Description: The group control number suffix. ,
Required: False ,
}
string ,
groupApplicationReceiverQualifier:
{
Description: The group application receiver qualifier. ,
Required: False ,
}
string ,
groupApplicationReceiverId:
{
Description: The group application receiver id. ,
Required: False ,
}
string ,
groupApplicationSenderQualifier:
{
Description: The group application sender qualifier. ,
Required: False ,
}
string ,
groupApplicationSenderId:
{
Description: The group application sender id. ,
Required: False ,
}
string ,
groupApplicationPassword:
{
Description: The group application password. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: False ,
}
boolean ,
senderInternalIdentification:
{
Description: The sender internal identification. ,
Required: False ,
}
string ,
senderInternalSubIdentification:
{
Description: The sender internal sub identification. ,
Required: False ,
}
string ,
receiverInternalIdentification:
{
Description: The receiver internal identification. ,
Required: False ,
}
string ,
receiverInternalSubIdentification:
{
Description: The receiver internal sub identification. ,
Required: False ,
}
string ,
}
,
acknowledgementSettings:
{
Description: The EDIFACT acknowledgement settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The EDIFACT envelope override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationQualifier:
{
Description: The receiver application qualifier. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controllingAgencyCode:
{
Description: The controlling agency code. ,
Required: False ,
}
string ,
groupHeaderMessageVersion:
{
Description: The group header message version. ,
Required: False ,
}
string ,
groupHeaderMessageRelease:
{
Description: The group header message release. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
applicationPassword:
{
Description: The application password. ,
Required: False ,
}
string ,
}
,
]
,
messageFilterList:
{
Description: The EDIFACT message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
validationOverrides:
{
Description: The EDIFACT validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
}
,
]
,
edifactDelimiterOverrides:
{
Description: The EDIFACT delimiter override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sendAgreement:
{
Description: The EDIFACT one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: False ,
}
{
serviceCodeListDirectoryVersion:
{
Description: The service code list directory version. ,
Required: False ,
}
string ,
characterEncoding:
{
Description: The character encoding. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version. ,
Format: int32 ,
Required: False ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The EDIFACT frame setting characterSet. ,
Enum:
{
NotSpecified: No description available. ,
UNOB: No description available. ,
UNOA: No description available. ,
UNOC: No description available. ,
UNOD: No description available. ,
UNOE: No description available. ,
UNOF: No description available. ,
UNOG: No description available. ,
UNOH: No description available. ,
UNOI: No description available. ,
UNOJ: No description available. ,
UNOK: No description available. ,
UNOX: No description available. ,
UNOY: No description available. ,
KECA: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The EDIFACT frame setting segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: False ,
}
{
groupAssociationAssignedCode:
{
Description: The group association assigned code. ,
Required: False ,
}
string ,
communicationAgreementId:
{
Description: The communication agreement id. ,
Required: False ,
}
string ,
applyDelimiterStringAdvice:
{
Description: The value indicating whether to apply delimiter string advice. ,
Required: False ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
recipientReferencePasswordValue:
{
Description: The recipient reference password value. ,
Required: False ,
}
string ,
recipientReferencePasswordQualifier:
{
Description: The recipient reference password qualifier. ,
Required: False ,
}
string ,
applicationReferenceId:
{
Description: The application reference id. ,
Required: False ,
}
string ,
processingPriorityCode:
{
Description: The processing priority code. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberPrefix:
{
Description: The interchange control number prefix. ,
Required: False ,
}
string ,
interchangeControlNumberSuffix:
{
Description: The interchange control number suffix. ,
Required: False ,
}
string ,
senderReverseRoutingAddress:
{
Description: The sender reverse routing address. ,
Required: False ,
}
string ,
receiverReverseRoutingAddress:
{
Description: The receiver reverse routing address. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControllingAgencyCode:
{
Description: The group controlling agency code. ,
Required: False ,
}
string ,
groupMessageVersion:
{
Description: The group message version. ,
Required: False ,
}
string ,
groupMessageRelease:
{
Description: The group message release. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupControlNumberPrefix:
{
Description: The group control number prefix. ,
Required: False ,
}
string ,
groupControlNumberSuffix:
{
Description: The group control number suffix. ,
Required: False ,
}
string ,
groupApplicationReceiverQualifier:
{
Description: The group application receiver qualifier. ,
Required: False ,
}
string ,
groupApplicationReceiverId:
{
Description: The group application receiver id. ,
Required: False ,
}
string ,
groupApplicationSenderQualifier:
{
Description: The group application sender qualifier. ,
Required: False ,
}
string ,
groupApplicationSenderId:
{
Description: The group application sender id. ,
Required: False ,
}
string ,
groupApplicationPassword:
{
Description: The group application password. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: False ,
}
boolean ,
senderInternalIdentification:
{
Description: The sender internal identification. ,
Required: False ,
}
string ,
senderInternalSubIdentification:
{
Description: The sender internal sub identification. ,
Required: False ,
}
string ,
receiverInternalIdentification:
{
Description: The receiver internal identification. ,
Required: False ,
}
string ,
receiverInternalSubIdentification:
{
Description: The receiver internal sub identification. ,
Required: False ,
}
string ,
}
,
acknowledgementSettings:
{
Description: The EDIFACT acknowledgement settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The EDIFACT envelope override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationQualifier:
{
Description: The receiver application qualifier. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controllingAgencyCode:
{
Description: The controlling agency code. ,
Required: False ,
}
string ,
groupHeaderMessageVersion:
{
Description: The group header message version. ,
Required: False ,
}
string ,
groupHeaderMessageRelease:
{
Description: The group header message release. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
applicationPassword:
{
Description: The application password. ,
Required: False ,
}
string ,
}
,
]
,
messageFilterList:
{
Description: The EDIFACT message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
validationOverrides:
{
Description: The EDIFACT validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
}
,
]
,
edifactDelimiterOverrides:
{
Description: The EDIFACT delimiter override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}
,
}
,
}
IntegrationAccountAgreements_CreateOrUpdate (removed)
Description :  Creates or updates an integration account agreement.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/agreements/{agreementName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
agreementName:
{
Description: The integration account agreement name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
agreement:
{
Description: The integration account agreement. ,
Required: True ,
}
{
properties:
{
Description: The integration account agreement properties. ,
Required: False ,
}
{
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
agreementType:
{
Description: The agreement type. ,
Enum:
{
NotSpecified: No description available. ,
AS2: No description available. ,
X12: No description available. ,
Edifact: No description available. ,
}
,
Required: False ,
}
enum ,
hostPartner:
{
Description: The host partner. ,
Required: False ,
}
string ,
guestPartner:
{
Description: The guest partner. ,
Required: False ,
}
string ,
hostIdentity:
{
Description: The host identity. ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
guestIdentity:
{
Description: The guest identity. ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
content:
{
Description: The agreement content. ,
Required: False ,
}
{
AS2:
{
Description: The AS2 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The AS2 one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: False ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: False ,
}
{
needMdn:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signMdn:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: False ,
}
boolean ,
sendMdnAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: False ,
}
boolean ,
receiptDeliveryUrl:
{
Description: The receipt delivery URL. ,
Required: False ,
}
string ,
dispositionNotificationTo:
{
Description: The disposition notification to header value. ,
Required: False ,
}
string ,
signOutboundMdnIfOptional:
{
Description: The value indicating whether to sign the outbound MDN if optional. ,
Required: False ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMdnToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: False ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: False ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signingCertificateName:
{
Description: The name of the signing certificate. ,
Required: False ,
}
string ,
encryptionCertificateName:
{
Description: The name of the encryption certificate. ,
Required: False ,
}
string ,
enableNrrForInboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for inbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundMdn:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: False ,
}
boolean ,
enableNrrForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundMdn:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: False ,
}
boolean ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: False ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: False ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: False ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: False ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: False ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: False ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: False ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: False ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: The encryption algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
DES3: No description available. ,
RC2: No description available. ,
AES128: No description available. ,
AES192: No description available. ,
AES256: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: False ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: False ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: False ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: False ,
}
string ,
SuspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: False ,
}
boolean ,
AutogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: False ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: False ,
}
{
SuspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: False ,
}
boolean ,
ResendIfMdnNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
sendAgreement:
{
Description: The AS2 one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: False ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: False ,
}
{
needMdn:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signMdn:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: False ,
}
boolean ,
sendMdnAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: False ,
}
boolean ,
receiptDeliveryUrl:
{
Description: The receipt delivery URL. ,
Required: False ,
}
string ,
dispositionNotificationTo:
{
Description: The disposition notification to header value. ,
Required: False ,
}
string ,
signOutboundMdnIfOptional:
{
Description: The value indicating whether to sign the outbound MDN if optional. ,
Required: False ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMdnToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: False ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: False ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signingCertificateName:
{
Description: The name of the signing certificate. ,
Required: False ,
}
string ,
encryptionCertificateName:
{
Description: The name of the encryption certificate. ,
Required: False ,
}
string ,
enableNrrForInboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for inbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundMdn:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: False ,
}
boolean ,
enableNrrForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundMdn:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: False ,
}
boolean ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: False ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: False ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: False ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: False ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: False ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: False ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: False ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: False ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: The encryption algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
DES3: No description available. ,
RC2: No description available. ,
AES128: No description available. ,
AES192: No description available. ,
AES256: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: False ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: False ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: False ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: False ,
}
string ,
SuspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: False ,
}
boolean ,
AutogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: False ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: False ,
}
{
SuspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: False ,
}
boolean ,
ResendIfMdnNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
X12:
{
Description: The X12 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The X12 one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: False ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The X12 character set. ,
Enum:
{
NotSpecified: No description available. ,
Basic: No description available. ,
Extended: No description available. ,
UTF8: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: False ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: False ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: False ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: False ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
groupHeaderTimeFormat:
{
Description: The group header time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: False ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: False ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: False ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: False ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The X12 envelope override settings. ,
Required: False ,
}
[
{
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Format: int32 ,
Required: False ,
}
integer ,
headerVersion:
{
Description: The header version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
functionalIdentifierCode:
{
Description: The functional identifier code. ,
Required: False ,
}
string ,
dateFormat:
{
Description: The date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
timeFormat:
{
Description: The time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validationOverrides:
{
Description: The X12 validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
x12DelimiterOverrides:
{
Description: The X12 delimiter override settings. ,
Required: False ,
}
[
{
protocolVersion:
{
Description: The protocol version. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sendAgreement:
{
Description: The X12 one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: False ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The X12 character set. ,
Enum:
{
NotSpecified: No description available. ,
Basic: No description available. ,
Extended: No description available. ,
UTF8: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: False ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: False ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: False ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: False ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
groupHeaderTimeFormat:
{
Description: The group header time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: False ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: False ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: False ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: False ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The X12 envelope override settings. ,
Required: False ,
}
[
{
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Format: int32 ,
Required: False ,
}
integer ,
headerVersion:
{
Description: The header version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
functionalIdentifierCode:
{
Description: The functional identifier code. ,
Required: False ,
}
string ,
dateFormat:
{
Description: The date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
timeFormat:
{
Description: The time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validationOverrides:
{
Description: The X12 validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
x12DelimiterOverrides:
{
Description: The X12 delimiter override settings. ,
Required: False ,
}
[
{
protocolVersion:
{
Description: The protocol version. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
Edifact:
{
Description: The EDIFACT agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The EDIFACT one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: False ,
}
{
serviceCodeListDirectoryVersion:
{
Description: The service code list directory version. ,
Required: False ,
}
string ,
characterEncoding:
{
Description: The character encoding. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version. ,
Format: int32 ,
Required: False ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The EDIFACT frame setting characterSet. ,
Enum:
{
NotSpecified: No description available. ,
UNOB: No description available. ,
UNOA: No description available. ,
UNOC: No description available. ,
UNOD: No description available. ,
UNOE: No description available. ,
UNOF: No description available. ,
UNOG: No description available. ,
UNOH: No description available. ,
UNOI: No description available. ,
UNOJ: No description available. ,
UNOK: No description available. ,
UNOX: No description available. ,
UNOY: No description available. ,
KECA: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The EDIFACT frame setting segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: False ,
}
{
groupAssociationAssignedCode:
{
Description: The group association assigned code. ,
Required: False ,
}
string ,
communicationAgreementId:
{
Description: The communication agreement id. ,
Required: False ,
}
string ,
applyDelimiterStringAdvice:
{
Description: The value indicating whether to apply delimiter string advice. ,
Required: False ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
recipientReferencePasswordValue:
{
Description: The recipient reference password value. ,
Required: False ,
}
string ,
recipientReferencePasswordQualifier:
{
Description: The recipient reference password qualifier. ,
Required: False ,
}
string ,
applicationReferenceId:
{
Description: The application reference id. ,
Required: False ,
}
string ,
processingPriorityCode:
{
Description: The processing priority code. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberPrefix:
{
Description: The interchange control number prefix. ,
Required: False ,
}
string ,
interchangeControlNumberSuffix:
{
Description: The interchange control number suffix. ,
Required: False ,
}
string ,
senderReverseRoutingAddress:
{
Description: The sender reverse routing address. ,
Required: False ,
}
string ,
receiverReverseRoutingAddress:
{
Description: The receiver reverse routing address. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControllingAgencyCode:
{
Description: The group controlling agency code. ,
Required: False ,
}
string ,
groupMessageVersion:
{
Description: The group message version. ,
Required: False ,
}
string ,
groupMessageRelease:
{
Description: The group message release. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupControlNumberPrefix:
{
Description: The group control number prefix. ,
Required: False ,
}
string ,
groupControlNumberSuffix:
{
Description: The group control number suffix. ,
Required: False ,
}
string ,
groupApplicationReceiverQualifier:
{
Description: The group application receiver qualifier. ,
Required: False ,
}
string ,
groupApplicationReceiverId:
{
Description: The group application receiver id. ,
Required: False ,
}
string ,
groupApplicationSenderQualifier:
{
Description: The group application sender qualifier. ,
Required: False ,
}
string ,
groupApplicationSenderId:
{
Description: The group application sender id. ,
Required: False ,
}
string ,
groupApplicationPassword:
{
Description: The group application password. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: False ,
}
boolean ,
senderInternalIdentification:
{
Description: The sender internal identification. ,
Required: False ,
}
string ,
senderInternalSubIdentification:
{
Description: The sender internal sub identification. ,
Required: False ,
}
string ,
receiverInternalIdentification:
{
Description: The receiver internal identification. ,
Required: False ,
}
string ,
receiverInternalSubIdentification:
{
Description: The receiver internal sub identification. ,
Required: False ,
}
string ,
}
,
acknowledgementSettings:
{
Description: The EDIFACT acknowledgement settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The EDIFACT envelope override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationQualifier:
{
Description: The receiver application qualifier. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controllingAgencyCode:
{
Description: The controlling agency code. ,
Required: False ,
}
string ,
groupHeaderMessageVersion:
{
Description: The group header message version. ,
Required: False ,
}
string ,
groupHeaderMessageRelease:
{
Description: The group header message release. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
applicationPassword:
{
Description: The application password. ,
Required: False ,
}
string ,
}
,
]
,
messageFilterList:
{
Description: The EDIFACT message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
validationOverrides:
{
Description: The EDIFACT validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
}
,
]
,
edifactDelimiterOverrides:
{
Description: The EDIFACT delimiter override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sendAgreement:
{
Description: The EDIFACT one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: False ,
}
{
serviceCodeListDirectoryVersion:
{
Description: The service code list directory version. ,
Required: False ,
}
string ,
characterEncoding:
{
Description: The character encoding. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version. ,
Format: int32 ,
Required: False ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The EDIFACT frame setting characterSet. ,
Enum:
{
NotSpecified: No description available. ,
UNOB: No description available. ,
UNOA: No description available. ,
UNOC: No description available. ,
UNOD: No description available. ,
UNOE: No description available. ,
UNOF: No description available. ,
UNOG: No description available. ,
UNOH: No description available. ,
UNOI: No description available. ,
UNOJ: No description available. ,
UNOK: No description available. ,
UNOX: No description available. ,
UNOY: No description available. ,
KECA: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The EDIFACT frame setting segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: False ,
}
{
groupAssociationAssignedCode:
{
Description: The group association assigned code. ,
Required: False ,
}
string ,
communicationAgreementId:
{
Description: The communication agreement id. ,
Required: False ,
}
string ,
applyDelimiterStringAdvice:
{
Description: The value indicating whether to apply delimiter string advice. ,
Required: False ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
recipientReferencePasswordValue:
{
Description: The recipient reference password value. ,
Required: False ,
}
string ,
recipientReferencePasswordQualifier:
{
Description: The recipient reference password qualifier. ,
Required: False ,
}
string ,
applicationReferenceId:
{
Description: The application reference id. ,
Required: False ,
}
string ,
processingPriorityCode:
{
Description: The processing priority code. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberPrefix:
{
Description: The interchange control number prefix. ,
Required: False ,
}
string ,
interchangeControlNumberSuffix:
{
Description: The interchange control number suffix. ,
Required: False ,
}
string ,
senderReverseRoutingAddress:
{
Description: The sender reverse routing address. ,
Required: False ,
}
string ,
receiverReverseRoutingAddress:
{
Description: The receiver reverse routing address. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControllingAgencyCode:
{
Description: The group controlling agency code. ,
Required: False ,
}
string ,
groupMessageVersion:
{
Description: The group message version. ,
Required: False ,
}
string ,
groupMessageRelease:
{
Description: The group message release. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupControlNumberPrefix:
{
Description: The group control number prefix. ,
Required: False ,
}
string ,
groupControlNumberSuffix:
{
Description: The group control number suffix. ,
Required: False ,
}
string ,
groupApplicationReceiverQualifier:
{
Description: The group application receiver qualifier. ,
Required: False ,
}
string ,
groupApplicationReceiverId:
{
Description: The group application receiver id. ,
Required: False ,
}
string ,
groupApplicationSenderQualifier:
{
Description: The group application sender qualifier. ,
Required: False ,
}
string ,
groupApplicationSenderId:
{
Description: The group application sender id. ,
Required: False ,
}
string ,
groupApplicationPassword:
{
Description: The group application password. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: False ,
}
boolean ,
senderInternalIdentification:
{
Description: The sender internal identification. ,
Required: False ,
}
string ,
senderInternalSubIdentification:
{
Description: The sender internal sub identification. ,
Required: False ,
}
string ,
receiverInternalIdentification:
{
Description: The receiver internal identification. ,
Required: False ,
}
string ,
receiverInternalSubIdentification:
{
Description: The receiver internal sub identification. ,
Required: False ,
}
string ,
}
,
acknowledgementSettings:
{
Description: The EDIFACT acknowledgement settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The EDIFACT envelope override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationQualifier:
{
Description: The receiver application qualifier. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controllingAgencyCode:
{
Description: The controlling agency code. ,
Required: False ,
}
string ,
groupHeaderMessageVersion:
{
Description: The group header message version. ,
Required: False ,
}
string ,
groupHeaderMessageRelease:
{
Description: The group header message release. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
applicationPassword:
{
Description: The application password. ,
Required: False ,
}
string ,
}
,
]
,
messageFilterList:
{
Description: The EDIFACT message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
validationOverrides:
{
Description: The EDIFACT validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
}
,
]
,
edifactDelimiterOverrides:
{
Description: The EDIFACT delimiter override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account agreement properties. ,
Required: False ,
}
{
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
agreementType:
{
Description: The agreement type. ,
Enum:
{
NotSpecified: No description available. ,
AS2: No description available. ,
X12: No description available. ,
Edifact: No description available. ,
}
,
Required: False ,
}
enum ,
hostPartner:
{
Description: The host partner. ,
Required: False ,
}
string ,
guestPartner:
{
Description: The guest partner. ,
Required: False ,
}
string ,
hostIdentity:
{
Description: The host identity. ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
guestIdentity:
{
Description: The guest identity. ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
content:
{
Description: The agreement content. ,
Required: False ,
}
{
AS2:
{
Description: The AS2 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The AS2 one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: False ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: False ,
}
{
needMdn:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signMdn:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: False ,
}
boolean ,
sendMdnAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: False ,
}
boolean ,
receiptDeliveryUrl:
{
Description: The receipt delivery URL. ,
Required: False ,
}
string ,
dispositionNotificationTo:
{
Description: The disposition notification to header value. ,
Required: False ,
}
string ,
signOutboundMdnIfOptional:
{
Description: The value indicating whether to sign the outbound MDN if optional. ,
Required: False ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMdnToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: False ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: False ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signingCertificateName:
{
Description: The name of the signing certificate. ,
Required: False ,
}
string ,
encryptionCertificateName:
{
Description: The name of the encryption certificate. ,
Required: False ,
}
string ,
enableNrrForInboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for inbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundMdn:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: False ,
}
boolean ,
enableNrrForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundMdn:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: False ,
}
boolean ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: False ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: False ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: False ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: False ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: False ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: False ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: False ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: False ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: The encryption algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
DES3: No description available. ,
RC2: No description available. ,
AES128: No description available. ,
AES192: No description available. ,
AES256: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: False ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: False ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: False ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: False ,
}
string ,
SuspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: False ,
}
boolean ,
AutogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: False ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: False ,
}
{
SuspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: False ,
}
boolean ,
ResendIfMdnNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
sendAgreement:
{
Description: The AS2 one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: False ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: False ,
}
{
needMdn:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signMdn:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: False ,
}
boolean ,
sendMdnAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: False ,
}
boolean ,
receiptDeliveryUrl:
{
Description: The receipt delivery URL. ,
Required: False ,
}
string ,
dispositionNotificationTo:
{
Description: The disposition notification to header value. ,
Required: False ,
}
string ,
signOutboundMdnIfOptional:
{
Description: The value indicating whether to sign the outbound MDN if optional. ,
Required: False ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMdnToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: False ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: False ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signingCertificateName:
{
Description: The name of the signing certificate. ,
Required: False ,
}
string ,
encryptionCertificateName:
{
Description: The name of the encryption certificate. ,
Required: False ,
}
string ,
enableNrrForInboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for inbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundMdn:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: False ,
}
boolean ,
enableNrrForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundMdn:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: False ,
}
boolean ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: False ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: False ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: False ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: False ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: False ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: False ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: False ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: False ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: The encryption algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
DES3: No description available. ,
RC2: No description available. ,
AES128: No description available. ,
AES192: No description available. ,
AES256: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: False ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: False ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: False ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: False ,
}
string ,
SuspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: False ,
}
boolean ,
AutogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: False ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: False ,
}
{
SuspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: False ,
}
boolean ,
ResendIfMdnNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
X12:
{
Description: The X12 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The X12 one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: False ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The X12 character set. ,
Enum:
{
NotSpecified: No description available. ,
Basic: No description available. ,
Extended: No description available. ,
UTF8: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: False ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: False ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: False ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: False ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
groupHeaderTimeFormat:
{
Description: The group header time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: False ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: False ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: False ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: False ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The X12 envelope override settings. ,
Required: False ,
}
[
{
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Format: int32 ,
Required: False ,
}
integer ,
headerVersion:
{
Description: The header version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
functionalIdentifierCode:
{
Description: The functional identifier code. ,
Required: False ,
}
string ,
dateFormat:
{
Description: The date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
timeFormat:
{
Description: The time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validationOverrides:
{
Description: The X12 validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
x12DelimiterOverrides:
{
Description: The X12 delimiter override settings. ,
Required: False ,
}
[
{
protocolVersion:
{
Description: The protocol version. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sendAgreement:
{
Description: The X12 one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: False ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The X12 character set. ,
Enum:
{
NotSpecified: No description available. ,
Basic: No description available. ,
Extended: No description available. ,
UTF8: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: False ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: False ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: False ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: False ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
groupHeaderTimeFormat:
{
Description: The group header time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: False ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: False ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: False ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: False ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The X12 envelope override settings. ,
Required: False ,
}
[
{
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Format: int32 ,
Required: False ,
}
integer ,
headerVersion:
{
Description: The header version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
functionalIdentifierCode:
{
Description: The functional identifier code. ,
Required: False ,
}
string ,
dateFormat:
{
Description: The date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
timeFormat:
{
Description: The time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validationOverrides:
{
Description: The X12 validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
x12DelimiterOverrides:
{
Description: The X12 delimiter override settings. ,
Required: False ,
}
[
{
protocolVersion:
{
Description: The protocol version. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
Edifact:
{
Description: The EDIFACT agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The EDIFACT one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: False ,
}
{
serviceCodeListDirectoryVersion:
{
Description: The service code list directory version. ,
Required: False ,
}
string ,
characterEncoding:
{
Description: The character encoding. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version. ,
Format: int32 ,
Required: False ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The EDIFACT frame setting characterSet. ,
Enum:
{
NotSpecified: No description available. ,
UNOB: No description available. ,
UNOA: No description available. ,
UNOC: No description available. ,
UNOD: No description available. ,
UNOE: No description available. ,
UNOF: No description available. ,
UNOG: No description available. ,
UNOH: No description available. ,
UNOI: No description available. ,
UNOJ: No description available. ,
UNOK: No description available. ,
UNOX: No description available. ,
UNOY: No description available. ,
KECA: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The EDIFACT frame setting segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: False ,
}
{
groupAssociationAssignedCode:
{
Description: The group association assigned code. ,
Required: False ,
}
string ,
communicationAgreementId:
{
Description: The communication agreement id. ,
Required: False ,
}
string ,
applyDelimiterStringAdvice:
{
Description: The value indicating whether to apply delimiter string advice. ,
Required: False ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
recipientReferencePasswordValue:
{
Description: The recipient reference password value. ,
Required: False ,
}
string ,
recipientReferencePasswordQualifier:
{
Description: The recipient reference password qualifier. ,
Required: False ,
}
string ,
applicationReferenceId:
{
Description: The application reference id. ,
Required: False ,
}
string ,
processingPriorityCode:
{
Description: The processing priority code. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberPrefix:
{
Description: The interchange control number prefix. ,
Required: False ,
}
string ,
interchangeControlNumberSuffix:
{
Description: The interchange control number suffix. ,
Required: False ,
}
string ,
senderReverseRoutingAddress:
{
Description: The sender reverse routing address. ,
Required: False ,
}
string ,
receiverReverseRoutingAddress:
{
Description: The receiver reverse routing address. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControllingAgencyCode:
{
Description: The group controlling agency code. ,
Required: False ,
}
string ,
groupMessageVersion:
{
Description: The group message version. ,
Required: False ,
}
string ,
groupMessageRelease:
{
Description: The group message release. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupControlNumberPrefix:
{
Description: The group control number prefix. ,
Required: False ,
}
string ,
groupControlNumberSuffix:
{
Description: The group control number suffix. ,
Required: False ,
}
string ,
groupApplicationReceiverQualifier:
{
Description: The group application receiver qualifier. ,
Required: False ,
}
string ,
groupApplicationReceiverId:
{
Description: The group application receiver id. ,
Required: False ,
}
string ,
groupApplicationSenderQualifier:
{
Description: The group application sender qualifier. ,
Required: False ,
}
string ,
groupApplicationSenderId:
{
Description: The group application sender id. ,
Required: False ,
}
string ,
groupApplicationPassword:
{
Description: The group application password. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: False ,
}
boolean ,
senderInternalIdentification:
{
Description: The sender internal identification. ,
Required: False ,
}
string ,
senderInternalSubIdentification:
{
Description: The sender internal sub identification. ,
Required: False ,
}
string ,
receiverInternalIdentification:
{
Description: The receiver internal identification. ,
Required: False ,
}
string ,
receiverInternalSubIdentification:
{
Description: The receiver internal sub identification. ,
Required: False ,
}
string ,
}
,
acknowledgementSettings:
{
Description: The EDIFACT acknowledgement settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The EDIFACT envelope override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationQualifier:
{
Description: The receiver application qualifier. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controllingAgencyCode:
{
Description: The controlling agency code. ,
Required: False ,
}
string ,
groupHeaderMessageVersion:
{
Description: The group header message version. ,
Required: False ,
}
string ,
groupHeaderMessageRelease:
{
Description: The group header message release. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
applicationPassword:
{
Description: The application password. ,
Required: False ,
}
string ,
}
,
]
,
messageFilterList:
{
Description: The EDIFACT message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
validationOverrides:
{
Description: The EDIFACT validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
}
,
]
,
edifactDelimiterOverrides:
{
Description: The EDIFACT delimiter override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sendAgreement:
{
Description: The EDIFACT one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: False ,
}
{
serviceCodeListDirectoryVersion:
{
Description: The service code list directory version. ,
Required: False ,
}
string ,
characterEncoding:
{
Description: The character encoding. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version. ,
Format: int32 ,
Required: False ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The EDIFACT frame setting characterSet. ,
Enum:
{
NotSpecified: No description available. ,
UNOB: No description available. ,
UNOA: No description available. ,
UNOC: No description available. ,
UNOD: No description available. ,
UNOE: No description available. ,
UNOF: No description available. ,
UNOG: No description available. ,
UNOH: No description available. ,
UNOI: No description available. ,
UNOJ: No description available. ,
UNOK: No description available. ,
UNOX: No description available. ,
UNOY: No description available. ,
KECA: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The EDIFACT frame setting segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: False ,
}
{
groupAssociationAssignedCode:
{
Description: The group association assigned code. ,
Required: False ,
}
string ,
communicationAgreementId:
{
Description: The communication agreement id. ,
Required: False ,
}
string ,
applyDelimiterStringAdvice:
{
Description: The value indicating whether to apply delimiter string advice. ,
Required: False ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
recipientReferencePasswordValue:
{
Description: The recipient reference password value. ,
Required: False ,
}
string ,
recipientReferencePasswordQualifier:
{
Description: The recipient reference password qualifier. ,
Required: False ,
}
string ,
applicationReferenceId:
{
Description: The application reference id. ,
Required: False ,
}
string ,
processingPriorityCode:
{
Description: The processing priority code. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberPrefix:
{
Description: The interchange control number prefix. ,
Required: False ,
}
string ,
interchangeControlNumberSuffix:
{
Description: The interchange control number suffix. ,
Required: False ,
}
string ,
senderReverseRoutingAddress:
{
Description: The sender reverse routing address. ,
Required: False ,
}
string ,
receiverReverseRoutingAddress:
{
Description: The receiver reverse routing address. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControllingAgencyCode:
{
Description: The group controlling agency code. ,
Required: False ,
}
string ,
groupMessageVersion:
{
Description: The group message version. ,
Required: False ,
}
string ,
groupMessageRelease:
{
Description: The group message release. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupControlNumberPrefix:
{
Description: The group control number prefix. ,
Required: False ,
}
string ,
groupControlNumberSuffix:
{
Description: The group control number suffix. ,
Required: False ,
}
string ,
groupApplicationReceiverQualifier:
{
Description: The group application receiver qualifier. ,
Required: False ,
}
string ,
groupApplicationReceiverId:
{
Description: The group application receiver id. ,
Required: False ,
}
string ,
groupApplicationSenderQualifier:
{
Description: The group application sender qualifier. ,
Required: False ,
}
string ,
groupApplicationSenderId:
{
Description: The group application sender id. ,
Required: False ,
}
string ,
groupApplicationPassword:
{
Description: The group application password. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: False ,
}
boolean ,
senderInternalIdentification:
{
Description: The sender internal identification. ,
Required: False ,
}
string ,
senderInternalSubIdentification:
{
Description: The sender internal sub identification. ,
Required: False ,
}
string ,
receiverInternalIdentification:
{
Description: The receiver internal identification. ,
Required: False ,
}
string ,
receiverInternalSubIdentification:
{
Description: The receiver internal sub identification. ,
Required: False ,
}
string ,
}
,
acknowledgementSettings:
{
Description: The EDIFACT acknowledgement settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The EDIFACT envelope override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationQualifier:
{
Description: The receiver application qualifier. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controllingAgencyCode:
{
Description: The controlling agency code. ,
Required: False ,
}
string ,
groupHeaderMessageVersion:
{
Description: The group header message version. ,
Required: False ,
}
string ,
groupHeaderMessageRelease:
{
Description: The group header message release. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
applicationPassword:
{
Description: The application password. ,
Required: False ,
}
string ,
}
,
]
,
messageFilterList:
{
Description: The EDIFACT message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
validationOverrides:
{
Description: The EDIFACT validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
}
,
]
,
edifactDelimiterOverrides:
{
Description: The EDIFACT delimiter override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration account agreement properties. ,
Required: False ,
}
{
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
agreementType:
{
Description: The agreement type. ,
Enum:
{
NotSpecified: No description available. ,
AS2: No description available. ,
X12: No description available. ,
Edifact: No description available. ,
}
,
Required: False ,
}
enum ,
hostPartner:
{
Description: The host partner. ,
Required: False ,
}
string ,
guestPartner:
{
Description: The guest partner. ,
Required: False ,
}
string ,
hostIdentity:
{
Description: The host identity. ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
guestIdentity:
{
Description: The guest identity. ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
content:
{
Description: The agreement content. ,
Required: False ,
}
{
AS2:
{
Description: The AS2 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The AS2 one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: False ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: False ,
}
{
needMdn:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signMdn:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: False ,
}
boolean ,
sendMdnAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: False ,
}
boolean ,
receiptDeliveryUrl:
{
Description: The receipt delivery URL. ,
Required: False ,
}
string ,
dispositionNotificationTo:
{
Description: The disposition notification to header value. ,
Required: False ,
}
string ,
signOutboundMdnIfOptional:
{
Description: The value indicating whether to sign the outbound MDN if optional. ,
Required: False ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMdnToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: False ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: False ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signingCertificateName:
{
Description: The name of the signing certificate. ,
Required: False ,
}
string ,
encryptionCertificateName:
{
Description: The name of the encryption certificate. ,
Required: False ,
}
string ,
enableNrrForInboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for inbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundMdn:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: False ,
}
boolean ,
enableNrrForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundMdn:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: False ,
}
boolean ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: False ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: False ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: False ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: False ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: False ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: False ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: False ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: False ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: The encryption algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
DES3: No description available. ,
RC2: No description available. ,
AES128: No description available. ,
AES192: No description available. ,
AES256: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: False ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: False ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: False ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: False ,
}
string ,
SuspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: False ,
}
boolean ,
AutogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: False ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: False ,
}
{
SuspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: False ,
}
boolean ,
ResendIfMdnNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
sendAgreement:
{
Description: The AS2 one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: False ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: False ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: False ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: False ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: False ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: False ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: False ,
}
{
needMdn:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signMdn:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: False ,
}
boolean ,
sendMdnAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: False ,
}
boolean ,
receiptDeliveryUrl:
{
Description: The receipt delivery URL. ,
Required: False ,
}
string ,
dispositionNotificationTo:
{
Description: The disposition notification to header value. ,
Required: False ,
}
string ,
signOutboundMdnIfOptional:
{
Description: The value indicating whether to sign the outbound MDN if optional. ,
Required: False ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMdnToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: False ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: False ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: False ,
}
boolean ,
signingCertificateName:
{
Description: The name of the signing certificate. ,
Required: False ,
}
string ,
encryptionCertificateName:
{
Description: The name of the encryption certificate. ,
Required: False ,
}
string ,
enableNrrForInboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for inbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundMdn:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: False ,
}
boolean ,
enableNrrForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: False ,
}
boolean ,
enableNrrForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: False ,
}
boolean ,
enableNrrForInboundMdn:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: False ,
}
boolean ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: False ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: False ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: False ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: False ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: False ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: False ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: False ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: False ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: False ,
}
boolean ,
encryptionAlgorithm:
{
Description: The encryption algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
DES3: No description available. ,
RC2: No description available. ,
AES128: No description available. ,
AES192: No description available. ,
AES256: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: False ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: False ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: False ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: False ,
}
string ,
SuspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: False ,
}
boolean ,
AutogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: False ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: False ,
}
{
SuspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: False ,
}
boolean ,
ResendIfMdnNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: False ,
}
boolean ,
}
,
}
,
}
,
}
,
X12:
{
Description: The X12 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The X12 one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: False ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The X12 character set. ,
Enum:
{
NotSpecified: No description available. ,
Basic: No description available. ,
Extended: No description available. ,
UTF8: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: False ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: False ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: False ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: False ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
groupHeaderTimeFormat:
{
Description: The group header time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: False ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: False ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: False ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: False ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The X12 envelope override settings. ,
Required: False ,
}
[
{
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Format: int32 ,
Required: False ,
}
integer ,
headerVersion:
{
Description: The header version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
functionalIdentifierCode:
{
Description: The functional identifier code. ,
Required: False ,
}
string ,
dateFormat:
{
Description: The date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
timeFormat:
{
Description: The time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validationOverrides:
{
Description: The X12 validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
x12DelimiterOverrides:
{
Description: The X12 delimiter override settings. ,
Required: False ,
}
[
{
protocolVersion:
{
Description: The protocol version. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sendAgreement:
{
Description: The X12 one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: False ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The X12 character set. ,
Enum:
{
NotSpecified: No description available. ,
Basic: No description available. ,
Extended: No description available. ,
UTF8: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: False ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: False ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: False ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: False ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
groupHeaderTimeFormat:
{
Description: The group header time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: False ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: False ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: False ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: False ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The X12 envelope override settings. ,
Required: False ,
}
[
{
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Format: int32 ,
Required: False ,
}
integer ,
headerVersion:
{
Description: The header version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
functionalIdentifierCode:
{
Description: The functional identifier code. ,
Required: False ,
}
string ,
dateFormat:
{
Description: The date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: False ,
}
enum ,
timeFormat:
{
Description: The time format. ,
Enum:
{
NotSpecified: No description available. ,
HHMM: No description available. ,
HHMMSS: No description available. ,
HHMMSSdd: No description available. ,
HHMMSSd: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
validationOverrides:
{
Description: The X12 validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
x12DelimiterOverrides:
{
Description: The X12 delimiter override settings. ,
Required: False ,
}
[
{
protocolVersion:
{
Description: The protocol version. ,
Required: False ,
}
string ,
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: False ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: False ,
}
boolean ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
Edifact:
{
Description: The EDIFACT agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The EDIFACT one-way receive agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: False ,
}
{
serviceCodeListDirectoryVersion:
{
Description: The service code list directory version. ,
Required: False ,
}
string ,
characterEncoding:
{
Description: The character encoding. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version. ,
Format: int32 ,
Required: False ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The EDIFACT frame setting characterSet. ,
Enum:
{
NotSpecified: No description available. ,
UNOB: No description available. ,
UNOA: No description available. ,
UNOC: No description available. ,
UNOD: No description available. ,
UNOE: No description available. ,
UNOF: No description available. ,
UNOG: No description available. ,
UNOH: No description available. ,
UNOI: No description available. ,
UNOJ: No description available. ,
UNOK: No description available. ,
UNOX: No description available. ,
UNOY: No description available. ,
KECA: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The EDIFACT frame setting segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: False ,
}
{
groupAssociationAssignedCode:
{
Description: The group association assigned code. ,
Required: False ,
}
string ,
communicationAgreementId:
{
Description: The communication agreement id. ,
Required: False ,
}
string ,
applyDelimiterStringAdvice:
{
Description: The value indicating whether to apply delimiter string advice. ,
Required: False ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
recipientReferencePasswordValue:
{
Description: The recipient reference password value. ,
Required: False ,
}
string ,
recipientReferencePasswordQualifier:
{
Description: The recipient reference password qualifier. ,
Required: False ,
}
string ,
applicationReferenceId:
{
Description: The application reference id. ,
Required: False ,
}
string ,
processingPriorityCode:
{
Description: The processing priority code. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberPrefix:
{
Description: The interchange control number prefix. ,
Required: False ,
}
string ,
interchangeControlNumberSuffix:
{
Description: The interchange control number suffix. ,
Required: False ,
}
string ,
senderReverseRoutingAddress:
{
Description: The sender reverse routing address. ,
Required: False ,
}
string ,
receiverReverseRoutingAddress:
{
Description: The receiver reverse routing address. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControllingAgencyCode:
{
Description: The group controlling agency code. ,
Required: False ,
}
string ,
groupMessageVersion:
{
Description: The group message version. ,
Required: False ,
}
string ,
groupMessageRelease:
{
Description: The group message release. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupControlNumberPrefix:
{
Description: The group control number prefix. ,
Required: False ,
}
string ,
groupControlNumberSuffix:
{
Description: The group control number suffix. ,
Required: False ,
}
string ,
groupApplicationReceiverQualifier:
{
Description: The group application receiver qualifier. ,
Required: False ,
}
string ,
groupApplicationReceiverId:
{
Description: The group application receiver id. ,
Required: False ,
}
string ,
groupApplicationSenderQualifier:
{
Description: The group application sender qualifier. ,
Required: False ,
}
string ,
groupApplicationSenderId:
{
Description: The group application sender id. ,
Required: False ,
}
string ,
groupApplicationPassword:
{
Description: The group application password. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: False ,
}
boolean ,
senderInternalIdentification:
{
Description: The sender internal identification. ,
Required: False ,
}
string ,
senderInternalSubIdentification:
{
Description: The sender internal sub identification. ,
Required: False ,
}
string ,
receiverInternalIdentification:
{
Description: The receiver internal identification. ,
Required: False ,
}
string ,
receiverInternalSubIdentification:
{
Description: The receiver internal sub identification. ,
Required: False ,
}
string ,
}
,
acknowledgementSettings:
{
Description: The EDIFACT acknowledgement settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The EDIFACT envelope override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationQualifier:
{
Description: The receiver application qualifier. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controllingAgencyCode:
{
Description: The controlling agency code. ,
Required: False ,
}
string ,
groupHeaderMessageVersion:
{
Description: The group header message version. ,
Required: False ,
}
string ,
groupHeaderMessageRelease:
{
Description: The group header message release. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
applicationPassword:
{
Description: The application password. ,
Required: False ,
}
string ,
}
,
]
,
messageFilterList:
{
Description: The EDIFACT message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
validationOverrides:
{
Description: The EDIFACT validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
}
,
]
,
edifactDelimiterOverrides:
{
Description: The EDIFACT delimiter override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
sendAgreement:
{
Description: The EDIFACT one-way send agreement. ,
Required: False ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: False ,
}
{
Qualifier:
{
Description: The business identity qualifier. ,
Required: False ,
}
string ,
Value:
{
Description: The business identity value. ,
Required: False ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: False ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: False ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: False ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: False ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: False ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: False ,
}
{
serviceCodeListDirectoryVersion:
{
Description: The service code list directory version. ,
Required: False ,
}
string ,
characterEncoding:
{
Description: The character encoding. ,
Required: False ,
}
string ,
protocolVersion:
{
Description: The protocol version. ,
Format: int32 ,
Required: False ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
characterSet:
{
Description: The EDIFACT frame setting characterSet. ,
Enum:
{
NotSpecified: No description available. ,
UNOB: No description available. ,
UNOA: No description available. ,
UNOC: No description available. ,
UNOD: No description available. ,
UNOE: No description available. ,
UNOF: No description available. ,
UNOG: No description available. ,
UNOH: No description available. ,
UNOI: No description available. ,
UNOJ: No description available. ,
UNOK: No description available. ,
UNOX: No description available. ,
UNOY: No description available. ,
KECA: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
segmentTerminatorSuffix:
{
Description: The EDIFACT frame setting segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: False ,
}
{
groupAssociationAssignedCode:
{
Description: The group association assigned code. ,
Required: False ,
}
string ,
communicationAgreementId:
{
Description: The communication agreement id. ,
Required: False ,
}
string ,
applyDelimiterStringAdvice:
{
Description: The value indicating whether to apply delimiter string advice. ,
Required: False ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: False ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: False ,
}
boolean ,
recipientReferencePasswordValue:
{
Description: The recipient reference password value. ,
Required: False ,
}
string ,
recipientReferencePasswordQualifier:
{
Description: The recipient reference password qualifier. ,
Required: False ,
}
string ,
applicationReferenceId:
{
Description: The application reference id. ,
Required: False ,
}
string ,
processingPriorityCode:
{
Description: The processing priority code. ,
Required: False ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: False ,
}
boolean ,
interchangeControlNumberPrefix:
{
Description: The interchange control number prefix. ,
Required: False ,
}
string ,
interchangeControlNumberSuffix:
{
Description: The interchange control number suffix. ,
Required: False ,
}
string ,
senderReverseRoutingAddress:
{
Description: The sender reverse routing address. ,
Required: False ,
}
string ,
receiverReverseRoutingAddress:
{
Description: The receiver reverse routing address. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControllingAgencyCode:
{
Description: The group controlling agency code. ,
Required: False ,
}
string ,
groupMessageVersion:
{
Description: The group message version. ,
Required: False ,
}
string ,
groupMessageRelease:
{
Description: The group message release. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: False ,
}
boolean ,
groupControlNumberPrefix:
{
Description: The group control number prefix. ,
Required: False ,
}
string ,
groupControlNumberSuffix:
{
Description: The group control number suffix. ,
Required: False ,
}
string ,
groupApplicationReceiverQualifier:
{
Description: The group application receiver qualifier. ,
Required: False ,
}
string ,
groupApplicationReceiverId:
{
Description: The group application receiver id. ,
Required: False ,
}
string ,
groupApplicationSenderQualifier:
{
Description: The group application sender qualifier. ,
Required: False ,
}
string ,
groupApplicationSenderId:
{
Description: The group application sender id. ,
Required: False ,
}
string ,
groupApplicationPassword:
{
Description: The group application password. ,
Required: False ,
}
string ,
overwriteExistingTransactionSetControlNumber:
{
Description: The value indicating whether to overwrite existing transaction set control number. ,
Required: False ,
}
boolean ,
transactionSetControlNumberPrefix:
{
Description: The transaction set control number prefix. ,
Required: False ,
}
string ,
transactionSetControlNumberSuffix:
{
Description: The transaction set control number suffix. ,
Required: False ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int64 ,
Required: False ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: False ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: False ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: False ,
}
boolean ,
senderInternalIdentification:
{
Description: The sender internal identification. ,
Required: False ,
}
string ,
senderInternalSubIdentification:
{
Description: The sender internal sub identification. ,
Required: False ,
}
string ,
receiverInternalIdentification:
{
Description: The receiver internal identification. ,
Required: False ,
}
string ,
receiverInternalSubIdentification:
{
Description: The receiver internal sub identification. ,
Required: False ,
}
string ,
}
,
acknowledgementSettings:
{
Description: The EDIFACT acknowledgement settings. ,
Required: False ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: False ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: False ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: False ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: False ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: False ,
}
boolean ,
acknowledgementControlNumberPrefix:
{
Description: The acknowledgement control number prefix. ,
Required: False ,
}
string ,
acknowledgementControlNumberSuffix:
{
Description: The acknowledgement control number suffix. ,
Required: False ,
}
string ,
acknowledgementControlNumberLowerBound:
{
Description: The acknowledgement control number lower bound. ,
Format: int32 ,
Required: False ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: False ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: False ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: False ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: False ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: False ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: False ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: False ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: False ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: False ,
}
boolean ,
}
,
envelopeOverrides:
{
Description: The EDIFACT envelope override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
receiverApplicationQualifier:
{
Description: The receiver application qualifier. ,
Required: False ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: False ,
}
string ,
controllingAgencyCode:
{
Description: The controlling agency code. ,
Required: False ,
}
string ,
groupHeaderMessageVersion:
{
Description: The group header message version. ,
Required: False ,
}
string ,
groupHeaderMessageRelease:
{
Description: The group header message release. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
applicationPassword:
{
Description: The application password. ,
Required: False ,
}
string ,
}
,
]
,
messageFilterList:
{
Description: The EDIFACT message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
senderApplicationQualifier:
{
Description: The sender application qualifier. ,
Required: False ,
}
string ,
associationAssignedCode:
{
Description: The association assigned code. ,
Required: False ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: False ,
}
string ,
}
,
]
,
validationOverrides:
{
Description: The EDIFACT validation override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id on which the validation settings has to be applied. ,
Required: False ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: False ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: False ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: False ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
trailingSeparatorPolicy:
{
Description: The trailing separator policy. ,
Enum:
{
NotSpecified: No description available. ,
NotAllowed: No description available. ,
Optional: No description available. ,
Mandatory: No description available. ,
}
,
Required: False ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: False ,
}
boolean ,
}
,
]
,
edifactDelimiterOverrides:
{
Description: The EDIFACT delimiter override settings. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: False ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: False ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: False ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: False ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: False ,
}
integer ,
segmentTerminatorSuffix:
{
Description: The segment terminator suffix. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
CR: No description available. ,
LF: No description available. ,
CRLF: No description available. ,
}
,
Required: False ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: False ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: False ,
}
integer ,
messageAssociationAssignedCode:
{
Description: The message association assigned code. ,
Required: False ,
}
string ,
targetNamespace:
{
Description: The target namespace on which this delimiter settings has to be applied. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}
,
}
,
}
IntegrationAccountAgreements_Delete (removed)
Description :  Deletes an integration account agreement.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/agreements/{agreementName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
agreementName:
{
Description: The integration account agreement name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
IntegrationAccountCertificates_List (removed)
Description :  Gets a list of integration account certificates.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/certificates
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
$top:
{
Description: The number of items to be included in the result. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration account certificates. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account certificate properties. ,
Required: False ,
}
{
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
key:
{
Description: The key details in the key vault. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: The private key name in key vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The private key version in key vault. ,
Required: False ,
}
string ,
}
,
publicCertificate:
{
Description: The public certificate. ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}
IntegrationAccountCertificates_Get (removed)
Description :  Gets an integration account certificate.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/certificates/{certificateName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
certificateName:
{
Description: The integration account certificate name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The integration account certificate properties. ,
Required: False ,
}
{
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
key:
{
Description: The key details in the key vault. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: The private key name in key vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The private key version in key vault. ,
Required: False ,
}
string ,
}
,
publicCertificate:
{
Description: The public certificate. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountCertificates_CreateOrUpdate (removed)
Description :  Creates or updates an integration account certificate.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/certificates/{certificateName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
certificateName:
{
Description: The integration account certificate name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
certificate:
{
Description: The integration account certificate. ,
Required: True ,
}
{
properties:
{
Description: The integration account certificate properties. ,
Required: False ,
}
{
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
key:
{
Description: The key details in the key vault. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: The private key name in key vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The private key version in key vault. ,
Required: False ,
}
string ,
}
,
publicCertificate:
{
Description: The public certificate. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account certificate properties. ,
Required: False ,
}
{
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
key:
{
Description: The key details in the key vault. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: The private key name in key vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The private key version in key vault. ,
Required: False ,
}
string ,
}
,
publicCertificate:
{
Description: The public certificate. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration account certificate properties. ,
Required: False ,
}
{
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
key:
{
Description: The key details in the key vault. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: The resource name. ,
Required: False ,
}
string ,
type:
{
Description: The resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: The private key name in key vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: The private key version in key vault. ,
Required: False ,
}
string ,
}
,
publicCertificate:
{
Description: The public certificate. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountCertificates_Delete (removed)
Description :  Deletes an integration account certificate.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/certificates/{certificateName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationAccountName:
{
Description: The integration account name. ,
Required: True ,
}
string ,
certificateName:
{
Description: The integration account certificate name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}