Microsoft.Logic (stable:2019-05-01)

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

Workflows_ListBySubscription (new)
Description :  Gets a list of workflows by subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Logic/workflows
{
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 ,
$filter:
{
Description: The filter to apply on the operation. Options for filters include: State, Trigger, and ReferencedResourceId. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of workflows. ,
Required: False ,
}
[
{
properties:
{
Description: The workflow properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The 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: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_ListByResourceGroup (new)
Description :  Gets a list of workflows by resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows
{
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 ,
$filter:
{
Description: The filter to apply on the operation. Options for filters include: State, Trigger, and ReferencedResourceId. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of workflows. ,
Required: False ,
}
[
{
properties:
{
Description: The workflow properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The 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: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_Get (new)
Description :  Gets a workflow.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The workflow properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The 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: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_CreateOrUpdate (new)
Description :  Creates or updates a workflow.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
workflow:
{
Description: The workflow. ,
Required: True ,
}
{
properties:
{
Description: The workflow properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The 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: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The workflow properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The 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: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The workflow properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The 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: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_Update (new)
Description :  Updates a workflow.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workflow properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The 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: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_Delete (new)
Description :  Deletes a workflow.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_Disable (new)
Description :  Disables a workflow.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/disable
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_Enable (new)
Description :  Enables a workflow.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/enable
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_GenerateUpgradedDefinition (new)
Description :  Generates the upgraded definition for a workflow.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/generateUpgradedDefinition
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for generating an upgraded definition. ,
Required: True ,
}
{
targetSchemaVersion:
{
Description: The target schema version. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_ListCallbackUrl (new)
Description :  Get the workflow callback Url.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/listCallbackUrl
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
listCallbackUrl:
{
Description: Which callback url to list. ,
Required: True ,
}
{
notAfter:
{
Description: The expiry time. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: The key type. ,
Enum:
{
NotSpecified: No description available. ,
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the workflow trigger callback URL. ,
Required: False ,
}
string ,
method:
{
Description: Gets the workflow trigger callback URL HTTP method. ,
Required: False ,
}
string ,
basePath:
{
Description: Gets the workflow trigger callback URL base path. ,
Required: False ,
}
string ,
relativePath:
{
Description: Gets the workflow trigger callback URL relative path. ,
Required: False ,
}
string ,
relativePathParameters:
{
Description: Gets the workflow trigger callback URL relative path parameters. ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: Gets the workflow trigger callback URL query parameters. ,
Required: False ,
}
{
api-version:
{
Description: The api version. ,
Required: False ,
}
string ,
sp:
{
Description: The SAS permissions. ,
Required: False ,
}
string ,
sv:
{
Description: The SAS version. ,
Required: False ,
}
string ,
sig:
{
Description: The SAS signature. ,
Required: False ,
}
string ,
se:
{
Description: The SAS timestamp. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_ListSwagger (new)
Description :  Gets an OpenAPI definition for the workflow.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/listSwagger
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_Move (new)
Description :  Moves an existing workflow.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/move
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
move:
{
Description: The workflow to move. ,
Required: True ,
}
{
name:
{
Description: The workflow name. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_RegenerateAccessKey (new)
Description :  Regenerates the callback URL access key for request triggers.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/regenerateAccessKey
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
keyType:
{
Description: The access key type. ,
Required: True ,
}
{
keyType:
{
Description: The key type. ,
Enum:
{
NotSpecified: No description available. ,
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_ValidateByResourceGroup (new)
Description :  Validates the workflow.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/validate
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
validate:
{
Description: The workflow. ,
Required: True ,
}
{
properties:
{
Description: The workflow properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The 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: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowVersions_List (new)
Description :  Gets a list of workflow versions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/versions
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow 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: A list of workflow versions. ,
Required: False ,
}
[
{
properties:
{
Description: The workflow version properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The 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: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowVersions_Get (new)
Description :  Gets a workflow version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/versions/{versionId}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
versionId:
{
Description: The workflow versionId. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workflow version properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The 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: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggers_List (new)
Description :  Gets a list of workflow triggers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow 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: A list of workflow triggers. ,
Required: False ,
}
[
{
properties:
{
Description: The workflow trigger properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Gets the state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
lastExecutionTime:
{
Description: Gets the last execution time. ,
Format: date-time ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Gets the next execution time. ,
Format: date-time ,
Required: False ,
}
string ,
recurrence:
{
Description: Gets the workflow trigger recurrence. ,
Required: False ,
}
{
frequency:
{
Description: The frequency. ,
Enum:
{
NotSpecified: No description available. ,
Second: No description available. ,
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
Year: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone. ,
Required: False ,
}
string ,
schedule:
{
Description: The recurrence schedule. ,
Required: False ,
}
{
minutes:
{
Description: The minutes. ,
Required: False ,
}
[
integer ,
]
,
hours:
{
Description: The hours. ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: The month days. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: The monthly occurrences. ,
Required: False ,
}
[
{
day:
{
Description: The day of the week. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
occurrence:
{
Description: The occurrence. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
workflow:
{
Description: Gets the reference to workflow. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Gets the workflow trigger name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow trigger type. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggers_Get (new)
Description :  Gets a workflow trigger.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workflow trigger properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Gets the state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
lastExecutionTime:
{
Description: Gets the last execution time. ,
Format: date-time ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Gets the next execution time. ,
Format: date-time ,
Required: False ,
}
string ,
recurrence:
{
Description: Gets the workflow trigger recurrence. ,
Required: False ,
}
{
frequency:
{
Description: The frequency. ,
Enum:
{
NotSpecified: No description available. ,
Second: No description available. ,
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
Year: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone. ,
Required: False ,
}
string ,
schedule:
{
Description: The recurrence schedule. ,
Required: False ,
}
{
minutes:
{
Description: The minutes. ,
Required: False ,
}
[
integer ,
]
,
hours:
{
Description: The hours. ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: The month days. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: The monthly occurrences. ,
Required: False ,
}
[
{
day:
{
Description: The day of the week. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
occurrence:
{
Description: The occurrence. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
workflow:
{
Description: Gets the reference to workflow. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Gets the workflow trigger name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow trigger type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggers_Reset (new)
Description :  Resets a workflow trigger.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/reset
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggers_Run (new)
Description :  Runs a workflow trigger.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/run
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggers_GetSchemaJson (new)
Description :  Get the trigger schema as JSON.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/schemas/json
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
title:
{
Description: The JSON title. ,
Required: False ,
}
string ,
content:
{
Description: The JSON content. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggers_SetState (new)
Description :  Sets the state of a workflow trigger.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/setState
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
setState:
{
Description: The workflow trigger state. ,
Required: True ,
}
{
source:
{
Description: The source. ,
Required: True ,
}
{
name:
{
Description: The workflow trigger resource reference name. ,
Required: False ,
}
string ,
flowName:
{
Description: The workflow name. ,
Required: False ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggers_ListCallbackUrl (new)
Description :  Get the callback URL for a workflow trigger.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/listCallbackUrl
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the workflow trigger callback URL. ,
Required: False ,
}
string ,
method:
{
Description: Gets the workflow trigger callback URL HTTP method. ,
Required: False ,
}
string ,
basePath:
{
Description: Gets the workflow trigger callback URL base path. ,
Required: False ,
}
string ,
relativePath:
{
Description: Gets the workflow trigger callback URL relative path. ,
Required: False ,
}
string ,
relativePathParameters:
{
Description: Gets the workflow trigger callback URL relative path parameters. ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: Gets the workflow trigger callback URL query parameters. ,
Required: False ,
}
{
api-version:
{
Description: The api version. ,
Required: False ,
}
string ,
sp:
{
Description: The SAS permissions. ,
Required: False ,
}
string ,
sv:
{
Description: The SAS version. ,
Required: False ,
}
string ,
sig:
{
Description: The SAS signature. ,
Required: False ,
}
string ,
se:
{
Description: The SAS timestamp. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowVersionTriggers_ListCallbackUrl (new)
Description :  Get the callback url for a trigger of a workflow version.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/versions/{versionId}/triggers/{triggerName}/listCallbackUrl
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
versionId:
{
Description: The workflow versionId. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
parameters:
{
Description: The callback URL parameters. ,
Required: False ,
}
{
notAfter:
{
Description: The expiry time. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: The key type. ,
Enum:
{
NotSpecified: No description available. ,
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the workflow trigger callback URL. ,
Required: False ,
}
string ,
method:
{
Description: Gets the workflow trigger callback URL HTTP method. ,
Required: False ,
}
string ,
basePath:
{
Description: Gets the workflow trigger callback URL base path. ,
Required: False ,
}
string ,
relativePath:
{
Description: Gets the workflow trigger callback URL relative path. ,
Required: False ,
}
string ,
relativePathParameters:
{
Description: Gets the workflow trigger callback URL relative path parameters. ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: Gets the workflow trigger callback URL query parameters. ,
Required: False ,
}
{
api-version:
{
Description: The api version. ,
Required: False ,
}
string ,
sp:
{
Description: The SAS permissions. ,
Required: False ,
}
string ,
sv:
{
Description: The SAS version. ,
Required: False ,
}
string ,
sig:
{
Description: The SAS signature. ,
Required: False ,
}
string ,
se:
{
Description: The SAS timestamp. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggerHistories_List (new)
Description :  Gets a list of workflow trigger histories.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/histories
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger 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. Options for filters include: Status, StartTime, and ClientTrackingId. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workflow trigger histories. ,
Required: False ,
}
[
{
properties:
{
Description: Gets the workflow trigger history properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
scheduledTime:
{
Description: The scheduled time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
inputsLink:
{
Description: Gets the link to input parameters. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputsLink:
{
Description: Gets the link to output parameters. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
fired:
{
Description: The value indicating whether trigger was fired. ,
Required: False ,
}
boolean ,
run:
{
Description: Gets the reference to workflow run. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Gets the workflow trigger history name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow trigger history type. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggerHistories_Get (new)
Description :  Gets a workflow trigger history.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
historyName:
{
Description: The workflow trigger history name. Corresponds to the run name for triggers that resulted in a run. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets the workflow trigger history properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
scheduledTime:
{
Description: The scheduled time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
inputsLink:
{
Description: Gets the link to input parameters. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputsLink:
{
Description: Gets the link to output parameters. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
fired:
{
Description: The value indicating whether trigger was fired. ,
Required: False ,
}
boolean ,
run:
{
Description: Gets the reference to workflow run. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Gets the workflow trigger history name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow trigger history type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggerHistories_Resubmit (new)
Description :  Resubmits a workflow run based on the trigger history.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName}/resubmit
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
historyName:
{
Description: The workflow trigger history name. Corresponds to the run name for triggers that resulted in a run. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRuns_List (new)
Description :  Gets a list of workflow runs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow 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. Options for filters include: Status, StartTime, and ClientTrackingId. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workflow runs. ,
Required: False ,
}
[
{
properties:
{
Description: The workflow run properties. ,
Required: False ,
}
{
waitEndTime:
{
Description: Gets the wait end time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
correlationId:
{
Description: Gets the correlation id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
workflow:
{
Description: Gets the reference to workflow version. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: Gets the fired trigger. ,
Required: False ,
}
{
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
inputs:
{
Description: Gets the inputs. ,
Required: False ,
}
object ,
inputsLink:
{
Description: Gets the link to inputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
outputsLink:
{
Description: Gets the link to outputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
scheduledTime:
{
Description: Gets the scheduled time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackedProperties:
{
Description: Gets the tracked properties. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
response:
{
Description: Gets the response of the flow run. ,
Required: False ,
}
{
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
inputs:
{
Description: Gets the inputs. ,
Required: False ,
}
object ,
inputsLink:
{
Description: Gets the link to inputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
outputsLink:
{
Description: Gets the link to outputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
scheduledTime:
{
Description: Gets the scheduled time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackedProperties:
{
Description: Gets the tracked properties. ,
Required: False ,
}
object ,
}
,
}
,
name:
{
Description: Gets the workflow run name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow run type. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRuns_Get (new)
Description :  Gets a workflow run.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workflow run properties. ,
Required: False ,
}
{
waitEndTime:
{
Description: Gets the wait end time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
correlationId:
{
Description: Gets the correlation id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
workflow:
{
Description: Gets the reference to workflow version. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: Gets the fired trigger. ,
Required: False ,
}
{
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
inputs:
{
Description: Gets the inputs. ,
Required: False ,
}
object ,
inputsLink:
{
Description: Gets the link to inputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
outputsLink:
{
Description: Gets the link to outputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
scheduledTime:
{
Description: Gets the scheduled time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackedProperties:
{
Description: Gets the tracked properties. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
response:
{
Description: Gets the response of the flow run. ,
Required: False ,
}
{
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
inputs:
{
Description: Gets the inputs. ,
Required: False ,
}
object ,
inputsLink:
{
Description: Gets the link to inputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
outputsLink:
{
Description: Gets the link to outputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
scheduledTime:
{
Description: Gets the scheduled time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackedProperties:
{
Description: Gets the tracked properties. ,
Required: False ,
}
object ,
}
,
}
,
name:
{
Description: Gets the workflow run name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow run type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRuns_Cancel (new)
Description :  Cancels a workflow run.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/cancel
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActions_List (new)
Description :  Gets a list of workflow run actions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run 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. Options for filters include: Status. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workflow run actions. ,
Required: False ,
}
[
{
properties:
{
Description: The workflow run action properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The correlation properties. ,
Required: False ,
}
{
actionTrackingId:
{
Description: The action tracking identifier. ,
Required: False ,
}
string ,
}
,
inputsLink:
{
Description: Gets the link to inputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputsLink:
{
Description: Gets the link to outputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
trackedProperties:
{
Description: Gets the tracked properties. ,
Required: False ,
}
object ,
retryHistory:
{
Description: Gets the retry histories. ,
Required: False ,
}
[
{
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: Gets the status code. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Gets the service request Id. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error response. ,
Required: False ,
}
{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
name:
{
Description: Gets the workflow run action name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow run action type. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActions_Get (new)
Description :  Gets a workflow run action.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workflow run action properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The correlation properties. ,
Required: False ,
}
{
actionTrackingId:
{
Description: The action tracking identifier. ,
Required: False ,
}
string ,
}
,
inputsLink:
{
Description: Gets the link to inputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputsLink:
{
Description: Gets the link to outputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
trackedProperties:
{
Description: Gets the tracked properties. ,
Required: False ,
}
object ,
retryHistory:
{
Description: Gets the retry histories. ,
Required: False ,
}
[
{
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: Gets the status code. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Gets the service request Id. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error response. ,
Required: False ,
}
{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
name:
{
Description: Gets the workflow run action name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow run action type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActions_ListExpressionTraces (new)
Description :  Lists a workflow run expression trace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/listExpressionTraces
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
inputs:
{
Required: False ,
}
[
{
path:
{
Description: The path. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionRepetitions_List (new)
Description :  Get all of a workflow run action repetitions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
value:
{
Required: False ,
}
[
{
properties:
{
Description: The workflow run action repetition properties definition. ,
Required: True ,
}
{
repetitionIndexes:
{
Description: The repetition indexes. ,
Required: False ,
}
[
{
scopeName:
{
Description: The scope. ,
Required: False ,
}
string ,
itemIndex:
{
Description: The index. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionRepetitions_Get (new)
Description :  Get a workflow run action repetition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
repetitionName:
{
Description: The workflow repetition. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workflow run action repetition properties definition. ,
Required: True ,
}
{
repetitionIndexes:
{
Description: The repetition indexes. ,
Required: False ,
}
[
{
scopeName:
{
Description: The scope. ,
Required: False ,
}
string ,
itemIndex:
{
Description: The index. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionRepetitions_ListExpressionTraces (new)
Description :  Lists a workflow run expression trace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/listExpressionTraces
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
repetitionName:
{
Description: The workflow repetition. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
inputs:
{
Required: False ,
}
[
{
path:
{
Description: The path. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionRepetitionsRequestHistories_List (new)
Description :  List a workflow run repetition request history.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
repetitionName:
{
Description: The workflow repetition. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workflow request histories. ,
Required: False ,
}
[
{
properties:
{
Description: The request history properties. ,
Required: False ,
}
{
startTime:
{
Description: The time the request started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time the request ended. ,
Format: date-time ,
Required: False ,
}
string ,
request:
{
Description: The request. ,
Required: False ,
}
{
headers:
{
Description: A list of all the headers attached to the request. ,
Required: False ,
}
object ,
uri:
{
Description: The destination for the request. ,
Required: False ,
}
string ,
method:
{
Description: The HTTP method used for the request. ,
Required: False ,
}
string ,
}
,
response:
{
Description: The response. ,
Required: False ,
}
{
headers:
{
Description: A list of all the headers attached to the response. ,
Required: False ,
}
object ,
statusCode:
{
Description: The status code of the response. ,
Format: int32 ,
Required: False ,
}
integer ,
bodyLink:
{
Description: Details on the location of the body content. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionRepetitionsRequestHistories_Get (new)
Description :  Gets a workflow run repetition request history.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories/{requestHistoryName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
repetitionName:
{
Description: The workflow repetition. ,
Required: True ,
}
string ,
requestHistoryName:
{
Description: The request history name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The request history properties. ,
Required: False ,
}
{
startTime:
{
Description: The time the request started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time the request ended. ,
Format: date-time ,
Required: False ,
}
string ,
request:
{
Description: The request. ,
Required: False ,
}
{
headers:
{
Description: A list of all the headers attached to the request. ,
Required: False ,
}
object ,
uri:
{
Description: The destination for the request. ,
Required: False ,
}
string ,
method:
{
Description: The HTTP method used for the request. ,
Required: False ,
}
string ,
}
,
response:
{
Description: The response. ,
Required: False ,
}
{
headers:
{
Description: A list of all the headers attached to the response. ,
Required: False ,
}
object ,
statusCode:
{
Description: The status code of the response. ,
Format: int32 ,
Required: False ,
}
integer ,
bodyLink:
{
Description: Details on the location of the body content. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionRequestHistories_List (new)
Description :  List a workflow run request history.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/requestHistories
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workflow request histories. ,
Required: False ,
}
[
{
properties:
{
Description: The request history properties. ,
Required: False ,
}
{
startTime:
{
Description: The time the request started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time the request ended. ,
Format: date-time ,
Required: False ,
}
string ,
request:
{
Description: The request. ,
Required: False ,
}
{
headers:
{
Description: A list of all the headers attached to the request. ,
Required: False ,
}
object ,
uri:
{
Description: The destination for the request. ,
Required: False ,
}
string ,
method:
{
Description: The HTTP method used for the request. ,
Required: False ,
}
string ,
}
,
response:
{
Description: The response. ,
Required: False ,
}
{
headers:
{
Description: A list of all the headers attached to the response. ,
Required: False ,
}
object ,
statusCode:
{
Description: The status code of the response. ,
Format: int32 ,
Required: False ,
}
integer ,
bodyLink:
{
Description: Details on the location of the body content. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionRequestHistories_Get (new)
Description :  Gets a workflow run request history.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/requestHistories/{requestHistoryName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
requestHistoryName:
{
Description: The request history name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The request history properties. ,
Required: False ,
}
{
startTime:
{
Description: The time the request started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time the request ended. ,
Format: date-time ,
Required: False ,
}
string ,
request:
{
Description: The request. ,
Required: False ,
}
{
headers:
{
Description: A list of all the headers attached to the request. ,
Required: False ,
}
object ,
uri:
{
Description: The destination for the request. ,
Required: False ,
}
string ,
method:
{
Description: The HTTP method used for the request. ,
Required: False ,
}
string ,
}
,
response:
{
Description: The response. ,
Required: False ,
}
{
headers:
{
Description: A list of all the headers attached to the response. ,
Required: False ,
}
object ,
statusCode:
{
Description: The status code of the response. ,
Format: int32 ,
Required: False ,
}
integer ,
bodyLink:
{
Description: Details on the location of the body content. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionScopeRepetitions_List (new)
Description :  List the workflow run action scoped repetitions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/scopeRepetitions
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
value:
{
Required: False ,
}
[
{
properties:
{
Description: The workflow run action repetition properties definition. ,
Required: True ,
}
{
repetitionIndexes:
{
Description: The repetition indexes. ,
Required: False ,
}
[
{
scopeName:
{
Description: The scope. ,
Required: False ,
}
string ,
itemIndex:
{
Description: The index. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionScopeRepetitions_Get (new)
Description :  Get a workflow run action scoped repetition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/scopeRepetitions/{repetitionName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
repetitionName:
{
Description: The workflow repetition. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workflow run action repetition properties definition. ,
Required: True ,
}
{
repetitionIndexes:
{
Description: The repetition indexes. ,
Required: False ,
}
[
{
scopeName:
{
Description: The scope. ,
Required: False ,
}
string ,
itemIndex:
{
Description: The index. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunOperations_Get (new)
Description :  Gets an operation for a run.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/operations/{operationId}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
operationId:
{
Description: The workflow operation id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workflow run properties. ,
Required: False ,
}
{
waitEndTime:
{
Description: Gets the wait end time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
correlationId:
{
Description: Gets the correlation id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
workflow:
{
Description: Gets the reference to workflow version. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: Gets the fired trigger. ,
Required: False ,
}
{
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
inputs:
{
Description: Gets the inputs. ,
Required: False ,
}
object ,
inputsLink:
{
Description: Gets the link to inputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
outputsLink:
{
Description: Gets the link to outputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
scheduledTime:
{
Description: Gets the scheduled time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackedProperties:
{
Description: Gets the tracked properties. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
response:
{
Description: Gets the response of the flow run. ,
Required: False ,
}
{
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
inputs:
{
Description: Gets the inputs. ,
Required: False ,
}
object ,
inputsLink:
{
Description: Gets the link to inputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
outputsLink:
{
Description: Gets the link to outputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
scheduledTime:
{
Description: Gets the scheduled time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackedProperties:
{
Description: Gets the tracked properties. ,
Required: False ,
}
object ,
}
,
}
,
name:
{
Description: Gets the workflow run name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow run type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_ValidateByLocation (new)
Description :  Validates the workflow definition.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/locations/{location}/workflows/{workflowName}/validate
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
location:
{
Description: The workflow location. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
validate:
{
Description: The workflow. ,
Required: True ,
}
{
properties:
{
Description: The workflow properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The 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: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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 ,
}
{
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
state:
{
Description: The workflow state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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 ,
}
{
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
state:
{
Description: The workflow state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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 ,
}
{
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
state:
{
Description: The workflow state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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 ,
}
{
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
state:
{
Description: The workflow state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
{
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
state:
{
Description: The workflow state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
{
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
state:
{
Description: The workflow state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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 ,
}
{
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
state:
{
Description: The workflow state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
{
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
state:
{
Description: The workflow state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountAssemblies_List (new)
Description :  List the assemblies for an integration account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/assemblies
{
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)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The assembly properties. ,
Required: True ,
}
{
assemblyName:
{
Description: The assembly name. ,
Required: True ,
}
string ,
assemblyVersion:
{
Description: The assembly version. ,
Required: False ,
}
string ,
assemblyCulture:
{
Description: The assembly culture. ,
Required: False ,
}
string ,
assemblyPublicKeyToken:
{
Description: The assembly public key token. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountAssemblies_Get (new)
Description :  Get an assembly for an integration account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/assemblies/{assemblyArtifactName}
{
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 ,
assemblyArtifactName:
{
Description: The assembly artifact name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The assembly properties. ,
Required: True ,
}
{
assemblyName:
{
Description: The assembly name. ,
Required: True ,
}
string ,
assemblyVersion:
{
Description: The assembly version. ,
Required: False ,
}
string ,
assemblyCulture:
{
Description: The assembly culture. ,
Required: False ,
}
string ,
assemblyPublicKeyToken:
{
Description: The assembly public key token. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountAssemblies_CreateOrUpdate (new)
Description :  Create or update an assembly for an integration account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/assemblies/{assemblyArtifactName}
{
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 ,
assemblyArtifactName:
{
Description: The assembly artifact name. ,
Required: True ,
}
string ,
assemblyArtifact:
{
Description: The assembly artifact. ,
Required: True ,
}
{
properties:
{
Description: The assembly properties. ,
Required: True ,
}
{
assemblyName:
{
Description: The assembly name. ,
Required: True ,
}
string ,
assemblyVersion:
{
Description: The assembly version. ,
Required: False ,
}
string ,
assemblyCulture:
{
Description: The assembly culture. ,
Required: False ,
}
string ,
assemblyPublicKeyToken:
{
Description: The assembly public key token. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The assembly properties. ,
Required: True ,
}
{
assemblyName:
{
Description: The assembly name. ,
Required: True ,
}
string ,
assemblyVersion:
{
Description: The assembly version. ,
Required: False ,
}
string ,
assemblyCulture:
{
Description: The assembly culture. ,
Required: False ,
}
string ,
assemblyPublicKeyToken:
{
Description: The assembly public key token. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The assembly properties. ,
Required: True ,
}
{
assemblyName:
{
Description: The assembly name. ,
Required: True ,
}
string ,
assemblyVersion:
{
Description: The assembly version. ,
Required: False ,
}
string ,
assemblyCulture:
{
Description: The assembly culture. ,
Required: False ,
}
string ,
assemblyPublicKeyToken:
{
Description: The assembly public key token. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountAssemblies_Delete (new)
Description :  Delete an assembly for an integration account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/assemblies/{assemblyArtifactName}
{
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 ,
assemblyArtifactName:
{
Description: The assembly artifact name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountAssemblies_ListContentCallbackUrl (new)
Description :  Get the content callback url for an integration account assembly.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/assemblies/{assemblyArtifactName}/listContentCallbackUrl
{
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 ,
assemblyArtifactName:
{
Description: The assembly artifact name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the workflow trigger callback URL. ,
Required: False ,
}
string ,
method:
{
Description: Gets the workflow trigger callback URL HTTP method. ,
Required: False ,
}
string ,
basePath:
{
Description: Gets the workflow trigger callback URL base path. ,
Required: False ,
}
string ,
relativePath:
{
Description: Gets the workflow trigger callback URL relative path. ,
Required: False ,
}
string ,
relativePathParameters:
{
Description: Gets the workflow trigger callback URL relative path parameters. ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: Gets the workflow trigger callback URL query parameters. ,
Required: False ,
}
{
api-version:
{
Description: The api version. ,
Required: False ,
}
string ,
sp:
{
Description: The SAS permissions. ,
Required: False ,
}
string ,
sv:
{
Description: The SAS version. ,
Required: False ,
}
string ,
sig:
{
Description: The SAS signature. ,
Required: False ,
}
string ,
se:
{
Description: The SAS timestamp. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountBatchConfigurations_List (new)
Description :  List the batch configurations for an integration account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/batchConfigurations
{
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)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The batch configuration properties. ,
Required: True ,
}
{
batchGroupName:
{
Description: The name of the batch group. ,
Required: True ,
}
string ,
releaseCriteria:
{
Description: The batch release criteria. ,
Required: True ,
}
{
messageCount:
{
Description: The message count. ,
Format: int32 ,
Required: False ,
}
integer ,
batchSize:
{
Description: The batch size in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
recurrence:
{
Description: The recurrence. ,
Required: False ,
}
{
frequency:
{
Description: The frequency. ,
Enum:
{
NotSpecified: No description available. ,
Second: No description available. ,
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
Year: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone. ,
Required: False ,
}
string ,
schedule:
{
Description: The recurrence schedule. ,
Required: False ,
}
{
minutes:
{
Description: The minutes. ,
Required: False ,
}
[
integer ,
]
,
hours:
{
Description: The hours. ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: The month days. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: The monthly occurrences. ,
Required: False ,
}
[
{
day:
{
Description: The day of the week. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
occurrence:
{
Description: The occurrence. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountBatchConfigurations_Get (new)
Description :  Get a batch configuration for an integration account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/batchConfigurations/{batchConfigurationName}
{
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 ,
batchConfigurationName:
{
Description: The batch configuration name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The batch configuration properties. ,
Required: True ,
}
{
batchGroupName:
{
Description: The name of the batch group. ,
Required: True ,
}
string ,
releaseCriteria:
{
Description: The batch release criteria. ,
Required: True ,
}
{
messageCount:
{
Description: The message count. ,
Format: int32 ,
Required: False ,
}
integer ,
batchSize:
{
Description: The batch size in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
recurrence:
{
Description: The recurrence. ,
Required: False ,
}
{
frequency:
{
Description: The frequency. ,
Enum:
{
NotSpecified: No description available. ,
Second: No description available. ,
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
Year: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone. ,
Required: False ,
}
string ,
schedule:
{
Description: The recurrence schedule. ,
Required: False ,
}
{
minutes:
{
Description: The minutes. ,
Required: False ,
}
[
integer ,
]
,
hours:
{
Description: The hours. ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: The month days. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: The monthly occurrences. ,
Required: False ,
}
[
{
day:
{
Description: The day of the week. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
occurrence:
{
Description: The occurrence. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountBatchConfigurations_CreateOrUpdate (new)
Description :  Create or update a batch configuration for an integration account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/batchConfigurations/{batchConfigurationName}
{
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 ,
batchConfigurationName:
{
Description: The batch configuration name. ,
Required: True ,
}
string ,
batchConfiguration:
{
Description: The batch configuration. ,
Required: True ,
}
{
properties:
{
Description: The batch configuration properties. ,
Required: True ,
}
{
batchGroupName:
{
Description: The name of the batch group. ,
Required: True ,
}
string ,
releaseCriteria:
{
Description: The batch release criteria. ,
Required: True ,
}
{
messageCount:
{
Description: The message count. ,
Format: int32 ,
Required: False ,
}
integer ,
batchSize:
{
Description: The batch size in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
recurrence:
{
Description: The recurrence. ,
Required: False ,
}
{
frequency:
{
Description: The frequency. ,
Enum:
{
NotSpecified: No description available. ,
Second: No description available. ,
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
Year: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone. ,
Required: False ,
}
string ,
schedule:
{
Description: The recurrence schedule. ,
Required: False ,
}
{
minutes:
{
Description: The minutes. ,
Required: False ,
}
[
integer ,
]
,
hours:
{
Description: The hours. ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: The month days. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: The monthly occurrences. ,
Required: False ,
}
[
{
day:
{
Description: The day of the week. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
occurrence:
{
Description: The occurrence. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The batch configuration properties. ,
Required: True ,
}
{
batchGroupName:
{
Description: The name of the batch group. ,
Required: True ,
}
string ,
releaseCriteria:
{
Description: The batch release criteria. ,
Required: True ,
}
{
messageCount:
{
Description: The message count. ,
Format: int32 ,
Required: False ,
}
integer ,
batchSize:
{
Description: The batch size in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
recurrence:
{
Description: The recurrence. ,
Required: False ,
}
{
frequency:
{
Description: The frequency. ,
Enum:
{
NotSpecified: No description available. ,
Second: No description available. ,
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
Year: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone. ,
Required: False ,
}
string ,
schedule:
{
Description: The recurrence schedule. ,
Required: False ,
}
{
minutes:
{
Description: The minutes. ,
Required: False ,
}
[
integer ,
]
,
hours:
{
Description: The hours. ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: The month days. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: The monthly occurrences. ,
Required: False ,
}
[
{
day:
{
Description: The day of the week. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
occurrence:
{
Description: The occurrence. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The batch configuration properties. ,
Required: True ,
}
{
batchGroupName:
{
Description: The name of the batch group. ,
Required: True ,
}
string ,
releaseCriteria:
{
Description: The batch release criteria. ,
Required: True ,
}
{
messageCount:
{
Description: The message count. ,
Format: int32 ,
Required: False ,
}
integer ,
batchSize:
{
Description: The batch size in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
recurrence:
{
Description: The recurrence. ,
Required: False ,
}
{
frequency:
{
Description: The frequency. ,
Enum:
{
NotSpecified: No description available. ,
Second: No description available. ,
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
Year: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone. ,
Required: False ,
}
string ,
schedule:
{
Description: The recurrence schedule. ,
Required: False ,
}
{
minutes:
{
Description: The minutes. ,
Required: False ,
}
[
integer ,
]
,
hours:
{
Description: The hours. ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: The month days. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: The monthly occurrences. ,
Required: False ,
}
[
{
day:
{
Description: The day of the week. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
occurrence:
{
Description: The occurrence. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountBatchConfigurations_Delete (new)
Description :  Delete a batch configuration for an integration account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/batchConfigurations/{batchConfigurationName}
{
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 ,
batchConfigurationName:
{
Description: The batch configuration name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccounts_ListCallbackUrl (new)
Description :  Gets 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 ,
keyType:
{
Description: The key type. ,
Enum:
{
NotSpecified: No description available. ,
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The URL value. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccounts_ListKeyVaultKeys (new)
Description :  Gets the integration account's Key Vault keys.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/listKeyVaultKeys
{
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 ,
listKeyVaultKeys:
{
Description: The key vault parameters. ,
Required: True ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: True ,
}
{
name:
{
Description: The key vault name. ,
Required: False ,
}
string ,
}
,
skipToken:
{
Description: The skip token. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The key vault keys. ,
Required: False ,
}
[
{
kid:
{
Description: The key id. ,
Required: False ,
}
string ,
attributes:
{
Description: The key attributes. ,
Required: False ,
}
{
enabled:
{
Description: Whether the key is enabled or not. ,
Required: False ,
}
boolean ,
created:
{
Description: When the key was created. ,
Format: int64 ,
Required: False ,
}
integer ,
updated:
{
Description: When the key was updated. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
skipToken:
{
Description: The skip token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccounts_LogTrackingEvents (new)
Description :  Logs the integration account's tracking events.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/logTrackingEvents
{
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 ,
logTrackingEvents:
{
Description: The callback URL parameters. ,
Required: True ,
}
{
sourceType:
{
Description: The source type. ,
Required: True ,
}
string ,
trackEventsOptions:
{
Description: The track events options. ,
Enum:
{
None: No description available. ,
DisableSourceInfoEnrich: No description available. ,
}
,
Required: False ,
}
enum ,
events:
{
Description: The events. ,
Required: True ,
}
[
{
eventLevel:
{
Description: The event level. ,
Enum:
{
LogAlways: No description available. ,
Critical: No description available. ,
Error: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
Verbose: No description available. ,
}
,
Required: True ,
}
enum ,
eventTime:
{
Description: The event time. ,
Format: date-time ,
Required: True ,
}
string ,
recordType:
{
Description: The record type. ,
Enum:
{
NotSpecified: No description available. ,
Custom: No description available. ,
AS2Message: No description available. ,
AS2MDN: No description available. ,
X12Interchange: No description available. ,
X12FunctionalGroup: No description available. ,
X12TransactionSet: No description available. ,
X12InterchangeAcknowledgment: No description available. ,
X12FunctionalGroupAcknowledgment: No description available. ,
X12TransactionSetAcknowledgment: No description available. ,
EdifactInterchange: No description available. ,
EdifactFunctionalGroup: No description available. ,
EdifactTransactionSet: No description available. ,
EdifactInterchangeAcknowledgment: No description available. ,
EdifactFunctionalGroupAcknowledgment: No description available. ,
EdifactTransactionSetAcknowledgment: No description available. ,
}
,
Required: True ,
}
enum ,
record:
{
Description: The record. ,
Required: False ,
}
object ,
error:
{
Description: The error. ,
Required: False ,
}
{
message:
{
Description: The message. ,
Required: False ,
}
string ,
code:
{
Description: The code. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccounts_RegenerateAccessKey (new)
Description :  Regenerates the integration account access key.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/regenerateAccessKey
{
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 ,
regenerateAccessKey:
{
Description: The access key type. ,
Required: True ,
}
{
keyType:
{
Description: The key type. ,
Enum:
{
NotSpecified: No description available. ,
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
{
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
state:
{
Description: The workflow state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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. Options for filters include: SchemaType. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration account schemas. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account schema properties. ,
Required: True ,
}
{
schemaType:
{
Description: The schema type. ,
Enum:
{
NotSpecified: No description available. ,
Xml: No description available. ,
}
,
Required: True ,
}
enum ,
targetNamespace:
{
Description: The target namespace of the schema. ,
Required: False ,
}
string ,
documentName:
{
Description: The document name. ,
Required: False ,
}
string ,
fileName:
{
Description: The file name. ,
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 ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
content:
{
Description: The content. ,
Required: False ,
}
string ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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: True ,
}
{
schemaType:
{
Description: The schema type. ,
Enum:
{
NotSpecified: No description available. ,
Xml: No description available. ,
}
,
Required: True ,
}
enum ,
targetNamespace:
{
Description: The target namespace of the schema. ,
Required: False ,
}
string ,
documentName:
{
Description: The document name. ,
Required: False ,
}
string ,
fileName:
{
Description: The file name. ,
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 ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
content:
{
Description: The content. ,
Required: False ,
}
string ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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: True ,
}
{
schemaType:
{
Description: The schema type. ,
Enum:
{
NotSpecified: No description available. ,
Xml: No description available. ,
}
,
Required: True ,
}
enum ,
targetNamespace:
{
Description: The target namespace of the schema. ,
Required: False ,
}
string ,
documentName:
{
Description: The document name. ,
Required: False ,
}
string ,
fileName:
{
Description: The file name. ,
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 ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
content:
{
Description: The content. ,
Required: False ,
}
string ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account schema properties. ,
Required: True ,
}
{
schemaType:
{
Description: The schema type. ,
Enum:
{
NotSpecified: No description available. ,
Xml: No description available. ,
}
,
Required: True ,
}
enum ,
targetNamespace:
{
Description: The target namespace of the schema. ,
Required: False ,
}
string ,
documentName:
{
Description: The document name. ,
Required: False ,
}
string ,
fileName:
{
Description: The file name. ,
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 ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
content:
{
Description: The content. ,
Required: False ,
}
string ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration account schema properties. ,
Required: True ,
}
{
schemaType:
{
Description: The schema type. ,
Enum:
{
NotSpecified: No description available. ,
Xml: No description available. ,
}
,
Required: True ,
}
enum ,
targetNamespace:
{
Description: The target namespace of the schema. ,
Required: False ,
}
string ,
documentName:
{
Description: The document name. ,
Required: False ,
}
string ,
fileName:
{
Description: The file name. ,
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 ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
content:
{
Description: The content. ,
Required: False ,
}
string ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountSchemas_ListContentCallbackUrl (new)
Description :  Get the content callback url.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/schemas/{schemaName}/listContentCallbackUrl
{
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 ,
listContentCallbackUrl:
{
Required: True ,
}
{
notAfter:
{
Description: The expiry time. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: The key type. ,
Enum:
{
NotSpecified: No description available. ,
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
value:
{
Description: Gets the workflow trigger callback URL. ,
Required: False ,
}
string ,
method:
{
Description: Gets the workflow trigger callback URL HTTP method. ,
Required: False ,
}
string ,
basePath:
{
Description: Gets the workflow trigger callback URL base path. ,
Required: False ,
}
string ,
relativePath:
{
Description: Gets the workflow trigger callback URL relative path. ,
Required: False ,
}
string ,
relativePathParameters:
{
Description: Gets the workflow trigger callback URL relative path parameters. ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: Gets the workflow trigger callback URL query parameters. ,
Required: False ,
}
{
api-version:
{
Description: The api version. ,
Required: False ,
}
string ,
sp:
{
Description: The SAS permissions. ,
Required: False ,
}
string ,
sv:
{
Description: The SAS version. ,
Required: False ,
}
string ,
sig:
{
Description: The SAS signature. ,
Required: False ,
}
string ,
se:
{
Description: The SAS timestamp. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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. Options for filters include: MapType. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration account maps. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account map properties. ,
Required: True ,
}
{
mapType:
{
Description: The map type. ,
Enum:
{
NotSpecified: No description available. ,
Xslt: No description available. ,
Xslt20: No description available. ,
Xslt30: No description available. ,
Liquid: No description available. ,
}
,
Required: True ,
}
enum ,
parametersSchema:
{
Description: The parameters schema of integration account map. ,
Required: False ,
}
{
ref:
{
Description: The reference name. ,
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 ,
}
string ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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: True ,
}
{
mapType:
{
Description: The map type. ,
Enum:
{
NotSpecified: No description available. ,
Xslt: No description available. ,
Xslt20: No description available. ,
Xslt30: No description available. ,
Liquid: No description available. ,
}
,
Required: True ,
}
enum ,
parametersSchema:
{
Description: The parameters schema of integration account map. ,
Required: False ,
}
{
ref:
{
Description: The reference name. ,
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 ,
}
string ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountMaps_CreateOrUpdate (new)
Description :  Creates or updates an integration account map. If the map is larger than 4 MB, you need to store the map in an Azure blob and use the blob's Shared Access Signature (SAS) URL as the 'contentLink' property value.
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: True ,
}
{
mapType:
{
Description: The map type. ,
Enum:
{
NotSpecified: No description available. ,
Xslt: No description available. ,
Xslt20: No description available. ,
Xslt30: No description available. ,
Liquid: No description available. ,
}
,
Required: True ,
}
enum ,
parametersSchema:
{
Description: The parameters schema of integration account map. ,
Required: False ,
}
{
ref:
{
Description: The reference name. ,
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 ,
}
string ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
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: True ,
}
{
mapType:
{
Description: The map type. ,
Enum:
{
NotSpecified: No description available. ,
Xslt: No description available. ,
Xslt20: No description available. ,
Xslt30: No description available. ,
Liquid: No description available. ,
}
,
Required: True ,
}
enum ,
parametersSchema:
{
Description: The parameters schema of integration account map. ,
Required: False ,
}
{
ref:
{
Description: The reference name. ,
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 ,
}
string ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
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: True ,
}
{
mapType:
{
Description: The map type. ,
Enum:
{
NotSpecified: No description available. ,
Xslt: No description available. ,
Xslt20: No description available. ,
Xslt30: No description available. ,
Liquid: No description available. ,
}
,
Required: True ,
}
enum ,
parametersSchema:
{
Description: The parameters schema of integration account map. ,
Required: False ,
}
{
ref:
{
Description: The reference name. ,
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 ,
}
string ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountMaps_ListContentCallbackUrl (new)
Description :  Get the content callback url.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/maps/{mapName}/listContentCallbackUrl
{
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 ,
listContentCallbackUrl:
{
Required: True ,
}
{
notAfter:
{
Description: The expiry time. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: The key type. ,
Enum:
{
NotSpecified: No description available. ,
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
value:
{
Description: Gets the workflow trigger callback URL. ,
Required: False ,
}
string ,
method:
{
Description: Gets the workflow trigger callback URL HTTP method. ,
Required: False ,
}
string ,
basePath:
{
Description: Gets the workflow trigger callback URL base path. ,
Required: False ,
}
string ,
relativePath:
{
Description: Gets the workflow trigger callback URL relative path. ,
Required: False ,
}
string ,
relativePathParameters:
{
Description: Gets the workflow trigger callback URL relative path parameters. ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: Gets the workflow trigger callback URL query parameters. ,
Required: False ,
}
{
api-version:
{
Description: The api version. ,
Required: False ,
}
string ,
sp:
{
Description: The SAS permissions. ,
Required: False ,
}
string ,
sv:
{
Description: The SAS version. ,
Required: False ,
}
string ,
sig:
{
Description: The SAS signature. ,
Required: False ,
}
string ,
se:
{
Description: The SAS timestamp. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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. Options for filters include: PartnerType. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration account partners. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account partner properties. ,
Required: True ,
}
{
partnerType:
{
Description: The partner type. ,
Enum:
{
NotSpecified: No description available. ,
B2B: No description available. ,
}
,
Required: True ,
}
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: True ,
}
{
b2b:
{
Description: The B2B partner content. ,
Required: False ,
}
{
businessIdentities:
{
Description: The list of partner business identities. ,
Required: False ,
}
[
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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: True ,
}
{
partnerType:
{
Description: The partner type. ,
Enum:
{
NotSpecified: No description available. ,
B2B: No description available. ,
}
,
Required: True ,
}
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: True ,
}
{
b2b:
{
Description: The B2B partner content. ,
Required: False ,
}
{
businessIdentities:
{
Description: The list of partner business identities. ,
Required: False ,
}
[
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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: True ,
}
{
partnerType:
{
Description: The partner type. ,
Enum:
{
NotSpecified: No description available. ,
B2B: No description available. ,
}
,
Required: True ,
}
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: True ,
}
{
b2b:
{
Description: The B2B partner content. ,
Required: False ,
}
{
businessIdentities:
{
Description: The list of partner business identities. ,
Required: False ,
}
[
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account partner properties. ,
Required: True ,
}
{
partnerType:
{
Description: The partner type. ,
Enum:
{
NotSpecified: No description available. ,
B2B: No description available. ,
}
,
Required: True ,
}
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: True ,
}
{
b2b:
{
Description: The B2B partner content. ,
Required: False ,
}
{
businessIdentities:
{
Description: The list of partner business identities. ,
Required: False ,
}
[
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration account partner properties. ,
Required: True ,
}
{
partnerType:
{
Description: The partner type. ,
Enum:
{
NotSpecified: No description available. ,
B2B: No description available. ,
}
,
Required: True ,
}
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: True ,
}
{
b2b:
{
Description: The B2B partner content. ,
Required: False ,
}
{
businessIdentities:
{
Description: The list of partner business identities. ,
Required: False ,
}
[
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountPartners_ListContentCallbackUrl (new)
Description :  Get the content callback url.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/partners/{partnerName}/listContentCallbackUrl
{
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 ,
listContentCallbackUrl:
{
Required: True ,
}
{
notAfter:
{
Description: The expiry time. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: The key type. ,
Enum:
{
NotSpecified: No description available. ,
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
value:
{
Description: Gets the workflow trigger callback URL. ,
Required: False ,
}
string ,
method:
{
Description: Gets the workflow trigger callback URL HTTP method. ,
Required: False ,
}
string ,
basePath:
{
Description: Gets the workflow trigger callback URL base path. ,
Required: False ,
}
string ,
relativePath:
{
Description: Gets the workflow trigger callback URL relative path. ,
Required: False ,
}
string ,
relativePathParameters:
{
Description: Gets the workflow trigger callback URL relative path parameters. ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: Gets the workflow trigger callback URL query parameters. ,
Required: False ,
}
{
api-version:
{
Description: The api version. ,
Required: False ,
}
string ,
sp:
{
Description: The SAS permissions. ,
Required: False ,
}
string ,
sv:
{
Description: The SAS version. ,
Required: False ,
}
string ,
sig:
{
Description: The SAS signature. ,
Required: False ,
}
string ,
se:
{
Description: The SAS timestamp. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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. Options for filters include: AgreementType. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration account agreements. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account agreement properties. ,
Required: True ,
}
{
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: True ,
}
enum ,
hostPartner:
{
Description: The integration account partner that is set as host partner for this agreement. ,
Required: True ,
}
string ,
guestPartner:
{
Description: The integration account partner that is set as guest partner for this agreement. ,
Required: True ,
}
string ,
hostIdentity:
{
Description: The business identity of the host partner. ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
guestIdentity:
{
Description: The business identity of the guest partner. ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
content:
{
Description: The agreement content. ,
Required: True ,
}
{
aS2:
{
Description: The AS2 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The AS2 one-way receive agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: True ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: Indicates whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: Indicates whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: Indicates whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: Indicates whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: True ,
}
{
needMDN:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
boolean ,
signMDN:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: True ,
}
boolean ,
sendMDNAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMDNToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: True ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
MD5: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
enableNRRForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundMDN:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: True ,
}
boolean ,
enableNRRForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForInboundMDN:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: True ,
}
boolean ,
sha2AlgorithmFormat:
{
Description: The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. ,
Required: False ,
}
string ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: True ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: True ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: True ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: True ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: True ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: True ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: True ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: True ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: True ,
}
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: True ,
}
enum ,
signingAlgorithm:
{
Description: The signing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
Default: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: True ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: True ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: True ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: True ,
}
string ,
suspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: True ,
}
boolean ,
autogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: True ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: True ,
}
{
suspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: True ,
}
boolean ,
resendIfMDNNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
sendAgreement:
{
Description: The AS2 one-way send agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: True ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: Indicates whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: Indicates whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: Indicates whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: Indicates whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: True ,
}
{
needMDN:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
boolean ,
signMDN:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: True ,
}
boolean ,
sendMDNAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMDNToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: True ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
MD5: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
enableNRRForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundMDN:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: True ,
}
boolean ,
enableNRRForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForInboundMDN:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: True ,
}
boolean ,
sha2AlgorithmFormat:
{
Description: The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. ,
Required: False ,
}
string ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: True ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: True ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: True ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: True ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: True ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: True ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: True ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: True ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: True ,
}
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: True ,
}
enum ,
signingAlgorithm:
{
Description: The signing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
Default: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: True ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: True ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: True ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: True ,
}
string ,
suspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: True ,
}
boolean ,
autogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: True ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: True ,
}
{
suspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: True ,
}
boolean ,
resendIfMDNNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
}
,
x12:
{
Description: The X12 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The X12 one-way receive agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: True ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: True ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: True ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: True ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: True ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: True ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: True ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
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: True ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: True ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: True ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: True ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: True ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Required: True ,
}
string ,
headerVersion:
{
Description: The header version. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
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: True ,
}
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: True ,
}
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: True ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: True ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: True ,
}
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: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: True ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: True ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: True ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: True ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: True ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: True ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: True ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
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: True ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: True ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: True ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: True ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: True ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Required: True ,
}
string ,
headerVersion:
{
Description: The header version. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
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: True ,
}
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: True ,
}
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: True ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: True ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: True ,
}
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: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: True ,
}
{
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: True ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: True ,
}
{
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: True ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
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: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
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: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
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: True ,
}
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: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: True ,
}
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: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: True ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: True ,
}
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: True ,
}
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: True ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: True ,
}
{
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: True ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: True ,
}
{
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: True ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
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: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
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: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
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: True ,
}
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: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: True ,
}
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: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: True ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: True ,
}
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: True ,
}
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: True ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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: True ,
}
{
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: True ,
}
enum ,
hostPartner:
{
Description: The integration account partner that is set as host partner for this agreement. ,
Required: True ,
}
string ,
guestPartner:
{
Description: The integration account partner that is set as guest partner for this agreement. ,
Required: True ,
}
string ,
hostIdentity:
{
Description: The business identity of the host partner. ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
guestIdentity:
{
Description: The business identity of the guest partner. ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
content:
{
Description: The agreement content. ,
Required: True ,
}
{
aS2:
{
Description: The AS2 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The AS2 one-way receive agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: True ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: Indicates whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: Indicates whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: Indicates whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: Indicates whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: True ,
}
{
needMDN:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
boolean ,
signMDN:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: True ,
}
boolean ,
sendMDNAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMDNToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: True ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
MD5: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
enableNRRForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundMDN:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: True ,
}
boolean ,
enableNRRForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForInboundMDN:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: True ,
}
boolean ,
sha2AlgorithmFormat:
{
Description: The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. ,
Required: False ,
}
string ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: True ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: True ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: True ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: True ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: True ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: True ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: True ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: True ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: True ,
}
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: True ,
}
enum ,
signingAlgorithm:
{
Description: The signing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
Default: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: True ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: True ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: True ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: True ,
}
string ,
suspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: True ,
}
boolean ,
autogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: True ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: True ,
}
{
suspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: True ,
}
boolean ,
resendIfMDNNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
sendAgreement:
{
Description: The AS2 one-way send agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: True ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: Indicates whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: Indicates whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: Indicates whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: Indicates whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: True ,
}
{
needMDN:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
boolean ,
signMDN:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: True ,
}
boolean ,
sendMDNAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMDNToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: True ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
MD5: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
enableNRRForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundMDN:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: True ,
}
boolean ,
enableNRRForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForInboundMDN:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: True ,
}
boolean ,
sha2AlgorithmFormat:
{
Description: The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. ,
Required: False ,
}
string ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: True ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: True ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: True ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: True ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: True ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: True ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: True ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: True ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: True ,
}
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: True ,
}
enum ,
signingAlgorithm:
{
Description: The signing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
Default: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: True ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: True ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: True ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: True ,
}
string ,
suspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: True ,
}
boolean ,
autogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: True ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: True ,
}
{
suspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: True ,
}
boolean ,
resendIfMDNNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
}
,
x12:
{
Description: The X12 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The X12 one-way receive agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: True ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: True ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: True ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: True ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: True ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: True ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: True ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
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: True ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: True ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: True ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: True ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: True ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Required: True ,
}
string ,
headerVersion:
{
Description: The header version. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
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: True ,
}
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: True ,
}
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: True ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: True ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: True ,
}
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: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: True ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: True ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: True ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: True ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: True ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: True ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: True ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
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: True ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: True ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: True ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: True ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: True ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Required: True ,
}
string ,
headerVersion:
{
Description: The header version. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
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: True ,
}
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: True ,
}
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: True ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: True ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: True ,
}
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: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: True ,
}
{
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: True ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: True ,
}
{
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: True ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
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: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
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: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
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: True ,
}
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: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: True ,
}
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: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: True ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: True ,
}
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: True ,
}
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: True ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: True ,
}
{
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: True ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: True ,
}
{
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: True ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
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: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
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: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
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: True ,
}
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: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: True ,
}
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: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: True ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: True ,
}
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: True ,
}
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: True ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
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 (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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: True ,
}
{
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: True ,
}
enum ,
hostPartner:
{
Description: The integration account partner that is set as host partner for this agreement. ,
Required: True ,
}
string ,
guestPartner:
{
Description: The integration account partner that is set as guest partner for this agreement. ,
Required: True ,
}
string ,
hostIdentity:
{
Description: The business identity of the host partner. ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
guestIdentity:
{
Description: The business identity of the guest partner. ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
content:
{
Description: The agreement content. ,
Required: True ,
}
{
aS2:
{
Description: The AS2 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The AS2 one-way receive agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: True ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: Indicates whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: Indicates whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: Indicates whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: Indicates whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: True ,
}
{
needMDN:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
boolean ,
signMDN:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: True ,
}
boolean ,
sendMDNAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMDNToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: True ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
MD5: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
enableNRRForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundMDN:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: True ,
}
boolean ,
enableNRRForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForInboundMDN:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: True ,
}
boolean ,
sha2AlgorithmFormat:
{
Description: The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. ,
Required: False ,
}
string ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: True ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: True ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: True ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: True ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: True ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: True ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: True ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: True ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: True ,
}
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: True ,
}
enum ,
signingAlgorithm:
{
Description: The signing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
Default: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: True ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: True ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: True ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: True ,
}
string ,
suspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: True ,
}
boolean ,
autogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: True ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: True ,
}
{
suspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: True ,
}
boolean ,
resendIfMDNNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
sendAgreement:
{
Description: The AS2 one-way send agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: True ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: Indicates whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: Indicates whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: Indicates whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: Indicates whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: True ,
}
{
needMDN:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
boolean ,
signMDN:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: True ,
}
boolean ,
sendMDNAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMDNToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: True ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
MD5: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
enableNRRForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundMDN:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: True ,
}
boolean ,
enableNRRForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForInboundMDN:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: True ,
}
boolean ,
sha2AlgorithmFormat:
{
Description: The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. ,
Required: False ,
}
string ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: True ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: True ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: True ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: True ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: True ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: True ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: True ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: True ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: True ,
}
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: True ,
}
enum ,
signingAlgorithm:
{
Description: The signing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
Default: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: True ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: True ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: True ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: True ,
}
string ,
suspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: True ,
}
boolean ,
autogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: True ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: True ,
}
{
suspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: True ,
}
boolean ,
resendIfMDNNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
}
,
x12:
{
Description: The X12 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The X12 one-way receive agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: True ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: True ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: True ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: True ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: True ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: True ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: True ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
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: True ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: True ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: True ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: True ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: True ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Required: True ,
}
string ,
headerVersion:
{
Description: The header version. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
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: True ,
}
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: True ,
}
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: True ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: True ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: True ,
}
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: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: True ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: True ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: True ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: True ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: True ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: True ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: True ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
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: True ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: True ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: True ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: True ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: True ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Required: True ,
}
string ,
headerVersion:
{
Description: The header version. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
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: True ,
}
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: True ,
}
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: True ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: True ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: True ,
}
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: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: True ,
}
{
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: True ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: True ,
}
{
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: True ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
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: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
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: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
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: True ,
}
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: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: True ,
}
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: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: True ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: True ,
}
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: True ,
}
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: True ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: True ,
}
{
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: True ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: True ,
}
{
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: True ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
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: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
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: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
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: True ,
}
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: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: True ,
}
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: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: True ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: True ,
}
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: True ,
}
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: True ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
{
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: True ,
}
enum ,
hostPartner:
{
Description: The integration account partner that is set as host partner for this agreement. ,
Required: True ,
}
string ,
guestPartner:
{
Description: The integration account partner that is set as guest partner for this agreement. ,
Required: True ,
}
string ,
hostIdentity:
{
Description: The business identity of the host partner. ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
guestIdentity:
{
Description: The business identity of the guest partner. ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
content:
{
Description: The agreement content. ,
Required: True ,
}
{
aS2:
{
Description: The AS2 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The AS2 one-way receive agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: True ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: Indicates whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: Indicates whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: Indicates whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: Indicates whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: True ,
}
{
needMDN:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
boolean ,
signMDN:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: True ,
}
boolean ,
sendMDNAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMDNToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: True ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
MD5: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
enableNRRForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundMDN:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: True ,
}
boolean ,
enableNRRForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForInboundMDN:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: True ,
}
boolean ,
sha2AlgorithmFormat:
{
Description: The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. ,
Required: False ,
}
string ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: True ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: True ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: True ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: True ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: True ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: True ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: True ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: True ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: True ,
}
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: True ,
}
enum ,
signingAlgorithm:
{
Description: The signing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
Default: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: True ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: True ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: True ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: True ,
}
string ,
suspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: True ,
}
boolean ,
autogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: True ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: True ,
}
{
suspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: True ,
}
boolean ,
resendIfMDNNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
sendAgreement:
{
Description: The AS2 one-way send agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: True ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: Indicates whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: Indicates whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: Indicates whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: Indicates whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: True ,
}
{
needMDN:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
boolean ,
signMDN:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: True ,
}
boolean ,
sendMDNAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMDNToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: True ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
MD5: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
enableNRRForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundMDN:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: True ,
}
boolean ,
enableNRRForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForInboundMDN:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: True ,
}
boolean ,
sha2AlgorithmFormat:
{
Description: The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. ,
Required: False ,
}
string ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: True ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: True ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: True ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: True ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: True ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: True ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: True ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: True ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: True ,
}
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: True ,
}
enum ,
signingAlgorithm:
{
Description: The signing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
Default: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: True ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: True ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: True ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: True ,
}
string ,
suspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: True ,
}
boolean ,
autogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: True ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: True ,
}
{
suspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: True ,
}
boolean ,
resendIfMDNNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
}
,
x12:
{
Description: The X12 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The X12 one-way receive agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: True ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: True ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: True ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: True ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: True ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: True ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: True ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
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: True ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: True ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: True ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: True ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: True ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Required: True ,
}
string ,
headerVersion:
{
Description: The header version. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
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: True ,
}
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: True ,
}
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: True ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: True ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: True ,
}
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: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: True ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: True ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: True ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: True ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: True ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: True ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: True ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
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: True ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: True ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: True ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: True ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: True ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Required: True ,
}
string ,
headerVersion:
{
Description: The header version. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
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: True ,
}
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: True ,
}
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: True ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: True ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: True ,
}
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: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: True ,
}
{
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: True ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: True ,
}
{
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: True ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
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: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
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: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
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: True ,
}
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: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: True ,
}
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: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: True ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: True ,
}
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: True ,
}
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: True ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: True ,
}
{
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: True ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: True ,
}
{
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: True ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
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: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
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: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
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: True ,
}
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: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: True ,
}
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: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: True ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: True ,
}
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: True ,
}
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: True ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
{
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: True ,
}
enum ,
hostPartner:
{
Description: The integration account partner that is set as host partner for this agreement. ,
Required: True ,
}
string ,
guestPartner:
{
Description: The integration account partner that is set as guest partner for this agreement. ,
Required: True ,
}
string ,
hostIdentity:
{
Description: The business identity of the host partner. ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
guestIdentity:
{
Description: The business identity of the guest partner. ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
content:
{
Description: The agreement content. ,
Required: True ,
}
{
aS2:
{
Description: The AS2 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The AS2 one-way receive agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: True ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: Indicates whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: Indicates whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: Indicates whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: Indicates whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: True ,
}
{
needMDN:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
boolean ,
signMDN:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: True ,
}
boolean ,
sendMDNAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMDNToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: True ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
MD5: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
enableNRRForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundMDN:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: True ,
}
boolean ,
enableNRRForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForInboundMDN:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: True ,
}
boolean ,
sha2AlgorithmFormat:
{
Description: The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. ,
Required: False ,
}
string ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: True ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: True ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: True ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: True ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: True ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: True ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: True ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: True ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: True ,
}
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: True ,
}
enum ,
signingAlgorithm:
{
Description: The signing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
Default: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: True ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: True ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: True ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: True ,
}
string ,
suspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: True ,
}
boolean ,
autogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: True ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: True ,
}
{
suspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: True ,
}
boolean ,
resendIfMDNNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
sendAgreement:
{
Description: The AS2 one-way send agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: True ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: Indicates whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: Indicates whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: Indicates whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: Indicates whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: True ,
}
{
needMDN:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
boolean ,
signMDN:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: True ,
}
boolean ,
sendMDNAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMDNToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: True ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
MD5: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
enableNRRForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundMDN:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: True ,
}
boolean ,
enableNRRForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForInboundMDN:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: True ,
}
boolean ,
sha2AlgorithmFormat:
{
Description: The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. ,
Required: False ,
}
string ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: True ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: True ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: True ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: True ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: True ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: True ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: True ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: True ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: True ,
}
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: True ,
}
enum ,
signingAlgorithm:
{
Description: The signing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
Default: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: True ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: True ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: True ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: True ,
}
string ,
suspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: True ,
}
boolean ,
autogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: True ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: True ,
}
{
suspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: True ,
}
boolean ,
resendIfMDNNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
}
,
x12:
{
Description: The X12 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The X12 one-way receive agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: True ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: True ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: True ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: True ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: True ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: True ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: True ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
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: True ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: True ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: True ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: True ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: True ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Required: True ,
}
string ,
headerVersion:
{
Description: The header version. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
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: True ,
}
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: True ,
}
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: True ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: True ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: True ,
}
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: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: True ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: True ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: True ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: True ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: True ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: True ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: True ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
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: True ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: True ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: True ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: True ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: True ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Required: True ,
}
string ,
headerVersion:
{
Description: The header version. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
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: True ,
}
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: True ,
}
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: True ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: True ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: True ,
}
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: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: True ,
}
{
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: True ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: True ,
}
{
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: True ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
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: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
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: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
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: True ,
}
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: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: True ,
}
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: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: True ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: True ,
}
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: True ,
}
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: True ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: True ,
}
{
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: True ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: True ,
}
{
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: True ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
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: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
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: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
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: True ,
}
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: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: True ,
}
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: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: True ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: True ,
}
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: True ,
}
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: True ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
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 (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountAgreements_ListContentCallbackUrl (new)
Description :  Get the content callback url.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/agreements/{agreementName}/listContentCallbackUrl
{
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 ,
listContentCallbackUrl:
{
Required: True ,
}
{
notAfter:
{
Description: The expiry time. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: The key type. ,
Enum:
{
NotSpecified: No description available. ,
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
value:
{
Description: Gets the workflow trigger callback URL. ,
Required: False ,
}
string ,
method:
{
Description: Gets the workflow trigger callback URL HTTP method. ,
Required: False ,
}
string ,
basePath:
{
Description: Gets the workflow trigger callback URL base path. ,
Required: False ,
}
string ,
relativePath:
{
Description: Gets the workflow trigger callback URL relative path. ,
Required: False ,
}
string ,
relativePathParameters:
{
Description: Gets the workflow trigger callback URL relative path parameters. ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: Gets the workflow trigger callback URL query parameters. ,
Required: False ,
}
{
api-version:
{
Description: The api version. ,
Required: False ,
}
string ,
sp:
{
Description: The SAS permissions. ,
Required: False ,
}
string ,
sv:
{
Description: The SAS version. ,
Required: False ,
}
string ,
sig:
{
Description: The SAS signature. ,
Required: False ,
}
string ,
se:
{
Description: The SAS timestamp. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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: True ,
}
{
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: True ,
}
{
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: True ,
}
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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: True ,
}
{
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: True ,
}
{
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: True ,
}
string ,
keyVersion:
{
Description: The private key version in key vault. ,
Required: False ,
}
string ,
}
,
publicCertificate:
{
Description: The public certificate. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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: True ,
}
{
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: True ,
}
{
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: True ,
}
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: True ,
}
{
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: True ,
}
{
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: True ,
}
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: True ,
}
{
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: True ,
}
{
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: True ,
}
string ,
keyVersion:
{
Description: The private key version in key vault. ,
Required: False ,
}
string ,
}
,
publicCertificate:
{
Description: The public certificate. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountSessions_List (new)
Description :  Gets a list of integration account sessions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/sessions
{
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. Options for filters include: ChangedTime. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration account sessions. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account session properties. ,
Required: True ,
}
{
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 session content. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountSessions_Get (new)
Description :  Gets an integration account session.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/sessions/{sessionName}
{
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 ,
sessionName:
{
Description: The integration account session name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The integration account session properties. ,
Required: True ,
}
{
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 session content. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountSessions_CreateOrUpdate (new)
Description :  Creates or updates an integration account session.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/sessions/{sessionName}
{
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 ,
sessionName:
{
Description: The integration account session name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
session:
{
Description: The integration account session. ,
Required: True ,
}
{
properties:
{
Description: The integration account session properties. ,
Required: True ,
}
{
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 session content. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account session properties. ,
Required: True ,
}
{
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 session content. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration account session properties. ,
Required: True ,
}
{
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 session content. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountSessions_Delete (new)
Description :  Deletes an integration account session.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/sessions/{sessionName}
{
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 ,
sessionName:
{
Description: The integration account session name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironments_ListBySubscription (new)
Description :  Gets a list of integration service environments by subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Logic/integrationServiceEnvironments
{
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:
{
Required: False ,
}
[
{
properties:
{
Description: The integration service environment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The integration service environment state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
integrationServiceEnvironmentId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
networkConfiguration:
{
Description: The network configuration. ,
Required: False ,
}
{
virtualNetworkAddressSpace:
{
Description: Gets the virtual network address space. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: The access endpoint. ,
Required: False ,
}
{
type:
{
Description: The access endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
External: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subnets:
{
Description: The subnets. ,
Required: False ,
}
[
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
encryptionConfiguration:
{
Description: The encryption configuration. ,
Required: False ,
}
{
encryptionKeyReference:
{
Description: The encryption key reference. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: Gets the key name in the Key Vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Gets the version of the key specified in the keyName property. ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Premium: No description available. ,
Developer: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironments_ListByResourceGroup (new)
Description :  Gets a list of integration service environments by resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
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:
{
Required: False ,
}
[
{
properties:
{
Description: The integration service environment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The integration service environment state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
integrationServiceEnvironmentId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
networkConfiguration:
{
Description: The network configuration. ,
Required: False ,
}
{
virtualNetworkAddressSpace:
{
Description: Gets the virtual network address space. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: The access endpoint. ,
Required: False ,
}
{
type:
{
Description: The access endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
External: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subnets:
{
Description: The subnets. ,
Required: False ,
}
[
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
encryptionConfiguration:
{
Description: The encryption configuration. ,
Required: False ,
}
{
encryptionKeyReference:
{
Description: The encryption key reference. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: Gets the key name in the Key Vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Gets the version of the key specified in the keyName property. ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Premium: No description available. ,
Developer: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironments_Get (new)
Description :  Gets an integration service environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The integration service environment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The integration service environment state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
integrationServiceEnvironmentId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
networkConfiguration:
{
Description: The network configuration. ,
Required: False ,
}
{
virtualNetworkAddressSpace:
{
Description: Gets the virtual network address space. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: The access endpoint. ,
Required: False ,
}
{
type:
{
Description: The access endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
External: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subnets:
{
Description: The subnets. ,
Required: False ,
}
[
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
encryptionConfiguration:
{
Description: The encryption configuration. ,
Required: False ,
}
{
encryptionKeyReference:
{
Description: The encryption key reference. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: Gets the key name in the Key Vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Gets the version of the key specified in the keyName property. ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Premium: No description available. ,
Developer: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironments_CreateOrUpdate (new)
Description :  Creates or updates an integration service environment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: True ,
}
{
properties:
{
Description: The integration service environment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The integration service environment state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
integrationServiceEnvironmentId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
networkConfiguration:
{
Description: The network configuration. ,
Required: False ,
}
{
virtualNetworkAddressSpace:
{
Description: Gets the virtual network address space. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: The access endpoint. ,
Required: False ,
}
{
type:
{
Description: The access endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
External: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subnets:
{
Description: The subnets. ,
Required: False ,
}
[
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
encryptionConfiguration:
{
Description: The encryption configuration. ,
Required: False ,
}
{
encryptionKeyReference:
{
Description: The encryption key reference. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: Gets the key name in the Key Vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Gets the version of the key specified in the keyName property. ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Premium: No description available. ,
Developer: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration service environment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The integration service environment state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
integrationServiceEnvironmentId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
networkConfiguration:
{
Description: The network configuration. ,
Required: False ,
}
{
virtualNetworkAddressSpace:
{
Description: Gets the virtual network address space. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: The access endpoint. ,
Required: False ,
}
{
type:
{
Description: The access endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
External: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subnets:
{
Description: The subnets. ,
Required: False ,
}
[
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
encryptionConfiguration:
{
Description: The encryption configuration. ,
Required: False ,
}
{
encryptionKeyReference:
{
Description: The encryption key reference. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: Gets the key name in the Key Vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Gets the version of the key specified in the keyName property. ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Premium: No description available. ,
Developer: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration service environment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The integration service environment state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
integrationServiceEnvironmentId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
networkConfiguration:
{
Description: The network configuration. ,
Required: False ,
}
{
virtualNetworkAddressSpace:
{
Description: Gets the virtual network address space. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: The access endpoint. ,
Required: False ,
}
{
type:
{
Description: The access endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
External: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subnets:
{
Description: The subnets. ,
Required: False ,
}
[
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
encryptionConfiguration:
{
Description: The encryption configuration. ,
Required: False ,
}
{
encryptionKeyReference:
{
Description: The encryption key reference. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: Gets the key name in the Key Vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Gets the version of the key specified in the keyName property. ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Premium: No description available. ,
Developer: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironments_Update (new)
Description :  Updates an integration service environment.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: True ,
}
{
properties:
{
Description: The integration service environment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The integration service environment state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
integrationServiceEnvironmentId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
networkConfiguration:
{
Description: The network configuration. ,
Required: False ,
}
{
virtualNetworkAddressSpace:
{
Description: Gets the virtual network address space. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: The access endpoint. ,
Required: False ,
}
{
type:
{
Description: The access endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
External: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subnets:
{
Description: The subnets. ,
Required: False ,
}
[
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
encryptionConfiguration:
{
Description: The encryption configuration. ,
Required: False ,
}
{
encryptionKeyReference:
{
Description: The encryption key reference. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: Gets the key name in the Key Vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Gets the version of the key specified in the keyName property. ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Premium: No description available. ,
Developer: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration service environment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The integration service environment state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
integrationServiceEnvironmentId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
networkConfiguration:
{
Description: The network configuration. ,
Required: False ,
}
{
virtualNetworkAddressSpace:
{
Description: Gets the virtual network address space. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: The access endpoint. ,
Required: False ,
}
{
type:
{
Description: The access endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
External: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subnets:
{
Description: The subnets. ,
Required: False ,
}
[
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
encryptionConfiguration:
{
Description: The encryption configuration. ,
Required: False ,
}
{
encryptionKeyReference:
{
Description: The encryption key reference. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: Gets the key name in the Key Vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Gets the version of the key specified in the keyName property. ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Premium: No description available. ,
Developer: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironments_Delete (new)
Description :  Deletes an integration service environment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironmentSkus_List (new)
Description :  Gets a list of integration service environment Skus.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/skus
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration service environment skus. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Premium: No description available. ,
Developer: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
capacity:
{
Description: The sku capacity. ,
Required: False ,
}
{
minimum:
{
Description: The minimum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: The maximum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: The default capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: The sku scale type. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironments_Restart (new)
Description :  Restarts an integration service environment.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/restart
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironmentNetworkHealth_Get (new)
Description :  Gets the integration service environment network health.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/health/network
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: The integration service environment network health of all the subnets. ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironmentManagedApis_List (new)
Description :  Gets the integration service environment managed Apis.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/managedApis
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The integration service environment managed APIs. ,
Required: False ,
}
[
{
properties:
{
Description: The integration service environment managed api properties. ,
Required: False ,
}
{
deploymentParameters:
{
Description: The integration service environment managed api deployment parameters. ,
Required: False ,
}
{
contentLinkDefinition:
{
Description: The integration service environment managed api content link for deployment. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironmentManagedApis_Get (new)
Description :  Gets the integration service environment managed Api.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/managedApis/{apiName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
apiName:
{
Description: The api name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The integration service environment managed api properties. ,
Required: False ,
}
{
deploymentParameters:
{
Description: The integration service environment managed api deployment parameters. ,
Required: False ,
}
{
contentLinkDefinition:
{
Description: The integration service environment managed api content link for deployment. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironmentManagedApis_Put (new)
Description :  Puts the integration service environment managed Api.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/managedApis/{apiName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
apiName:
{
Description: The api name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
integrationServiceEnvironmentManagedApi:
{
Description: The integration service environment managed api. ,
Required: True ,
}
{
properties:
{
Description: The integration service environment managed api properties. ,
Required: False ,
}
{
deploymentParameters:
{
Description: The integration service environment managed api deployment parameters. ,
Required: False ,
}
{
contentLinkDefinition:
{
Description: The integration service environment managed api content link for deployment. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration service environment managed api properties. ,
Required: False ,
}
{
deploymentParameters:
{
Description: The integration service environment managed api deployment parameters. ,
Required: False ,
}
{
contentLinkDefinition:
{
Description: The integration service environment managed api content link for deployment. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration service environment managed api properties. ,
Required: False ,
}
{
deploymentParameters:
{
Description: The integration service environment managed api deployment parameters. ,
Required: False ,
}
{
contentLinkDefinition:
{
Description: The integration service environment managed api content link for deployment. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironmentManagedApis_Delete (new)
Description :  Deletes the integration service environment managed Api.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/managedApis/{apiName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
apiName:
{
Description: The api name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironmentManagedApiOperations_List (new)
Description :  Gets the managed Api operations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/managedApis/{apiName}/apiOperations
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
apiName:
{
Description: The api name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The api operation definitions for an API. ,
Required: False ,
}
[
{
properties:
{
Description: The api operations properties ,
Required: False ,
}
{
summary:
{
Description: The summary of the api operation. ,
Required: False ,
}
string ,
description:
{
Description: The description of the api operation. ,
Required: False ,
}
string ,
visibility:
{
Description: The visibility of the api operation. ,
Required: False ,
}
string ,
trigger:
{
Description: The trigger type of api operation. ,
Required: False ,
}
string ,
triggerHint:
{
Description: The trigger hint for the api operation. ,
Required: False ,
}
string ,
pageable:
{
Description: Indicates whether the api operation is pageable. ,
Required: False ,
}
boolean ,
annotation:
{
Description: The annotation of api operation. ,
Required: False ,
}
{
status:
{
Description: The status annotation. ,
Enum:
{
NotSpecified: No description available. ,
Preview: No description available. ,
Production: No description available. ,
}
,
Required: False ,
}
enum ,
family:
{
Description: The family. ,
Required: False ,
}
string ,
revision:
{
Description: The revision. ,
Required: False ,
}
integer ,
}
,
api:
{
Description: The api reference. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the api. ,
Required: False ,
}
string ,
description:
{
Description: The description of the api. ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon uri of the api. ,
Required: False ,
}
string ,
swagger:
{
Description: The swagger of the api. ,
Required: False ,
}
object ,
brandColor:
{
Description: The brand color of the api. ,
Required: False ,
}
string ,
category:
{
Description: The tier. ,
Enum:
{
NotSpecified: No description available. ,
Enterprise: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
integrationServiceEnvironment:
{
Description: The integration service environment reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
inputsDefinition:
{
Description: The operation inputs definition schema. ,
Required: False ,
}
{
ref:
{
Description: The reference. ,
Required: False ,
}
string ,
type:
{
Description: The type ,
Enum:
{
String: No description available. ,
Number: No description available. ,
Integer: No description available. ,
Boolean: No description available. ,
Array: No description available. ,
File: No description available. ,
Object: No description available. ,
Null: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: The title. ,
Required: False ,
}
string ,
items:
{
Required: False ,
}
string ,
properties:
{
Description: The object properties ,
Required: False ,
}
object ,
additionalProperties:
{
Description: The additional properties. ,
Required: False ,
}
object ,
required:
{
Description: The object required properties. ,
Required: False ,
}
[
string ,
]
,
maxProperties:
{
Description: The maximum number of allowed properties. ,
Required: False ,
}
integer ,
minProperties:
{
Description: The minimum number of allowed properties. ,
Required: False ,
}
integer ,
allOf:
{
Description: The schemas which must pass validation when this schema is used. ,
Required: False ,
}
[
string ,
]
,
discriminator:
{
Description: The discriminator. ,
Required: False ,
}
string ,
readOnly:
{
Description: Indicates whether this property must be present in the a request. ,
Required: False ,
}
boolean ,
xml:
{
Description: The xml representation format for a property. ,
Required: False ,
}
{
name:
{
Description: The xml element or attribute name. ,
Required: False ,
}
string ,
namespace:
{
Description: The xml namespace. ,
Required: False ,
}
string ,
prefix:
{
Description: The name prefix. ,
Required: False ,
}
string ,
attribute:
{
Description: Indicates whether the property should be an attribute instead of an element. ,
Required: False ,
}
boolean ,
wrapped:
{
Description: Indicates whether the array elements are wrapped in a container element. ,
Required: False ,
}
boolean ,
extensions:
{
Description: The vendor extensions. ,
Required: False ,
}
object ,
}
,
externalDocs:
{
Description: The external documentation. ,
Required: False ,
}
{
description:
{
Description: The document description. ,
Required: False ,
}
string ,
uri:
{
Description: The documentation Uri. ,
Required: False ,
}
string ,
extensions:
{
Description: The vendor extensions. ,
Required: False ,
}
object ,
}
,
example:
{
Description: The example value. ,
Required: False ,
}
object ,
notificationUrlExtension:
{
Description: Indicates the notification url extension. If this is set, the property's value should be a callback url for a webhook. ,
Required: False ,
}
boolean ,
dynamicSchemaOld:
{
Description: The dynamic schema configuration. ,
Required: False ,
}
{
operationId:
{
Description: The operation id to fetch dynamic schema. ,
Required: False ,
}
string ,
valuePath:
{
Description: Json pointer to the dynamic schema on the response body. ,
Required: False ,
}
string ,
parameters:
{
Description: The operation parameters. ,
Required: False ,
}
object ,
}
,
dynamicSchemaNew:
{
Description: The dynamic schema configuration. ,
Required: False ,
}
{
operationId:
{
Description: The operation id to fetch dynamic schema. ,
Required: False ,
}
string ,
valuePath:
{
Description: Json pointer to the dynamic schema on the response body. ,
Required: False ,
}
string ,
parameters:
{
Description: The operation parameters. ,
Required: False ,
}
object ,
}
,
dynamicListNew:
{
Description: The dynamic list. ,
Required: False ,
}
{
operationId:
{
Description: The operation id to fetch dynamic schema. ,
Required: False ,
}
string ,
builtInOperation:
{
Description: The built in operation. ,
Required: False ,
}
string ,
itemsPath:
{
Description: The path to a response property (relative to the response object, not the response body) which contains an array of dynamic value items. ,
Required: False ,
}
string ,
itemValuePath:
{
Description: The path to a property which defines the value which should be used. ,
Required: False ,
}
string ,
itemTitlePath:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
dynamicTree:
{
Description: The dynamic values tree configuration. ,
Required: False ,
}
{
settings:
{
Description: The tree settings ,
Required: False ,
}
{
CanSelectParentNodes:
{
Description: Indicates whether parent nodes can be selected. ,
Required: False ,
}
boolean ,
CanSelectLeafNodes:
{
Description: Indicates whether leaf nodes can be selected. ,
Required: False ,
}
boolean ,
}
,
open:
{
Description: The tree on-open configuration ,
Required: False ,
}
{
operationId:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
itemsPath:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
itemValuePath:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
itemTitlePath:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
itemFullTitlePath:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
itemIsParent:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
selectableFilter:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
parameters:
{
Required: False ,
}
object ,
}
,
browse:
{
Description: The tree on-browse configuration ,
Required: False ,
}
{
operationId:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
itemsPath:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
itemValuePath:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
itemTitlePath:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
itemFullTitlePath:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
itemIsParent:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
selectableFilter:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
parameters:
{
Required: False ,
}
object ,
}
,
}
,
}
,
responsesDefinition:
{
Description: The operation responses definition schemas. ,
Required: False ,
}
object ,
isWebhook:
{
Description: Indicates whether the API operation is webhook or not. ,
Required: False ,
}
boolean ,
isNotification:
{
Description: Indicates whether the API operation is notification or not. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Operations_List (new)
Description :  Lists all of the available Logic REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Logic/operations
{
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Logic operations supported by the Logic resource provider. ,
Required: False ,
}
[
{
origin:
{
Description: Operation: origin ,
Required: False ,
}
string ,
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Logic ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Profile, endpoint, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Operation: description. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_ListBySubscription (removed)
Description :  Gets a list of workflows by subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Logic/workflows
{
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 ,
$filter:
{
Description: The filter to apply on the operation. Options for filters include: State, Trigger, and ReferencedResourceId. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of workflows. ,
Required: False ,
}
[
{
properties:
{
Description: The workflow properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The 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: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_ListByResourceGroup (removed)
Description :  Gets a list of workflows by resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows
{
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 ,
$filter:
{
Description: The filter to apply on the operation. Options for filters include: State, Trigger, and ReferencedResourceId. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of workflows. ,
Required: False ,
}
[
{
properties:
{
Description: The workflow properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The 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: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_Get (removed)
Description :  Gets a workflow.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: The workflow properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The 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: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_CreateOrUpdate (removed)
Description :  Creates or updates a workflow.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
workflow:
{
Description: The workflow. ,
Required: True ,
}
{
properties:
{
Description: The workflow properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The 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: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The workflow properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The 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: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The workflow properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The 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: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_Update (removed)
Description :  Updates a workflow.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workflow properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The 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: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_Delete (removed)
Description :  Deletes a workflow.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_Disable (removed)
Description :  Disables a workflow.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/disable
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_Enable (removed)
Description :  Enables a workflow.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/enable
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_GenerateUpgradedDefinition (removed)
Description :  Generates the upgraded definition for a workflow.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/generateUpgradedDefinition
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters for generating an upgraded definition. ,
Required: True ,
}
{
targetSchemaVersion:
{
Description: The target schema version. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_ListCallbackUrl (removed)
Description :  Get the workflow callback Url.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/listCallbackUrl
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
listCallbackUrl:
{
Description: Which callback url to list. ,
Required: True ,
}
{
notAfter:
{
Description: The expiry time. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: The key type. ,
Enum:
{
NotSpecified: No description available. ,
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the workflow trigger callback URL. ,
Required: False ,
}
string ,
method:
{
Description: Gets the workflow trigger callback URL HTTP method. ,
Required: False ,
}
string ,
basePath:
{
Description: Gets the workflow trigger callback URL base path. ,
Required: False ,
}
string ,
relativePath:
{
Description: Gets the workflow trigger callback URL relative path. ,
Required: False ,
}
string ,
relativePathParameters:
{
Description: Gets the workflow trigger callback URL relative path parameters. ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: Gets the workflow trigger callback URL query parameters. ,
Required: False ,
}
{
api-version:
{
Description: The api version. ,
Required: False ,
}
string ,
sp:
{
Description: The SAS permissions. ,
Required: False ,
}
string ,
sv:
{
Description: The SAS version. ,
Required: False ,
}
string ,
sig:
{
Description: The SAS signature. ,
Required: False ,
}
string ,
se:
{
Description: The SAS timestamp. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_ListSwagger (removed)
Description :  Gets an OpenAPI definition for the workflow.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/listSwagger
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_Move (removed)
Description :  Moves an existing workflow.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/move
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
move:
{
Description: The workflow to move. ,
Required: True ,
}
{
name:
{
Description: The workflow name. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_RegenerateAccessKey (removed)
Description :  Regenerates the callback URL access key for request triggers.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/regenerateAccessKey
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
keyType:
{
Description: The access key type. ,
Required: True ,
}
{
keyType:
{
Description: The key type. ,
Enum:
{
NotSpecified: No description available. ,
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_ValidateByResourceGroup (removed)
Description :  Validates the workflow.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/validate
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
validate:
{
Description: The workflow. ,
Required: True ,
}
{
properties:
{
Description: The workflow properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The 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: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowVersions_List (removed)
Description :  Gets a list of workflow versions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/versions
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow 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: A list of workflow versions. ,
Required: False ,
}
[
{
properties:
{
Description: The workflow version properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The 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: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowVersions_Get (removed)
Description :  Gets a workflow version.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/versions/{versionId}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
versionId:
{
Description: The workflow versionId. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workflow version properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The 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: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggers_List (removed)
Description :  Gets a list of workflow triggers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow 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: A list of workflow triggers. ,
Required: False ,
}
[
{
properties:
{
Description: The workflow trigger properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Gets the state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
lastExecutionTime:
{
Description: Gets the last execution time. ,
Format: date-time ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Gets the next execution time. ,
Format: date-time ,
Required: False ,
}
string ,
recurrence:
{
Description: Gets the workflow trigger recurrence. ,
Required: False ,
}
{
frequency:
{
Description: The frequency. ,
Enum:
{
NotSpecified: No description available. ,
Second: No description available. ,
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
Year: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone. ,
Required: False ,
}
string ,
schedule:
{
Description: The recurrence schedule. ,
Required: False ,
}
{
minutes:
{
Description: The minutes. ,
Required: False ,
}
[
integer ,
]
,
hours:
{
Description: The hours. ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: The month days. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: The monthly occurrences. ,
Required: False ,
}
[
{
day:
{
Description: The day of the week. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
occurrence:
{
Description: The occurrence. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
workflow:
{
Description: Gets the reference to workflow. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Gets the workflow trigger name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow trigger type. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggers_Get (removed)
Description :  Gets a workflow trigger.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workflow trigger properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: Gets the state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
lastExecutionTime:
{
Description: Gets the last execution time. ,
Format: date-time ,
Required: False ,
}
string ,
nextExecutionTime:
{
Description: Gets the next execution time. ,
Format: date-time ,
Required: False ,
}
string ,
recurrence:
{
Description: Gets the workflow trigger recurrence. ,
Required: False ,
}
{
frequency:
{
Description: The frequency. ,
Enum:
{
NotSpecified: No description available. ,
Second: No description available. ,
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
Year: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone. ,
Required: False ,
}
string ,
schedule:
{
Description: The recurrence schedule. ,
Required: False ,
}
{
minutes:
{
Description: The minutes. ,
Required: False ,
}
[
integer ,
]
,
hours:
{
Description: The hours. ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: The month days. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: The monthly occurrences. ,
Required: False ,
}
[
{
day:
{
Description: The day of the week. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
occurrence:
{
Description: The occurrence. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
workflow:
{
Description: Gets the reference to workflow. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Gets the workflow trigger name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow trigger type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggers_Reset (removed)
Description :  Resets a workflow trigger.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/reset
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggers_Run (removed)
Description :  Runs a workflow trigger.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/run
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggers_GetSchemaJson (removed)
Description :  Get the trigger schema as JSON.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/schemas/json
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
title:
{
Description: The JSON title. ,
Required: False ,
}
string ,
content:
{
Description: The JSON content. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggers_SetState (removed)
Description :  Sets the state of a workflow trigger.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/setState
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
setState:
{
Description: The workflow trigger state. ,
Required: True ,
}
{
source:
{
Description: The source. ,
Required: True ,
}
{
name:
{
Description: The workflow trigger resource reference name. ,
Required: False ,
}
string ,
flowName:
{
Description: The workflow name. ,
Required: False ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggers_ListCallbackUrl (removed)
Description :  Get the callback URL for a workflow trigger.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/listCallbackUrl
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the workflow trigger callback URL. ,
Required: False ,
}
string ,
method:
{
Description: Gets the workflow trigger callback URL HTTP method. ,
Required: False ,
}
string ,
basePath:
{
Description: Gets the workflow trigger callback URL base path. ,
Required: False ,
}
string ,
relativePath:
{
Description: Gets the workflow trigger callback URL relative path. ,
Required: False ,
}
string ,
relativePathParameters:
{
Description: Gets the workflow trigger callback URL relative path parameters. ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: Gets the workflow trigger callback URL query parameters. ,
Required: False ,
}
{
api-version:
{
Description: The api version. ,
Required: False ,
}
string ,
sp:
{
Description: The SAS permissions. ,
Required: False ,
}
string ,
sv:
{
Description: The SAS version. ,
Required: False ,
}
string ,
sig:
{
Description: The SAS signature. ,
Required: False ,
}
string ,
se:
{
Description: The SAS timestamp. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowVersionTriggers_ListCallbackUrl (removed)
Description :  Get the callback url for a trigger of a workflow version.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/versions/{versionId}/triggers/{triggerName}/listCallbackUrl
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
versionId:
{
Description: The workflow versionId. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
parameters:
{
Description: The callback URL parameters. ,
Required: False ,
}
{
notAfter:
{
Description: The expiry time. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: The key type. ,
Enum:
{
NotSpecified: No description available. ,
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the workflow trigger callback URL. ,
Required: False ,
}
string ,
method:
{
Description: Gets the workflow trigger callback URL HTTP method. ,
Required: False ,
}
string ,
basePath:
{
Description: Gets the workflow trigger callback URL base path. ,
Required: False ,
}
string ,
relativePath:
{
Description: Gets the workflow trigger callback URL relative path. ,
Required: False ,
}
string ,
relativePathParameters:
{
Description: Gets the workflow trigger callback URL relative path parameters. ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: Gets the workflow trigger callback URL query parameters. ,
Required: False ,
}
{
api-version:
{
Description: The api version. ,
Required: False ,
}
string ,
sp:
{
Description: The SAS permissions. ,
Required: False ,
}
string ,
sv:
{
Description: The SAS version. ,
Required: False ,
}
string ,
sig:
{
Description: The SAS signature. ,
Required: False ,
}
string ,
se:
{
Description: The SAS timestamp. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggerHistories_List (removed)
Description :  Gets a list of workflow trigger histories.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/histories
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger 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. Options for filters include: Status, StartTime, and ClientTrackingId. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workflow trigger histories. ,
Required: False ,
}
[
{
properties:
{
Description: Gets the workflow trigger history properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
scheduledTime:
{
Description: The scheduled time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
inputsLink:
{
Description: Gets the link to input parameters. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputsLink:
{
Description: Gets the link to output parameters. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
fired:
{
Description: The value indicating whether trigger was fired. ,
Required: False ,
}
boolean ,
run:
{
Description: Gets the reference to workflow run. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Gets the workflow trigger history name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow trigger history type. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggerHistories_Get (removed)
Description :  Gets a workflow trigger history.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
historyName:
{
Description: The workflow trigger history name. Corresponds to the run name for triggers that resulted in a run. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Gets the workflow trigger history properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
scheduledTime:
{
Description: The scheduled time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
inputsLink:
{
Description: Gets the link to input parameters. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputsLink:
{
Description: Gets the link to output parameters. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
fired:
{
Description: The value indicating whether trigger was fired. ,
Required: False ,
}
boolean ,
run:
{
Description: Gets the reference to workflow run. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
name:
{
Description: Gets the workflow trigger history name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow trigger history type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowTriggerHistories_Resubmit (removed)
Description :  Resubmits a workflow run based on the trigger history.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName}/resubmit
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
triggerName:
{
Description: The workflow trigger name. ,
Required: True ,
}
string ,
historyName:
{
Description: The workflow trigger history name. Corresponds to the run name for triggers that resulted in a run. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRuns_List (removed)
Description :  Gets a list of workflow runs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow 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. Options for filters include: Status, StartTime, and ClientTrackingId. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workflow runs. ,
Required: False ,
}
[
{
properties:
{
Description: The workflow run properties. ,
Required: False ,
}
{
waitEndTime:
{
Description: Gets the wait end time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
correlationId:
{
Description: Gets the correlation id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
workflow:
{
Description: Gets the reference to workflow version. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: Gets the fired trigger. ,
Required: False ,
}
{
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
inputs:
{
Description: Gets the inputs. ,
Required: False ,
}
object ,
inputsLink:
{
Description: Gets the link to inputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
outputsLink:
{
Description: Gets the link to outputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
scheduledTime:
{
Description: Gets the scheduled time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackedProperties:
{
Description: Gets the tracked properties. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
response:
{
Description: Gets the response of the flow run. ,
Required: False ,
}
{
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
inputs:
{
Description: Gets the inputs. ,
Required: False ,
}
object ,
inputsLink:
{
Description: Gets the link to inputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
outputsLink:
{
Description: Gets the link to outputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
scheduledTime:
{
Description: Gets the scheduled time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackedProperties:
{
Description: Gets the tracked properties. ,
Required: False ,
}
object ,
}
,
}
,
name:
{
Description: Gets the workflow run name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow run type. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRuns_Get (removed)
Description :  Gets a workflow run.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workflow run properties. ,
Required: False ,
}
{
waitEndTime:
{
Description: Gets the wait end time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
correlationId:
{
Description: Gets the correlation id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
workflow:
{
Description: Gets the reference to workflow version. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: Gets the fired trigger. ,
Required: False ,
}
{
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
inputs:
{
Description: Gets the inputs. ,
Required: False ,
}
object ,
inputsLink:
{
Description: Gets the link to inputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
outputsLink:
{
Description: Gets the link to outputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
scheduledTime:
{
Description: Gets the scheduled time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackedProperties:
{
Description: Gets the tracked properties. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
response:
{
Description: Gets the response of the flow run. ,
Required: False ,
}
{
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
inputs:
{
Description: Gets the inputs. ,
Required: False ,
}
object ,
inputsLink:
{
Description: Gets the link to inputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
outputsLink:
{
Description: Gets the link to outputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
scheduledTime:
{
Description: Gets the scheduled time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackedProperties:
{
Description: Gets the tracked properties. ,
Required: False ,
}
object ,
}
,
}
,
name:
{
Description: Gets the workflow run name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow run type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRuns_Cancel (removed)
Description :  Cancels a workflow run.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/cancel
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActions_List (removed)
Description :  Gets a list of workflow run actions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run 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. Options for filters include: Status. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workflow run actions. ,
Required: False ,
}
[
{
properties:
{
Description: The workflow run action properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The correlation properties. ,
Required: False ,
}
{
actionTrackingId:
{
Description: The action tracking identifier. ,
Required: False ,
}
string ,
}
,
inputsLink:
{
Description: Gets the link to inputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputsLink:
{
Description: Gets the link to outputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
trackedProperties:
{
Description: Gets the tracked properties. ,
Required: False ,
}
object ,
retryHistory:
{
Description: Gets the retry histories. ,
Required: False ,
}
[
{
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: Gets the status code. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Gets the service request Id. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error response. ,
Required: False ,
}
{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
name:
{
Description: Gets the workflow run action name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow run action type. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActions_Get (removed)
Description :  Gets a workflow run action.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workflow run action properties. ,
Required: False ,
}
{
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The correlation properties. ,
Required: False ,
}
{
actionTrackingId:
{
Description: The action tracking identifier. ,
Required: False ,
}
string ,
}
,
inputsLink:
{
Description: Gets the link to inputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputsLink:
{
Description: Gets the link to outputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
trackedProperties:
{
Description: Gets the tracked properties. ,
Required: False ,
}
object ,
retryHistory:
{
Description: Gets the retry histories. ,
Required: False ,
}
[
{
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
code:
{
Description: Gets the status code. ,
Required: False ,
}
string ,
clientRequestId:
{
Description: Gets the client request Id. ,
Required: False ,
}
string ,
serviceRequestId:
{
Description: Gets the service request Id. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error response. ,
Required: False ,
}
{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
name:
{
Description: Gets the workflow run action name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow run action type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActions_ListExpressionTraces (removed)
Description :  Lists a workflow run expression trace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/listExpressionTraces
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
inputs:
{
Required: False ,
}
[
{
path:
{
Description: The path. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionRepetitions_List (removed)
Description :  Get all of a workflow run action repetitions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
value:
{
Required: False ,
}
[
{
properties:
{
Description: The workflow run action repetition properties definition. ,
Required: True ,
}
{
repetitionIndexes:
{
Description: The repetition indexes. ,
Required: False ,
}
[
{
scopeName:
{
Description: The scope. ,
Required: False ,
}
string ,
itemIndex:
{
Description: The index. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionRepetitions_Get (removed)
Description :  Get a workflow run action repetition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
repetitionName:
{
Description: The workflow repetition. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workflow run action repetition properties definition. ,
Required: True ,
}
{
repetitionIndexes:
{
Description: The repetition indexes. ,
Required: False ,
}
[
{
scopeName:
{
Description: The scope. ,
Required: False ,
}
string ,
itemIndex:
{
Description: The index. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionRepetitions_ListExpressionTraces (removed)
Description :  Lists a workflow run expression trace.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/listExpressionTraces
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
repetitionName:
{
Description: The workflow repetition. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
inputs:
{
Required: False ,
}
[
{
path:
{
Description: The path. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionRepetitionsRequestHistories_List (removed)
Description :  List a workflow run repetition request history.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
repetitionName:
{
Description: The workflow repetition. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workflow request histories. ,
Required: False ,
}
[
{
properties:
{
Description: The request history properties. ,
Required: False ,
}
{
startTime:
{
Description: The time the request started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time the request ended. ,
Format: date-time ,
Required: False ,
}
string ,
request:
{
Description: The request. ,
Required: False ,
}
{
headers:
{
Description: A list of all the headers attached to the request. ,
Required: False ,
}
object ,
uri:
{
Description: The destination for the request. ,
Required: False ,
}
string ,
method:
{
Description: The HTTP method used for the request. ,
Required: False ,
}
string ,
}
,
response:
{
Description: The response. ,
Required: False ,
}
{
headers:
{
Description: A list of all the headers attached to the response. ,
Required: False ,
}
object ,
statusCode:
{
Description: The status code of the response. ,
Format: int32 ,
Required: False ,
}
integer ,
bodyLink:
{
Description: Details on the location of the body content. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionRepetitionsRequestHistories_Get (removed)
Description :  Gets a workflow run repetition request history.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories/{requestHistoryName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
repetitionName:
{
Description: The workflow repetition. ,
Required: True ,
}
string ,
requestHistoryName:
{
Description: The request history name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The request history properties. ,
Required: False ,
}
{
startTime:
{
Description: The time the request started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time the request ended. ,
Format: date-time ,
Required: False ,
}
string ,
request:
{
Description: The request. ,
Required: False ,
}
{
headers:
{
Description: A list of all the headers attached to the request. ,
Required: False ,
}
object ,
uri:
{
Description: The destination for the request. ,
Required: False ,
}
string ,
method:
{
Description: The HTTP method used for the request. ,
Required: False ,
}
string ,
}
,
response:
{
Description: The response. ,
Required: False ,
}
{
headers:
{
Description: A list of all the headers attached to the response. ,
Required: False ,
}
object ,
statusCode:
{
Description: The status code of the response. ,
Format: int32 ,
Required: False ,
}
integer ,
bodyLink:
{
Description: Details on the location of the body content. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionRequestHistories_List (removed)
Description :  List a workflow run request history.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/requestHistories
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A list of workflow request histories. ,
Required: False ,
}
[
{
properties:
{
Description: The request history properties. ,
Required: False ,
}
{
startTime:
{
Description: The time the request started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time the request ended. ,
Format: date-time ,
Required: False ,
}
string ,
request:
{
Description: The request. ,
Required: False ,
}
{
headers:
{
Description: A list of all the headers attached to the request. ,
Required: False ,
}
object ,
uri:
{
Description: The destination for the request. ,
Required: False ,
}
string ,
method:
{
Description: The HTTP method used for the request. ,
Required: False ,
}
string ,
}
,
response:
{
Description: The response. ,
Required: False ,
}
{
headers:
{
Description: A list of all the headers attached to the response. ,
Required: False ,
}
object ,
statusCode:
{
Description: The status code of the response. ,
Format: int32 ,
Required: False ,
}
integer ,
bodyLink:
{
Description: Details on the location of the body content. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionRequestHistories_Get (removed)
Description :  Gets a workflow run request history.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/requestHistories/{requestHistoryName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
requestHistoryName:
{
Description: The request history name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The request history properties. ,
Required: False ,
}
{
startTime:
{
Description: The time the request started. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The time the request ended. ,
Format: date-time ,
Required: False ,
}
string ,
request:
{
Description: The request. ,
Required: False ,
}
{
headers:
{
Description: A list of all the headers attached to the request. ,
Required: False ,
}
object ,
uri:
{
Description: The destination for the request. ,
Required: False ,
}
string ,
method:
{
Description: The HTTP method used for the request. ,
Required: False ,
}
string ,
}
,
response:
{
Description: The response. ,
Required: False ,
}
{
headers:
{
Description: A list of all the headers attached to the response. ,
Required: False ,
}
object ,
statusCode:
{
Description: The status code of the response. ,
Format: int32 ,
Required: False ,
}
integer ,
bodyLink:
{
Description: Details on the location of the body content. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionScopeRepetitions_List (removed)
Description :  List the workflow run action scoped repetitions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/scopeRepetitions
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nextLink:
{
Description: The link used to get the next page of recommendations. ,
Required: False ,
}
string ,
value:
{
Required: False ,
}
[
{
properties:
{
Description: The workflow run action repetition properties definition. ,
Required: True ,
}
{
repetitionIndexes:
{
Description: The repetition indexes. ,
Required: False ,
}
[
{
scopeName:
{
Description: The scope. ,
Required: False ,
}
string ,
itemIndex:
{
Description: The index. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunActionScopeRepetitions_Get (removed)
Description :  Get a workflow run action scoped repetition.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/actions/{actionName}/scopeRepetitions/{repetitionName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
actionName:
{
Description: The workflow action name. ,
Required: True ,
}
string ,
repetitionName:
{
Description: The workflow repetition. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workflow run action repetition properties definition. ,
Required: True ,
}
{
repetitionIndexes:
{
Description: The repetition indexes. ,
Required: False ,
}
[
{
scopeName:
{
Description: The scope. ,
Required: False ,
}
string ,
itemIndex:
{
Description: The index. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
WorkflowRunOperations_Get (removed)
Description :  Gets an operation for a run.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/runs/{runName}/operations/{operationId}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
runName:
{
Description: The workflow run name. ,
Required: True ,
}
string ,
operationId:
{
Description: The workflow operation id. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The workflow run properties. ,
Required: False ,
}
{
waitEndTime:
{
Description: Gets the wait end time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
correlationId:
{
Description: Gets the correlation id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
workflow:
{
Description: Gets the reference to workflow version. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
trigger:
{
Description: Gets the fired trigger. ,
Required: False ,
}
{
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
inputs:
{
Description: Gets the inputs. ,
Required: False ,
}
object ,
inputsLink:
{
Description: Gets the link to inputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
outputsLink:
{
Description: Gets the link to outputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
scheduledTime:
{
Description: Gets the scheduled time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackedProperties:
{
Description: Gets the tracked properties. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
response:
{
Description: Gets the response of the flow run. ,
Required: False ,
}
{
name:
{
Description: Gets the name. ,
Required: False ,
}
string ,
inputs:
{
Description: Gets the inputs. ,
Required: False ,
}
object ,
inputsLink:
{
Description: Gets the link to inputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
outputs:
{
Description: Gets the outputs. ,
Required: False ,
}
object ,
outputsLink:
{
Description: Gets the link to outputs. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
scheduledTime:
{
Description: Gets the scheduled time. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: Gets the start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Gets the end time. ,
Format: date-time ,
Required: False ,
}
string ,
trackingId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
correlation:
{
Description: The run correlation. ,
Required: False ,
}
{
clientTrackingId:
{
Description: The client tracking id. ,
Required: False ,
}
string ,
}
,
code:
{
Description: Gets the code. ,
Required: False ,
}
string ,
status:
{
Description: Gets the status. ,
Enum:
{
NotSpecified: No description available. ,
Paused: No description available. ,
Running: No description available. ,
Waiting: No description available. ,
Succeeded: No description available. ,
Skipped: No description available. ,
Suspended: No description available. ,
Cancelled: No description available. ,
Failed: No description available. ,
Faulted: No description available. ,
TimedOut: No description available. ,
Aborted: No description available. ,
Ignored: No description available. ,
}
,
Required: False ,
}
enum ,
error:
{
Description: Gets the error. ,
Required: False ,
}
object ,
trackedProperties:
{
Description: Gets the tracked properties. ,
Required: False ,
}
object ,
}
,
}
,
name:
{
Description: Gets the workflow run name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the workflow run type. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Workflows_ValidateByLocation (removed)
Description :  Validates the workflow definition.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/locations/{location}/workflows/{workflowName}/validate
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The resource group name. ,
Required: True ,
}
string ,
location:
{
Description: The workflow location. ,
Required: True ,
}
string ,
workflowName:
{
Description: The workflow name. ,
Required: True ,
}
string ,
validate:
{
Description: The workflow. ,
Required: True ,
}
{
properties:
{
Description: The workflow properties. ,
Required: False ,
}
{
provisioningState:
{
Description: Gets the provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
createdTime:
{
Description: Gets the created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: Gets the changed time. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
version:
{
Description: Gets the version. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: Gets the access endpoint. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
accessControl:
{
Description: The access control configuration. ,
Required: False ,
}
{
triggers:
{
Description: The access control configuration for invoking workflow triggers. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
contents:
{
Description: The access control configuration for accessing workflow run contents. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
actions:
{
Description: The access control configuration for workflow actions. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
workflowManagement:
{
Description: The access control configuration for workflow management. ,
Required: False ,
}
{
allowedCallerIpAddresses:
{
Description: The allowed caller IP address ranges. ,
Required: False ,
}
[
{
addressRange:
{
Description: The IP address range. ,
Required: False ,
}
string ,
}
,
]
,
openAuthenticationPolicies:
{
Description: The authentication policies for workflow. ,
Required: False ,
}
{
policies:
{
Description: Open authentication policies. ,
Required: False ,
}
object ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The 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: True ,
}
enum ,
plan:
{
Description: The reference to plan. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
integrationAccount:
{
Description: The integration account. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
definition:
{
Description: The definition. ,
Required: False ,
}
object ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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 ,
}
{
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
state:
{
Description: The workflow state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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 ,
}
{
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
state:
{
Description: The workflow state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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 ,
}
{
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
state:
{
Description: The workflow state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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 ,
}
{
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
state:
{
Description: The workflow state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
{
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
state:
{
Description: The workflow state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
{
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
state:
{
Description: The workflow state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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 ,
}
{
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
state:
{
Description: The workflow state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
{
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
state:
{
Description: The workflow state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountAssemblies_List (removed)
Description :  List the assemblies for an integration account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/assemblies
{
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)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The assembly properties. ,
Required: True ,
}
{
assemblyName:
{
Description: The assembly name. ,
Required: True ,
}
string ,
assemblyVersion:
{
Description: The assembly version. ,
Required: False ,
}
string ,
assemblyCulture:
{
Description: The assembly culture. ,
Required: False ,
}
string ,
assemblyPublicKeyToken:
{
Description: The assembly public key token. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountAssemblies_Get (removed)
Description :  Get an assembly for an integration account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/assemblies/{assemblyArtifactName}
{
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 ,
assemblyArtifactName:
{
Description: The assembly artifact name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The assembly properties. ,
Required: True ,
}
{
assemblyName:
{
Description: The assembly name. ,
Required: True ,
}
string ,
assemblyVersion:
{
Description: The assembly version. ,
Required: False ,
}
string ,
assemblyCulture:
{
Description: The assembly culture. ,
Required: False ,
}
string ,
assemblyPublicKeyToken:
{
Description: The assembly public key token. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountAssemblies_CreateOrUpdate (removed)
Description :  Create or update an assembly for an integration account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/assemblies/{assemblyArtifactName}
{
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 ,
assemblyArtifactName:
{
Description: The assembly artifact name. ,
Required: True ,
}
string ,
assemblyArtifact:
{
Description: The assembly artifact. ,
Required: True ,
}
{
properties:
{
Description: The assembly properties. ,
Required: True ,
}
{
assemblyName:
{
Description: The assembly name. ,
Required: True ,
}
string ,
assemblyVersion:
{
Description: The assembly version. ,
Required: False ,
}
string ,
assemblyCulture:
{
Description: The assembly culture. ,
Required: False ,
}
string ,
assemblyPublicKeyToken:
{
Description: The assembly public key token. ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The assembly properties. ,
Required: True ,
}
{
assemblyName:
{
Description: The assembly name. ,
Required: True ,
}
string ,
assemblyVersion:
{
Description: The assembly version. ,
Required: False ,
}
string ,
assemblyCulture:
{
Description: The assembly culture. ,
Required: False ,
}
string ,
assemblyPublicKeyToken:
{
Description: The assembly public key token. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The assembly properties. ,
Required: True ,
}
{
assemblyName:
{
Description: The assembly name. ,
Required: True ,
}
string ,
assemblyVersion:
{
Description: The assembly version. ,
Required: False ,
}
string ,
assemblyCulture:
{
Description: The assembly culture. ,
Required: False ,
}
string ,
assemblyPublicKeyToken:
{
Description: The assembly public key token. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountAssemblies_Delete (removed)
Description :  Delete an assembly for an integration account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/assemblies/{assemblyArtifactName}
{
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 ,
assemblyArtifactName:
{
Description: The assembly artifact name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountAssemblies_ListContentCallbackUrl (removed)
Description :  Get the content callback url for an integration account assembly.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/assemblies/{assemblyArtifactName}/listContentCallbackUrl
{
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 ,
assemblyArtifactName:
{
Description: The assembly artifact name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Gets the workflow trigger callback URL. ,
Required: False ,
}
string ,
method:
{
Description: Gets the workflow trigger callback URL HTTP method. ,
Required: False ,
}
string ,
basePath:
{
Description: Gets the workflow trigger callback URL base path. ,
Required: False ,
}
string ,
relativePath:
{
Description: Gets the workflow trigger callback URL relative path. ,
Required: False ,
}
string ,
relativePathParameters:
{
Description: Gets the workflow trigger callback URL relative path parameters. ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: Gets the workflow trigger callback URL query parameters. ,
Required: False ,
}
{
api-version:
{
Description: The api version. ,
Required: False ,
}
string ,
sp:
{
Description: The SAS permissions. ,
Required: False ,
}
string ,
sv:
{
Description: The SAS version. ,
Required: False ,
}
string ,
sig:
{
Description: The SAS signature. ,
Required: False ,
}
string ,
se:
{
Description: The SAS timestamp. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountBatchConfigurations_List (removed)
Description :  List the batch configurations for an integration account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/batchConfigurations
{
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)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: The batch configuration properties. ,
Required: True ,
}
{
batchGroupName:
{
Description: The name of the batch group. ,
Required: True ,
}
string ,
releaseCriteria:
{
Description: The batch release criteria. ,
Required: True ,
}
{
messageCount:
{
Description: The message count. ,
Format: int32 ,
Required: False ,
}
integer ,
batchSize:
{
Description: The batch size in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
recurrence:
{
Description: The recurrence. ,
Required: False ,
}
{
frequency:
{
Description: The frequency. ,
Enum:
{
NotSpecified: No description available. ,
Second: No description available. ,
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
Year: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone. ,
Required: False ,
}
string ,
schedule:
{
Description: The recurrence schedule. ,
Required: False ,
}
{
minutes:
{
Description: The minutes. ,
Required: False ,
}
[
integer ,
]
,
hours:
{
Description: The hours. ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: The month days. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: The monthly occurrences. ,
Required: False ,
}
[
{
day:
{
Description: The day of the week. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
occurrence:
{
Description: The occurrence. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountBatchConfigurations_Get (removed)
Description :  Get a batch configuration for an integration account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/batchConfigurations/{batchConfigurationName}
{
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 ,
batchConfigurationName:
{
Description: The batch configuration name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The batch configuration properties. ,
Required: True ,
}
{
batchGroupName:
{
Description: The name of the batch group. ,
Required: True ,
}
string ,
releaseCriteria:
{
Description: The batch release criteria. ,
Required: True ,
}
{
messageCount:
{
Description: The message count. ,
Format: int32 ,
Required: False ,
}
integer ,
batchSize:
{
Description: The batch size in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
recurrence:
{
Description: The recurrence. ,
Required: False ,
}
{
frequency:
{
Description: The frequency. ,
Enum:
{
NotSpecified: No description available. ,
Second: No description available. ,
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
Year: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone. ,
Required: False ,
}
string ,
schedule:
{
Description: The recurrence schedule. ,
Required: False ,
}
{
minutes:
{
Description: The minutes. ,
Required: False ,
}
[
integer ,
]
,
hours:
{
Description: The hours. ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: The month days. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: The monthly occurrences. ,
Required: False ,
}
[
{
day:
{
Description: The day of the week. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
occurrence:
{
Description: The occurrence. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountBatchConfigurations_CreateOrUpdate (removed)
Description :  Create or update a batch configuration for an integration account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/batchConfigurations/{batchConfigurationName}
{
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 ,
batchConfigurationName:
{
Description: The batch configuration name. ,
Required: True ,
}
string ,
batchConfiguration:
{
Description: The batch configuration. ,
Required: True ,
}
{
properties:
{
Description: The batch configuration properties. ,
Required: True ,
}
{
batchGroupName:
{
Description: The name of the batch group. ,
Required: True ,
}
string ,
releaseCriteria:
{
Description: The batch release criteria. ,
Required: True ,
}
{
messageCount:
{
Description: The message count. ,
Format: int32 ,
Required: False ,
}
integer ,
batchSize:
{
Description: The batch size in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
recurrence:
{
Description: The recurrence. ,
Required: False ,
}
{
frequency:
{
Description: The frequency. ,
Enum:
{
NotSpecified: No description available. ,
Second: No description available. ,
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
Year: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone. ,
Required: False ,
}
string ,
schedule:
{
Description: The recurrence schedule. ,
Required: False ,
}
{
minutes:
{
Description: The minutes. ,
Required: False ,
}
[
integer ,
]
,
hours:
{
Description: The hours. ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: The month days. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: The monthly occurrences. ,
Required: False ,
}
[
{
day:
{
Description: The day of the week. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
occurrence:
{
Description: The occurrence. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The batch configuration properties. ,
Required: True ,
}
{
batchGroupName:
{
Description: The name of the batch group. ,
Required: True ,
}
string ,
releaseCriteria:
{
Description: The batch release criteria. ,
Required: True ,
}
{
messageCount:
{
Description: The message count. ,
Format: int32 ,
Required: False ,
}
integer ,
batchSize:
{
Description: The batch size in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
recurrence:
{
Description: The recurrence. ,
Required: False ,
}
{
frequency:
{
Description: The frequency. ,
Enum:
{
NotSpecified: No description available. ,
Second: No description available. ,
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
Year: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone. ,
Required: False ,
}
string ,
schedule:
{
Description: The recurrence schedule. ,
Required: False ,
}
{
minutes:
{
Description: The minutes. ,
Required: False ,
}
[
integer ,
]
,
hours:
{
Description: The hours. ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: The month days. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: The monthly occurrences. ,
Required: False ,
}
[
{
day:
{
Description: The day of the week. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
occurrence:
{
Description: The occurrence. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The batch configuration properties. ,
Required: True ,
}
{
batchGroupName:
{
Description: The name of the batch group. ,
Required: True ,
}
string ,
releaseCriteria:
{
Description: The batch release criteria. ,
Required: True ,
}
{
messageCount:
{
Description: The message count. ,
Format: int32 ,
Required: False ,
}
integer ,
batchSize:
{
Description: The batch size in bytes. ,
Format: int32 ,
Required: False ,
}
integer ,
recurrence:
{
Description: The recurrence. ,
Required: False ,
}
{
frequency:
{
Description: The frequency. ,
Enum:
{
NotSpecified: No description available. ,
Second: No description available. ,
Minute: No description available. ,
Hour: No description available. ,
Day: No description available. ,
Week: No description available. ,
Month: No description available. ,
Year: No description available. ,
}
,
Required: False ,
}
enum ,
interval:
{
Description: The interval. ,
Format: int32 ,
Required: False ,
}
integer ,
startTime:
{
Description: The start time. ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Required: False ,
}
string ,
timeZone:
{
Description: The time zone. ,
Required: False ,
}
string ,
schedule:
{
Description: The recurrence schedule. ,
Required: False ,
}
{
minutes:
{
Description: The minutes. ,
Required: False ,
}
[
integer ,
]
,
hours:
{
Description: The hours. ,
Required: False ,
}
[
integer ,
]
,
weekDays:
{
Description: The days of the week. ,
Required: False ,
}
[
string ,
]
,
monthDays:
{
Description: The month days. ,
Required: False ,
}
[
integer ,
]
,
monthlyOccurrences:
{
Description: The monthly occurrences. ,
Required: False ,
}
[
{
day:
{
Description: The day of the week. ,
Enum:
{
Sunday: No description available. ,
Monday: No description available. ,
Tuesday: No description available. ,
Wednesday: No description available. ,
Thursday: No description available. ,
Friday: No description available. ,
Saturday: No description available. ,
}
,
Required: False ,
}
enum ,
occurrence:
{
Description: The occurrence. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
}
,
createdTime:
{
Description: The created time. ,
Format: date-time ,
Required: False ,
}
string ,
changedTime:
{
Description: The changed time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountBatchConfigurations_Delete (removed)
Description :  Delete a batch configuration for an integration account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/batchConfigurations/{batchConfigurationName}
{
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 ,
batchConfigurationName:
{
Description: The batch configuration name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccounts_ListCallbackUrl (removed)
Description :  Gets 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 ,
keyType:
{
Description: The key type. ,
Enum:
{
NotSpecified: No description available. ,
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The URL value. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccounts_ListKeyVaultKeys (removed)
Description :  Gets the integration account's Key Vault keys.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/listKeyVaultKeys
{
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 ,
listKeyVaultKeys:
{
Description: The key vault parameters. ,
Required: True ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: True ,
}
{
name:
{
Description: The key vault name. ,
Required: False ,
}
string ,
}
,
skipToken:
{
Description: The skip token. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The key vault keys. ,
Required: False ,
}
[
{
kid:
{
Description: The key id. ,
Required: False ,
}
string ,
attributes:
{
Description: The key attributes. ,
Required: False ,
}
{
enabled:
{
Description: Whether the key is enabled or not. ,
Required: False ,
}
boolean ,
created:
{
Description: When the key was created. ,
Format: int64 ,
Required: False ,
}
integer ,
updated:
{
Description: When the key was updated. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
skipToken:
{
Description: The skip token. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccounts_LogTrackingEvents (removed)
Description :  Logs the integration account's tracking events.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/logTrackingEvents
{
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 ,
logTrackingEvents:
{
Description: The callback URL parameters. ,
Required: True ,
}
{
sourceType:
{
Description: The source type. ,
Required: True ,
}
string ,
trackEventsOptions:
{
Description: The track events options. ,
Enum:
{
None: No description available. ,
DisableSourceInfoEnrich: No description available. ,
}
,
Required: False ,
}
enum ,
events:
{
Description: The events. ,
Required: True ,
}
[
{
eventLevel:
{
Description: The event level. ,
Enum:
{
LogAlways: No description available. ,
Critical: No description available. ,
Error: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
Verbose: No description available. ,
}
,
Required: True ,
}
enum ,
eventTime:
{
Description: The event time. ,
Format: date-time ,
Required: True ,
}
string ,
recordType:
{
Description: The record type. ,
Enum:
{
NotSpecified: No description available. ,
Custom: No description available. ,
AS2Message: No description available. ,
AS2MDN: No description available. ,
X12Interchange: No description available. ,
X12FunctionalGroup: No description available. ,
X12TransactionSet: No description available. ,
X12InterchangeAcknowledgment: No description available. ,
X12FunctionalGroupAcknowledgment: No description available. ,
X12TransactionSetAcknowledgment: No description available. ,
EdifactInterchange: No description available. ,
EdifactFunctionalGroup: No description available. ,
EdifactTransactionSet: No description available. ,
EdifactInterchangeAcknowledgment: No description available. ,
EdifactFunctionalGroupAcknowledgment: No description available. ,
EdifactTransactionSetAcknowledgment: No description available. ,
}
,
Required: True ,
}
enum ,
record:
{
Description: The record. ,
Required: False ,
}
object ,
error:
{
Description: The error. ,
Required: False ,
}
{
message:
{
Description: The message. ,
Required: False ,
}
string ,
code:
{
Description: The code. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccounts_RegenerateAccessKey (removed)
Description :  Regenerates the integration account access key.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/regenerateAccessKey
{
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 ,
regenerateAccessKey:
{
Description: The access key type. ,
Required: True ,
}
{
keyType:
{
Description: The key type. ,
Enum:
{
NotSpecified: No description available. ,
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account properties. ,
Required: False ,
}
{
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
state:
{
Description: The workflow state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Free: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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. Options for filters include: SchemaType. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration account schemas. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account schema properties. ,
Required: True ,
}
{
schemaType:
{
Description: The schema type. ,
Enum:
{
NotSpecified: No description available. ,
Xml: No description available. ,
}
,
Required: True ,
}
enum ,
targetNamespace:
{
Description: The target namespace of the schema. ,
Required: False ,
}
string ,
documentName:
{
Description: The document name. ,
Required: False ,
}
string ,
fileName:
{
Description: The file name. ,
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 ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
content:
{
Description: The content. ,
Required: False ,
}
string ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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: True ,
}
{
schemaType:
{
Description: The schema type. ,
Enum:
{
NotSpecified: No description available. ,
Xml: No description available. ,
}
,
Required: True ,
}
enum ,
targetNamespace:
{
Description: The target namespace of the schema. ,
Required: False ,
}
string ,
documentName:
{
Description: The document name. ,
Required: False ,
}
string ,
fileName:
{
Description: The file name. ,
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 ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
content:
{
Description: The content. ,
Required: False ,
}
string ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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: True ,
}
{
schemaType:
{
Description: The schema type. ,
Enum:
{
NotSpecified: No description available. ,
Xml: No description available. ,
}
,
Required: True ,
}
enum ,
targetNamespace:
{
Description: The target namespace of the schema. ,
Required: False ,
}
string ,
documentName:
{
Description: The document name. ,
Required: False ,
}
string ,
fileName:
{
Description: The file name. ,
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 ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
content:
{
Description: The content. ,
Required: False ,
}
string ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account schema properties. ,
Required: True ,
}
{
schemaType:
{
Description: The schema type. ,
Enum:
{
NotSpecified: No description available. ,
Xml: No description available. ,
}
,
Required: True ,
}
enum ,
targetNamespace:
{
Description: The target namespace of the schema. ,
Required: False ,
}
string ,
documentName:
{
Description: The document name. ,
Required: False ,
}
string ,
fileName:
{
Description: The file name. ,
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 ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
content:
{
Description: The content. ,
Required: False ,
}
string ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration account schema properties. ,
Required: True ,
}
{
schemaType:
{
Description: The schema type. ,
Enum:
{
NotSpecified: No description available. ,
Xml: No description available. ,
}
,
Required: True ,
}
enum ,
targetNamespace:
{
Description: The target namespace of the schema. ,
Required: False ,
}
string ,
documentName:
{
Description: The document name. ,
Required: False ,
}
string ,
fileName:
{
Description: The file name. ,
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 ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
content:
{
Description: The content. ,
Required: False ,
}
string ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountSchemas_ListContentCallbackUrl (removed)
Description :  Get the content callback url.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/schemas/{schemaName}/listContentCallbackUrl
{
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 ,
listContentCallbackUrl:
{
Required: True ,
}
{
notAfter:
{
Description: The expiry time. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: The key type. ,
Enum:
{
NotSpecified: No description available. ,
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
value:
{
Description: Gets the workflow trigger callback URL. ,
Required: False ,
}
string ,
method:
{
Description: Gets the workflow trigger callback URL HTTP method. ,
Required: False ,
}
string ,
basePath:
{
Description: Gets the workflow trigger callback URL base path. ,
Required: False ,
}
string ,
relativePath:
{
Description: Gets the workflow trigger callback URL relative path. ,
Required: False ,
}
string ,
relativePathParameters:
{
Description: Gets the workflow trigger callback URL relative path parameters. ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: Gets the workflow trigger callback URL query parameters. ,
Required: False ,
}
{
api-version:
{
Description: The api version. ,
Required: False ,
}
string ,
sp:
{
Description: The SAS permissions. ,
Required: False ,
}
string ,
sv:
{
Description: The SAS version. ,
Required: False ,
}
string ,
sig:
{
Description: The SAS signature. ,
Required: False ,
}
string ,
se:
{
Description: The SAS timestamp. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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. Options for filters include: MapType. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration account maps. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account map properties. ,
Required: True ,
}
{
mapType:
{
Description: The map type. ,
Enum:
{
NotSpecified: No description available. ,
Xslt: No description available. ,
Xslt20: No description available. ,
Xslt30: No description available. ,
Liquid: No description available. ,
}
,
Required: True ,
}
enum ,
parametersSchema:
{
Description: The parameters schema of integration account map. ,
Required: False ,
}
{
ref:
{
Description: The reference name. ,
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 ,
}
string ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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: True ,
}
{
mapType:
{
Description: The map type. ,
Enum:
{
NotSpecified: No description available. ,
Xslt: No description available. ,
Xslt20: No description available. ,
Xslt30: No description available. ,
Liquid: No description available. ,
}
,
Required: True ,
}
enum ,
parametersSchema:
{
Description: The parameters schema of integration account map. ,
Required: False ,
}
{
ref:
{
Description: The reference name. ,
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 ,
}
string ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountMaps_CreateOrUpdate (removed)
Description :  Creates or updates an integration account map. If the map is larger than 4 MB, you need to store the map in an Azure blob and use the blob's Shared Access Signature (SAS) URL as the 'contentLink' property value.
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: True ,
}
{
mapType:
{
Description: The map type. ,
Enum:
{
NotSpecified: No description available. ,
Xslt: No description available. ,
Xslt20: No description available. ,
Xslt30: No description available. ,
Liquid: No description available. ,
}
,
Required: True ,
}
enum ,
parametersSchema:
{
Description: The parameters schema of integration account map. ,
Required: False ,
}
{
ref:
{
Description: The reference name. ,
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 ,
}
string ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
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: True ,
}
{
mapType:
{
Description: The map type. ,
Enum:
{
NotSpecified: No description available. ,
Xslt: No description available. ,
Xslt20: No description available. ,
Xslt30: No description available. ,
Liquid: No description available. ,
}
,
Required: True ,
}
enum ,
parametersSchema:
{
Description: The parameters schema of integration account map. ,
Required: False ,
}
{
ref:
{
Description: The reference name. ,
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 ,
}
string ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
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: True ,
}
{
mapType:
{
Description: The map type. ,
Enum:
{
NotSpecified: No description available. ,
Xslt: No description available. ,
Xslt20: No description available. ,
Xslt30: No description available. ,
Liquid: No description available. ,
}
,
Required: True ,
}
enum ,
parametersSchema:
{
Description: The parameters schema of integration account map. ,
Required: False ,
}
{
ref:
{
Description: The reference name. ,
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 ,
}
string ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountMaps_ListContentCallbackUrl (removed)
Description :  Get the content callback url.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/maps/{mapName}/listContentCallbackUrl
{
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 ,
listContentCallbackUrl:
{
Required: True ,
}
{
notAfter:
{
Description: The expiry time. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: The key type. ,
Enum:
{
NotSpecified: No description available. ,
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
value:
{
Description: Gets the workflow trigger callback URL. ,
Required: False ,
}
string ,
method:
{
Description: Gets the workflow trigger callback URL HTTP method. ,
Required: False ,
}
string ,
basePath:
{
Description: Gets the workflow trigger callback URL base path. ,
Required: False ,
}
string ,
relativePath:
{
Description: Gets the workflow trigger callback URL relative path. ,
Required: False ,
}
string ,
relativePathParameters:
{
Description: Gets the workflow trigger callback URL relative path parameters. ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: Gets the workflow trigger callback URL query parameters. ,
Required: False ,
}
{
api-version:
{
Description: The api version. ,
Required: False ,
}
string ,
sp:
{
Description: The SAS permissions. ,
Required: False ,
}
string ,
sv:
{
Description: The SAS version. ,
Required: False ,
}
string ,
sig:
{
Description: The SAS signature. ,
Required: False ,
}
string ,
se:
{
Description: The SAS timestamp. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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. Options for filters include: PartnerType. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration account partners. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account partner properties. ,
Required: True ,
}
{
partnerType:
{
Description: The partner type. ,
Enum:
{
NotSpecified: No description available. ,
B2B: No description available. ,
}
,
Required: True ,
}
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: True ,
}
{
b2b:
{
Description: The B2B partner content. ,
Required: False ,
}
{
businessIdentities:
{
Description: The list of partner business identities. ,
Required: False ,
}
[
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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: True ,
}
{
partnerType:
{
Description: The partner type. ,
Enum:
{
NotSpecified: No description available. ,
B2B: No description available. ,
}
,
Required: True ,
}
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: True ,
}
{
b2b:
{
Description: The B2B partner content. ,
Required: False ,
}
{
businessIdentities:
{
Description: The list of partner business identities. ,
Required: False ,
}
[
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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: True ,
}
{
partnerType:
{
Description: The partner type. ,
Enum:
{
NotSpecified: No description available. ,
B2B: No description available. ,
}
,
Required: True ,
}
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: True ,
}
{
b2b:
{
Description: The B2B partner content. ,
Required: False ,
}
{
businessIdentities:
{
Description: The list of partner business identities. ,
Required: False ,
}
[
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account partner properties. ,
Required: True ,
}
{
partnerType:
{
Description: The partner type. ,
Enum:
{
NotSpecified: No description available. ,
B2B: No description available. ,
}
,
Required: True ,
}
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: True ,
}
{
b2b:
{
Description: The B2B partner content. ,
Required: False ,
}
{
businessIdentities:
{
Description: The list of partner business identities. ,
Required: False ,
}
[
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration account partner properties. ,
Required: True ,
}
{
partnerType:
{
Description: The partner type. ,
Enum:
{
NotSpecified: No description available. ,
B2B: No description available. ,
}
,
Required: True ,
}
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: True ,
}
{
b2b:
{
Description: The B2B partner content. ,
Required: False ,
}
{
businessIdentities:
{
Description: The list of partner business identities. ,
Required: False ,
}
[
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountPartners_ListContentCallbackUrl (removed)
Description :  Get the content callback url.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/partners/{partnerName}/listContentCallbackUrl
{
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 ,
listContentCallbackUrl:
{
Required: True ,
}
{
notAfter:
{
Description: The expiry time. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: The key type. ,
Enum:
{
NotSpecified: No description available. ,
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
value:
{
Description: Gets the workflow trigger callback URL. ,
Required: False ,
}
string ,
method:
{
Description: Gets the workflow trigger callback URL HTTP method. ,
Required: False ,
}
string ,
basePath:
{
Description: Gets the workflow trigger callback URL base path. ,
Required: False ,
}
string ,
relativePath:
{
Description: Gets the workflow trigger callback URL relative path. ,
Required: False ,
}
string ,
relativePathParameters:
{
Description: Gets the workflow trigger callback URL relative path parameters. ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: Gets the workflow trigger callback URL query parameters. ,
Required: False ,
}
{
api-version:
{
Description: The api version. ,
Required: False ,
}
string ,
sp:
{
Description: The SAS permissions. ,
Required: False ,
}
string ,
sv:
{
Description: The SAS version. ,
Required: False ,
}
string ,
sig:
{
Description: The SAS signature. ,
Required: False ,
}
string ,
se:
{
Description: The SAS timestamp. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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. Options for filters include: AgreementType. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration account agreements. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account agreement properties. ,
Required: True ,
}
{
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: True ,
}
enum ,
hostPartner:
{
Description: The integration account partner that is set as host partner for this agreement. ,
Required: True ,
}
string ,
guestPartner:
{
Description: The integration account partner that is set as guest partner for this agreement. ,
Required: True ,
}
string ,
hostIdentity:
{
Description: The business identity of the host partner. ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
guestIdentity:
{
Description: The business identity of the guest partner. ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
content:
{
Description: The agreement content. ,
Required: True ,
}
{
aS2:
{
Description: The AS2 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The AS2 one-way receive agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: True ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: Indicates whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: Indicates whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: Indicates whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: Indicates whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: True ,
}
{
needMDN:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
boolean ,
signMDN:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: True ,
}
boolean ,
sendMDNAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMDNToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: True ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
MD5: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
enableNRRForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundMDN:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: True ,
}
boolean ,
enableNRRForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForInboundMDN:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: True ,
}
boolean ,
sha2AlgorithmFormat:
{
Description: The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. ,
Required: False ,
}
string ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: True ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: True ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: True ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: True ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: True ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: True ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: True ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: True ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: True ,
}
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: True ,
}
enum ,
signingAlgorithm:
{
Description: The signing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
Default: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: True ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: True ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: True ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: True ,
}
string ,
suspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: True ,
}
boolean ,
autogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: True ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: True ,
}
{
suspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: True ,
}
boolean ,
resendIfMDNNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
sendAgreement:
{
Description: The AS2 one-way send agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: True ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: Indicates whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: Indicates whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: Indicates whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: Indicates whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: True ,
}
{
needMDN:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
boolean ,
signMDN:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: True ,
}
boolean ,
sendMDNAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMDNToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: True ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
MD5: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
enableNRRForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundMDN:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: True ,
}
boolean ,
enableNRRForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForInboundMDN:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: True ,
}
boolean ,
sha2AlgorithmFormat:
{
Description: The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. ,
Required: False ,
}
string ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: True ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: True ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: True ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: True ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: True ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: True ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: True ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: True ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: True ,
}
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: True ,
}
enum ,
signingAlgorithm:
{
Description: The signing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
Default: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: True ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: True ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: True ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: True ,
}
string ,
suspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: True ,
}
boolean ,
autogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: True ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: True ,
}
{
suspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: True ,
}
boolean ,
resendIfMDNNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
}
,
x12:
{
Description: The X12 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The X12 one-way receive agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: True ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: True ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: True ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: True ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: True ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: True ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: True ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
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: True ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: True ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: True ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: True ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: True ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Required: True ,
}
string ,
headerVersion:
{
Description: The header version. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
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: True ,
}
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: True ,
}
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: True ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: True ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: True ,
}
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: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: True ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: True ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: True ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: True ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: True ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: True ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: True ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
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: True ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: True ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: True ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: True ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: True ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Required: True ,
}
string ,
headerVersion:
{
Description: The header version. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
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: True ,
}
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: True ,
}
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: True ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: True ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: True ,
}
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: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: True ,
}
{
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: True ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: True ,
}
{
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: True ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
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: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
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: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
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: True ,
}
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: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: True ,
}
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: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: True ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: True ,
}
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: True ,
}
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: True ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: True ,
}
{
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: True ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: True ,
}
{
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: True ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
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: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
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: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
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: True ,
}
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: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: True ,
}
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: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: True ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: True ,
}
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: True ,
}
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: True ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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: True ,
}
{
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: True ,
}
enum ,
hostPartner:
{
Description: The integration account partner that is set as host partner for this agreement. ,
Required: True ,
}
string ,
guestPartner:
{
Description: The integration account partner that is set as guest partner for this agreement. ,
Required: True ,
}
string ,
hostIdentity:
{
Description: The business identity of the host partner. ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
guestIdentity:
{
Description: The business identity of the guest partner. ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
content:
{
Description: The agreement content. ,
Required: True ,
}
{
aS2:
{
Description: The AS2 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The AS2 one-way receive agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: True ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: Indicates whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: Indicates whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: Indicates whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: Indicates whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: True ,
}
{
needMDN:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
boolean ,
signMDN:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: True ,
}
boolean ,
sendMDNAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMDNToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: True ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
MD5: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
enableNRRForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundMDN:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: True ,
}
boolean ,
enableNRRForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForInboundMDN:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: True ,
}
boolean ,
sha2AlgorithmFormat:
{
Description: The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. ,
Required: False ,
}
string ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: True ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: True ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: True ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: True ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: True ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: True ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: True ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: True ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: True ,
}
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: True ,
}
enum ,
signingAlgorithm:
{
Description: The signing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
Default: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: True ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: True ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: True ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: True ,
}
string ,
suspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: True ,
}
boolean ,
autogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: True ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: True ,
}
{
suspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: True ,
}
boolean ,
resendIfMDNNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
sendAgreement:
{
Description: The AS2 one-way send agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: True ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: Indicates whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: Indicates whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: Indicates whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: Indicates whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: True ,
}
{
needMDN:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
boolean ,
signMDN:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: True ,
}
boolean ,
sendMDNAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMDNToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: True ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
MD5: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
enableNRRForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundMDN:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: True ,
}
boolean ,
enableNRRForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForInboundMDN:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: True ,
}
boolean ,
sha2AlgorithmFormat:
{
Description: The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. ,
Required: False ,
}
string ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: True ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: True ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: True ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: True ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: True ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: True ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: True ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: True ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: True ,
}
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: True ,
}
enum ,
signingAlgorithm:
{
Description: The signing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
Default: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: True ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: True ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: True ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: True ,
}
string ,
suspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: True ,
}
boolean ,
autogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: True ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: True ,
}
{
suspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: True ,
}
boolean ,
resendIfMDNNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
}
,
x12:
{
Description: The X12 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The X12 one-way receive agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: True ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: True ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: True ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: True ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: True ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: True ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: True ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
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: True ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: True ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: True ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: True ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: True ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Required: True ,
}
string ,
headerVersion:
{
Description: The header version. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
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: True ,
}
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: True ,
}
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: True ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: True ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: True ,
}
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: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: True ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: True ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: True ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: True ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: True ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: True ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: True ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
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: True ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: True ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: True ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: True ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: True ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Required: True ,
}
string ,
headerVersion:
{
Description: The header version. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
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: True ,
}
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: True ,
}
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: True ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: True ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: True ,
}
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: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: True ,
}
{
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: True ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: True ,
}
{
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: True ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
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: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
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: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
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: True ,
}
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: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: True ,
}
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: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: True ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: True ,
}
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: True ,
}
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: True ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: True ,
}
{
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: True ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: True ,
}
{
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: True ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
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: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
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: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
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: True ,
}
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: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: True ,
}
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: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: True ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: True ,
}
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: True ,
}
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: True ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
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 (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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: True ,
}
{
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: True ,
}
enum ,
hostPartner:
{
Description: The integration account partner that is set as host partner for this agreement. ,
Required: True ,
}
string ,
guestPartner:
{
Description: The integration account partner that is set as guest partner for this agreement. ,
Required: True ,
}
string ,
hostIdentity:
{
Description: The business identity of the host partner. ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
guestIdentity:
{
Description: The business identity of the guest partner. ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
content:
{
Description: The agreement content. ,
Required: True ,
}
{
aS2:
{
Description: The AS2 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The AS2 one-way receive agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: True ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: Indicates whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: Indicates whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: Indicates whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: Indicates whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: True ,
}
{
needMDN:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
boolean ,
signMDN:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: True ,
}
boolean ,
sendMDNAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMDNToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: True ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
MD5: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
enableNRRForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundMDN:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: True ,
}
boolean ,
enableNRRForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForInboundMDN:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: True ,
}
boolean ,
sha2AlgorithmFormat:
{
Description: The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. ,
Required: False ,
}
string ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: True ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: True ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: True ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: True ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: True ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: True ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: True ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: True ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: True ,
}
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: True ,
}
enum ,
signingAlgorithm:
{
Description: The signing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
Default: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: True ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: True ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: True ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: True ,
}
string ,
suspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: True ,
}
boolean ,
autogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: True ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: True ,
}
{
suspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: True ,
}
boolean ,
resendIfMDNNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
sendAgreement:
{
Description: The AS2 one-way send agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: True ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: Indicates whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: Indicates whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: Indicates whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: Indicates whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: True ,
}
{
needMDN:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
boolean ,
signMDN:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: True ,
}
boolean ,
sendMDNAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMDNToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: True ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
MD5: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
enableNRRForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundMDN:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: True ,
}
boolean ,
enableNRRForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForInboundMDN:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: True ,
}
boolean ,
sha2AlgorithmFormat:
{
Description: The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. ,
Required: False ,
}
string ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: True ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: True ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: True ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: True ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: True ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: True ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: True ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: True ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: True ,
}
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: True ,
}
enum ,
signingAlgorithm:
{
Description: The signing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
Default: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: True ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: True ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: True ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: True ,
}
string ,
suspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: True ,
}
boolean ,
autogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: True ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: True ,
}
{
suspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: True ,
}
boolean ,
resendIfMDNNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
}
,
x12:
{
Description: The X12 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The X12 one-way receive agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: True ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: True ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: True ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: True ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: True ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: True ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: True ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
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: True ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: True ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: True ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: True ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: True ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Required: True ,
}
string ,
headerVersion:
{
Description: The header version. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
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: True ,
}
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: True ,
}
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: True ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: True ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: True ,
}
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: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: True ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: True ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: True ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: True ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: True ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: True ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: True ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
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: True ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: True ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: True ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: True ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: True ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Required: True ,
}
string ,
headerVersion:
{
Description: The header version. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
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: True ,
}
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: True ,
}
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: True ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: True ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: True ,
}
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: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: True ,
}
{
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: True ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: True ,
}
{
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: True ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
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: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
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: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
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: True ,
}
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: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: True ,
}
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: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: True ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: True ,
}
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: True ,
}
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: True ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: True ,
}
{
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: True ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: True ,
}
{
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: True ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
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: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
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: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
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: True ,
}
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: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: True ,
}
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: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: True ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: True ,
}
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: True ,
}
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: True ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
{
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: True ,
}
enum ,
hostPartner:
{
Description: The integration account partner that is set as host partner for this agreement. ,
Required: True ,
}
string ,
guestPartner:
{
Description: The integration account partner that is set as guest partner for this agreement. ,
Required: True ,
}
string ,
hostIdentity:
{
Description: The business identity of the host partner. ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
guestIdentity:
{
Description: The business identity of the guest partner. ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
content:
{
Description: The agreement content. ,
Required: True ,
}
{
aS2:
{
Description: The AS2 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The AS2 one-way receive agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: True ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: Indicates whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: Indicates whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: Indicates whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: Indicates whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: True ,
}
{
needMDN:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
boolean ,
signMDN:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: True ,
}
boolean ,
sendMDNAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMDNToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: True ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
MD5: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
enableNRRForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundMDN:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: True ,
}
boolean ,
enableNRRForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForInboundMDN:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: True ,
}
boolean ,
sha2AlgorithmFormat:
{
Description: The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. ,
Required: False ,
}
string ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: True ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: True ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: True ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: True ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: True ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: True ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: True ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: True ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: True ,
}
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: True ,
}
enum ,
signingAlgorithm:
{
Description: The signing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
Default: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: True ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: True ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: True ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: True ,
}
string ,
suspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: True ,
}
boolean ,
autogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: True ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: True ,
}
{
suspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: True ,
}
boolean ,
resendIfMDNNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
sendAgreement:
{
Description: The AS2 one-way send agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: True ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: Indicates whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: Indicates whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: Indicates whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: Indicates whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: True ,
}
{
needMDN:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
boolean ,
signMDN:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: True ,
}
boolean ,
sendMDNAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMDNToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: True ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
MD5: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
enableNRRForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundMDN:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: True ,
}
boolean ,
enableNRRForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForInboundMDN:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: True ,
}
boolean ,
sha2AlgorithmFormat:
{
Description: The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. ,
Required: False ,
}
string ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: True ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: True ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: True ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: True ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: True ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: True ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: True ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: True ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: True ,
}
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: True ,
}
enum ,
signingAlgorithm:
{
Description: The signing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
Default: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: True ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: True ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: True ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: True ,
}
string ,
suspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: True ,
}
boolean ,
autogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: True ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: True ,
}
{
suspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: True ,
}
boolean ,
resendIfMDNNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
}
,
x12:
{
Description: The X12 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The X12 one-way receive agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: True ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: True ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: True ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: True ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: True ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: True ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: True ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
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: True ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: True ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: True ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: True ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: True ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Required: True ,
}
string ,
headerVersion:
{
Description: The header version. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
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: True ,
}
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: True ,
}
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: True ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: True ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: True ,
}
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: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: True ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: True ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: True ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: True ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: True ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: True ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: True ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
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: True ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: True ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: True ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: True ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: True ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Required: True ,
}
string ,
headerVersion:
{
Description: The header version. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
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: True ,
}
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: True ,
}
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: True ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: True ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: True ,
}
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: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: True ,
}
{
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: True ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: True ,
}
{
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: True ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
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: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
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: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
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: True ,
}
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: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: True ,
}
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: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: True ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: True ,
}
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: True ,
}
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: True ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: True ,
}
{
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: True ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: True ,
}
{
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: True ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
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: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
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: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
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: True ,
}
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: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: True ,
}
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: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: True ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: True ,
}
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: True ,
}
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: True ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
{
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: True ,
}
enum ,
hostPartner:
{
Description: The integration account partner that is set as host partner for this agreement. ,
Required: True ,
}
string ,
guestPartner:
{
Description: The integration account partner that is set as guest partner for this agreement. ,
Required: True ,
}
string ,
hostIdentity:
{
Description: The business identity of the host partner. ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
guestIdentity:
{
Description: The business identity of the guest partner. ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
content:
{
Description: The agreement content. ,
Required: True ,
}
{
aS2:
{
Description: The AS2 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The AS2 one-way receive agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: True ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: Indicates whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: Indicates whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: Indicates whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: Indicates whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: True ,
}
{
needMDN:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
boolean ,
signMDN:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: True ,
}
boolean ,
sendMDNAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMDNToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: True ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
MD5: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
enableNRRForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundMDN:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: True ,
}
boolean ,
enableNRRForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForInboundMDN:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: True ,
}
boolean ,
sha2AlgorithmFormat:
{
Description: The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. ,
Required: False ,
}
string ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: True ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: True ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: True ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: True ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: True ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: True ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: True ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: True ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: True ,
}
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: True ,
}
enum ,
signingAlgorithm:
{
Description: The signing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
Default: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: True ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: True ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: True ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: True ,
}
string ,
suspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: True ,
}
boolean ,
autogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: True ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: True ,
}
{
suspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: True ,
}
boolean ,
resendIfMDNNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
sendAgreement:
{
Description: The AS2 one-way send agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The AS2 protocol settings. ,
Required: True ,
}
{
messageConnectionSettings:
{
Description: The message connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: The value indicating whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: The value indicating whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: The value indicating whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: The value indicating whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
acknowledgementConnectionSettings:
{
Description: The acknowledgement connection settings. ,
Required: True ,
}
{
ignoreCertificateNameMismatch:
{
Description: Indicates whether to ignore mismatch in certificate name. ,
Required: True ,
}
boolean ,
supportHttpStatusCodeContinue:
{
Description: Indicates whether to support HTTP status code 'CONTINUE'. ,
Required: True ,
}
boolean ,
keepHttpConnectionAlive:
{
Description: Indicates whether to keep the connection alive. ,
Required: True ,
}
boolean ,
unfoldHttpHeaders:
{
Description: Indicates whether to unfold the HTTP headers. ,
Required: True ,
}
boolean ,
}
,
mdnSettings:
{
Description: The MDN settings. ,
Required: True ,
}
{
needMDN:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
boolean ,
signMDN:
{
Description: The value indicating whether the MDN needs to be signed or not. ,
Required: True ,
}
boolean ,
sendMDNAsynchronously:
{
Description: The value indicating whether to send the asynchronous MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
mdnText:
{
Description: The MDN text. ,
Required: False ,
}
string ,
sendInboundMDNToMessageBox:
{
Description: The value indicating whether to send inbound MDN to message box. ,
Required: True ,
}
boolean ,
micHashingAlgorithm:
{
Description: The signing or hashing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
None: No description available. ,
MD5: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The security settings. ,
Required: True ,
}
{
overrideGroupSigningCertificate:
{
Description: The value indicating whether to send or request a MDN. ,
Required: True ,
}
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: True ,
}
boolean ,
enableNRRForInboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for inbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundMDN:
{
Description: The value indicating whether to enable NRR for outbound MDN. ,
Required: True ,
}
boolean ,
enableNRRForOutboundEncodedMessages:
{
Description: The value indicating whether to enable NRR for outbound encoded messages. ,
Required: True ,
}
boolean ,
enableNRRForOutboundDecodedMessages:
{
Description: The value indicating whether to enable NRR for outbound decoded messages. ,
Required: True ,
}
boolean ,
enableNRRForInboundMDN:
{
Description: The value indicating whether to enable NRR for inbound MDN. ,
Required: True ,
}
boolean ,
sha2AlgorithmFormat:
{
Description: The Sha2 algorithm format. Valid values are Sha2, ShaHashSize, ShaHyphenHashSize, Sha2UnderscoreHashSize. ,
Required: False ,
}
string ,
}
,
validationSettings:
{
Description: The validation settings. ,
Required: True ,
}
{
overrideMessageProperties:
{
Description: The value indicating whether to override incoming message properties with those in agreement. ,
Required: True ,
}
boolean ,
encryptMessage:
{
Description: The value indicating whether the message has to be encrypted. ,
Required: True ,
}
boolean ,
signMessage:
{
Description: The value indicating whether the message has to be signed. ,
Required: True ,
}
boolean ,
compressMessage:
{
Description: The value indicating whether the message has to be compressed. ,
Required: True ,
}
boolean ,
checkDuplicateMessage:
{
Description: The value indicating whether to check for duplicate message. ,
Required: True ,
}
boolean ,
interchangeDuplicatesValidityDays:
{
Description: The number of days to look back for duplicate interchange. ,
Format: int32 ,
Required: True ,
}
integer ,
checkCertificateRevocationListOnSend:
{
Description: The value indicating whether to check for certificate revocation list on send. ,
Required: True ,
}
boolean ,
checkCertificateRevocationListOnReceive:
{
Description: The value indicating whether to check for certificate revocation list on receive. ,
Required: True ,
}
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: True ,
}
enum ,
signingAlgorithm:
{
Description: The signing algorithm. ,
Enum:
{
NotSpecified: No description available. ,
Default: No description available. ,
SHA1: No description available. ,
SHA2256: No description available. ,
SHA2384: No description available. ,
SHA2512: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
envelopeSettings:
{
Description: The envelope settings. ,
Required: True ,
}
{
messageContentType:
{
Description: The message content type. ,
Required: True ,
}
string ,
transmitFileNameInMimeHeader:
{
Description: The value indicating whether to transmit file name in mime header. ,
Required: True ,
}
boolean ,
fileNameTemplate:
{
Description: The template for file name. ,
Required: True ,
}
string ,
suspendMessageOnFileNameGenerationError:
{
Description: The value indicating whether to suspend message on file name generation error. ,
Required: True ,
}
boolean ,
autogenerateFileName:
{
Description: The value indicating whether to auto generate file name. ,
Required: True ,
}
boolean ,
}
,
errorSettings:
{
Description: The error settings. ,
Required: True ,
}
{
suspendDuplicateMessage:
{
Description: The value indicating whether to suspend duplicate message. ,
Required: True ,
}
boolean ,
resendIfMDNNotReceived:
{
Description: The value indicating whether to resend message If MDN is not received. ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
}
,
x12:
{
Description: The X12 agreement content. ,
Required: False ,
}
{
receiveAgreement:
{
Description: The X12 one-way receive agreement. ,
Required: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: True ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: True ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: True ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: True ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: True ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: True ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: True ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
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: True ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: True ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: True ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: True ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: True ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Required: True ,
}
string ,
headerVersion:
{
Description: The header version. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
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: True ,
}
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: True ,
}
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: True ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: True ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: True ,
}
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: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The X12 protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The X12 validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The X12 framing settings. ,
Required: True ,
}
{
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
boolean ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The X12 envelope settings. ,
Required: True ,
}
{
controlStandardsId:
{
Description: The controls standards id. ,
Format: int32 ,
Required: True ,
}
integer ,
useControlStandardsIdAsRepetitionCharacter:
{
Description: The value indicating whether to use control standards id as repetition character. ,
Required: True ,
}
boolean ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
string ,
controlVersionNumber:
{
Description: The control version number. ,
Required: True ,
}
string ,
interchangeControlNumberLowerBound:
{
Description: The interchange control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
boolean ,
functionalGroupId:
{
Description: The functional group id. ,
Required: False ,
}
string ,
groupControlNumberLowerBound:
{
Description: The group control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
boolean ,
groupHeaderAgencyCode:
{
Description: The group header agency code. ,
Required: True ,
}
string ,
groupHeaderVersion:
{
Description: The group header version. ,
Required: True ,
}
string ,
transactionSetControlNumberLowerBound:
{
Description: The transaction set control number lower bound. ,
Format: int32 ,
Required: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
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: True ,
}
boolean ,
groupHeaderDateFormat:
{
Description: The group header date format. ,
Enum:
{
NotSpecified: No description available. ,
CCYYMMDD: No description available. ,
YYMMDD: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
usageIndicator:
{
Description: The usage indicator. ,
Enum:
{
NotSpecified: No description available. ,
Test: No description available. ,
Information: No description available. ,
Production: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
acknowledgementSettings:
{
Description: The X12 acknowledgment settings. ,
Required: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
functionalAcknowledgementVersion:
{
Description: The functional acknowledgement version. ,
Required: False ,
}
string ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needImplementationAcknowledgement:
{
Description: The value indicating whether implementation acknowledgement is needed. ,
Required: True ,
}
boolean ,
implementationAcknowledgementVersion:
{
Description: The implementation acknowledgement version. ,
Required: False ,
}
string ,
batchImplementationAcknowledgements:
{
Description: The value indicating whether to batch implementation acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The X12 message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
securitySettings:
{
Description: The X12 security settings. ,
Required: True ,
}
{
authorizationQualifier:
{
Description: The authorization qualifier. ,
Required: True ,
}
string ,
authorizationValue:
{
Description: The authorization value. ,
Required: False ,
}
string ,
securityQualifier:
{
Description: The security qualifier. ,
Required: True ,
}
string ,
passwordValue:
{
Description: The password value. ,
Required: False ,
}
string ,
}
,
processingSettings:
{
Description: The X12 processing settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
convertImpliedDecimal:
{
Description: The value indicating whether to convert numerical type to implied decimal. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
protocolVersion:
{
Description: The protocol version on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
messageId:
{
Description: The message id on which this envelope settings has to be applied. ,
Required: True ,
}
string ,
responsibleAgencyCode:
{
Description: The responsible agency code. ,
Required: True ,
}
string ,
headerVersion:
{
Description: The header version. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: True ,
}
string ,
receiverApplicationId:
{
Description: The receiver application id. ,
Required: True ,
}
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: True ,
}
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: True ,
}
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: True ,
}
string ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
validateCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
]
,
messageFilterList:
{
Description: The X12 message filter list. ,
Required: False ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The X12 schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
senderApplicationId:
{
Description: The sender application id. ,
Required: False ,
}
string ,
schemaVersion:
{
Description: The schema version. ,
Required: True ,
}
string ,
schemaName:
{
Description: The schema name. ,
Required: True ,
}
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: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
replaceCharacter:
{
Description: The replacement character. ,
Format: int32 ,
Required: True ,
}
integer ,
replaceSeparatorsInPayload:
{
Description: The value indicating whether to replace separators in payload. ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: True ,
}
{
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: True ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: True ,
}
{
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: True ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
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: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
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: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
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: True ,
}
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: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: True ,
}
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: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: True ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: True ,
}
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: True ,
}
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: True ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
{
senderBusinessIdentity:
{
Description: The sender business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
receiverBusinessIdentity:
{
Description: The receiver business identity ,
Required: True ,
}
{
qualifier:
{
Description: The business identity qualifier e.g. as2identity, ZZ, ZZZ, 31, 32 ,
Required: True ,
}
string ,
value:
{
Description: The user defined business identity value. ,
Required: True ,
}
string ,
}
,
protocolSettings:
{
Description: The EDIFACT protocol settings. ,
Required: True ,
}
{
validationSettings:
{
Description: The EDIFACT validation settings. ,
Required: True ,
}
{
validateCharacterSet:
{
Description: The value indicating whether to validate character set in the message. ,
Required: True ,
}
boolean ,
checkDuplicateInterchangeControlNumber:
{
Description: The value indicating whether to check for duplicate interchange control number. ,
Required: True ,
}
boolean ,
interchangeControlNumberValidityDays:
{
Description: The validity period of interchange control number. ,
Format: int32 ,
Required: True ,
}
integer ,
checkDuplicateGroupControlNumber:
{
Description: The value indicating whether to check for duplicate group control number. ,
Required: True ,
}
boolean ,
checkDuplicateTransactionSetControlNumber:
{
Description: The value indicating whether to check for duplicate transaction set control number. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to Whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to Whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
boolean ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
}
,
framingSettings:
{
Description: The EDIFACT framing settings. ,
Required: True ,
}
{
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: True ,
}
integer ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The EDIFACT frame setting decimal indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
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: True ,
}
enum ,
}
,
envelopeSettings:
{
Description: The EDIFACT envelope settings. ,
Required: True ,
}
{
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: True ,
}
boolean ,
createGroupingSegments:
{
Description: The value indicating whether to create grouping segments. ,
Required: True ,
}
boolean ,
enableDefaultGroupHeaders:
{
Description: The value indicating whether to enable default group headers. ,
Required: True ,
}
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: True ,
}
integer ,
interchangeControlNumberUpperBound:
{
Description: The interchange control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverInterchangeControlNumber:
{
Description: The value indicating whether to rollover interchange control number. ,
Required: True ,
}
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: True ,
}
integer ,
groupControlNumberUpperBound:
{
Description: The group control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverGroupControlNumber:
{
Description: The value indicating whether to rollover group control number. ,
Required: True ,
}
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: True ,
}
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: True ,
}
integer ,
transactionSetControlNumberUpperBound:
{
Description: The transaction set control number upper bound. ,
Format: int64 ,
Required: True ,
}
integer ,
rolloverTransactionSetControlNumber:
{
Description: The value indicating whether to rollover transaction set control number. ,
Required: True ,
}
boolean ,
isTestInterchange:
{
Description: The value indicating whether the message is a test interchange. ,
Required: True ,
}
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: True ,
}
{
needTechnicalAcknowledgement:
{
Description: The value indicating whether technical acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchTechnicalAcknowledgements:
{
Description: The value indicating whether to batch the technical acknowledgements. ,
Required: True ,
}
boolean ,
needFunctionalAcknowledgement:
{
Description: The value indicating whether functional acknowledgement is needed. ,
Required: True ,
}
boolean ,
batchFunctionalAcknowledgements:
{
Description: The value indicating whether to batch functional acknowledgements. ,
Required: True ,
}
boolean ,
needLoopForValidMessages:
{
Description: The value indicating whether a loop is needed for valid messages. ,
Required: True ,
}
boolean ,
sendSynchronousAcknowledgement:
{
Description: The value indicating whether to send synchronous acknowledgement. ,
Required: True ,
}
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: True ,
}
integer ,
acknowledgementControlNumberUpperBound:
{
Description: The acknowledgement control number upper bound. ,
Format: int32 ,
Required: True ,
}
integer ,
rolloverAcknowledgementControlNumber:
{
Description: The value indicating whether to rollover acknowledgement control number. ,
Required: True ,
}
boolean ,
}
,
messageFilter:
{
Description: The EDIFACT message filter. ,
Required: True ,
}
{
messageFilterType:
{
Description: The message filter type. ,
Enum:
{
NotSpecified: No description available. ,
Include: No description available. ,
Exclude: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
processingSettings:
{
Description: The EDIFACT processing Settings. ,
Required: True ,
}
{
maskSecurityInfo:
{
Description: The value indicating whether to mask security information. ,
Required: True ,
}
boolean ,
preserveInterchange:
{
Description: The value indicating whether to preserve interchange. ,
Required: True ,
}
boolean ,
suspendInterchangeOnError:
{
Description: The value indicating whether to suspend interchange on error. ,
Required: True ,
}
boolean ,
createEmptyXmlTagsForTrailingSeparators:
{
Description: The value indicating whether to create empty xml tags for trailing separators. ,
Required: True ,
}
boolean ,
useDotAsDecimalSeparator:
{
Description: The value indicating whether to use dot as decimal separator. ,
Required: True ,
}
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: True ,
}
string ,
}
,
]
,
schemaReferences:
{
Description: The EDIFACT schema references. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
messageVersion:
{
Description: The message version. ,
Required: True ,
}
string ,
messageRelease:
{
Description: The message release version. ,
Required: True ,
}
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: True ,
}
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: True ,
}
string ,
enforceCharacterSet:
{
Description: The value indicating whether to validate character Set. ,
Required: True ,
}
boolean ,
validateEDITypes:
{
Description: The value indicating whether to validate EDI types. ,
Required: True ,
}
boolean ,
validateXSDTypes:
{
Description: The value indicating whether to validate XSD types. ,
Required: True ,
}
boolean ,
allowLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to allow leading and trailing spaces and zeroes. ,
Required: True ,
}
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: True ,
}
enum ,
trimLeadingAndTrailingSpacesAndZeroes:
{
Description: The value indicating whether to trim leading and trailing spaces and zeroes. ,
Required: True ,
}
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. ,
Required: False ,
}
string ,
dataElementSeparator:
{
Description: The data element separator. ,
Format: int32 ,
Required: True ,
}
integer ,
componentSeparator:
{
Description: The component separator. ,
Format: int32 ,
Required: True ,
}
integer ,
segmentTerminator:
{
Description: The segment terminator. ,
Format: int32 ,
Required: True ,
}
integer ,
repetitionSeparator:
{
Description: The repetition separator. ,
Format: int32 ,
Required: True ,
}
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: True ,
}
enum ,
decimalPointIndicator:
{
Description: The decimal point indicator. ,
Enum:
{
NotSpecified: No description available. ,
Comma: No description available. ,
Decimal: No description available. ,
}
,
Required: True ,
}
enum ,
releaseIndicator:
{
Description: The release indicator. ,
Format: int32 ,
Required: True ,
}
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 (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountAgreements_ListContentCallbackUrl (removed)
Description :  Get the content callback url.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/agreements/{agreementName}/listContentCallbackUrl
{
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 ,
listContentCallbackUrl:
{
Required: True ,
}
{
notAfter:
{
Description: The expiry time. ,
Format: date-time ,
Required: False ,
}
string ,
keyType:
{
Description: The key type. ,
Enum:
{
NotSpecified: No description available. ,
Primary: No description available. ,
Secondary: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
value:
{
Description: Gets the workflow trigger callback URL. ,
Required: False ,
}
string ,
method:
{
Description: Gets the workflow trigger callback URL HTTP method. ,
Required: False ,
}
string ,
basePath:
{
Description: Gets the workflow trigger callback URL base path. ,
Required: False ,
}
string ,
relativePath:
{
Description: Gets the workflow trigger callback URL relative path. ,
Required: False ,
}
string ,
relativePathParameters:
{
Description: Gets the workflow trigger callback URL relative path parameters. ,
Required: False ,
}
[
string ,
]
,
queries:
{
Description: Gets the workflow trigger callback URL query parameters. ,
Required: False ,
}
{
api-version:
{
Description: The api version. ,
Required: False ,
}
string ,
sp:
{
Description: The SAS permissions. ,
Required: False ,
}
string ,
sv:
{
Description: The SAS version. ,
Required: False ,
}
string ,
sig:
{
Description: The SAS signature. ,
Required: False ,
}
string ,
se:
{
Description: The SAS timestamp. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
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: True ,
}
{
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: True ,
}
{
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: True ,
}
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 ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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: True ,
}
{
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: True ,
}
{
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: True ,
}
string ,
keyVersion:
{
Description: The private key version in key vault. ,
Required: False ,
}
string ,
}
,
publicCertificate:
{
Description: The public certificate. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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: True ,
}
{
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: True ,
}
{
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: True ,
}
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: True ,
}
{
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: True ,
}
{
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: True ,
}
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: True ,
}
{
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: True ,
}
{
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: True ,
}
string ,
keyVersion:
{
Description: The private key version in key vault. ,
Required: False ,
}
string ,
}
,
publicCertificate:
{
Description: The public certificate. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
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)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountSessions_List (removed)
Description :  Gets a list of integration account sessions.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/sessions
{
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. Options for filters include: ChangedTime. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration account sessions. ,
Required: False ,
}
[
{
properties:
{
Description: The integration account session properties. ,
Required: True ,
}
{
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 session content. ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountSessions_Get (removed)
Description :  Gets an integration account session.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/sessions/{sessionName}
{
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 ,
sessionName:
{
Description: The integration account session name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The integration account session properties. ,
Required: True ,
}
{
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 session content. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountSessions_CreateOrUpdate (removed)
Description :  Creates or updates an integration account session.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/sessions/{sessionName}
{
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 ,
sessionName:
{
Description: The integration account session name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
session:
{
Description: The integration account session. ,
Required: True ,
}
{
properties:
{
Description: The integration account session properties. ,
Required: True ,
}
{
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 session content. ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration account session properties. ,
Required: True ,
}
{
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 session content. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration account session properties. ,
Required: True ,
}
{
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 session content. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationAccountSessions_Delete (removed)
Description :  Deletes an integration account session.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/integrationAccounts/{integrationAccountName}/sessions/{sessionName}
{
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 ,
sessionName:
{
Description: The integration account session name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironments_ListBySubscription (removed)
Description :  Gets a list of integration service environments by subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Logic/integrationServiceEnvironments
{
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:
{
Required: False ,
}
[
{
properties:
{
Description: The integration service environment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The integration service environment state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
integrationServiceEnvironmentId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
networkConfiguration:
{
Description: The network configuration. ,
Required: False ,
}
{
virtualNetworkAddressSpace:
{
Description: Gets the virtual network address space. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: The access endpoint. ,
Required: False ,
}
{
type:
{
Description: The access endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
External: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subnets:
{
Description: The subnets. ,
Required: False ,
}
[
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
encryptionConfiguration:
{
Description: The encryption configuration. ,
Required: False ,
}
{
encryptionKeyReference:
{
Description: The encryption key reference. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: Gets the key name in the Key Vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Gets the version of the key specified in the keyName property. ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Premium: No description available. ,
Developer: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironments_ListByResourceGroup (removed)
Description :  Gets a list of integration service environments by resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
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:
{
Required: False ,
}
[
{
properties:
{
Description: The integration service environment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The integration service environment state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
integrationServiceEnvironmentId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
networkConfiguration:
{
Description: The network configuration. ,
Required: False ,
}
{
virtualNetworkAddressSpace:
{
Description: Gets the virtual network address space. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: The access endpoint. ,
Required: False ,
}
{
type:
{
Description: The access endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
External: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subnets:
{
Description: The subnets. ,
Required: False ,
}
[
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
encryptionConfiguration:
{
Description: The encryption configuration. ,
Required: False ,
}
{
encryptionKeyReference:
{
Description: The encryption key reference. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: Gets the key name in the Key Vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Gets the version of the key specified in the keyName property. ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Premium: No description available. ,
Developer: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironments_Get (removed)
Description :  Gets an integration service environment.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The integration service environment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The integration service environment state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
integrationServiceEnvironmentId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
networkConfiguration:
{
Description: The network configuration. ,
Required: False ,
}
{
virtualNetworkAddressSpace:
{
Description: Gets the virtual network address space. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: The access endpoint. ,
Required: False ,
}
{
type:
{
Description: The access endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
External: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subnets:
{
Description: The subnets. ,
Required: False ,
}
[
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
encryptionConfiguration:
{
Description: The encryption configuration. ,
Required: False ,
}
{
encryptionKeyReference:
{
Description: The encryption key reference. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: Gets the key name in the Key Vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Gets the version of the key specified in the keyName property. ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Premium: No description available. ,
Developer: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironments_CreateOrUpdate (removed)
Description :  Creates or updates an integration service environment.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: True ,
}
{
properties:
{
Description: The integration service environment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The integration service environment state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
integrationServiceEnvironmentId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
networkConfiguration:
{
Description: The network configuration. ,
Required: False ,
}
{
virtualNetworkAddressSpace:
{
Description: Gets the virtual network address space. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: The access endpoint. ,
Required: False ,
}
{
type:
{
Description: The access endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
External: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subnets:
{
Description: The subnets. ,
Required: False ,
}
[
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
encryptionConfiguration:
{
Description: The encryption configuration. ,
Required: False ,
}
{
encryptionKeyReference:
{
Description: The encryption key reference. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: Gets the key name in the Key Vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Gets the version of the key specified in the keyName property. ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Premium: No description available. ,
Developer: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration service environment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The integration service environment state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
integrationServiceEnvironmentId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
networkConfiguration:
{
Description: The network configuration. ,
Required: False ,
}
{
virtualNetworkAddressSpace:
{
Description: Gets the virtual network address space. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: The access endpoint. ,
Required: False ,
}
{
type:
{
Description: The access endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
External: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subnets:
{
Description: The subnets. ,
Required: False ,
}
[
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
encryptionConfiguration:
{
Description: The encryption configuration. ,
Required: False ,
}
{
encryptionKeyReference:
{
Description: The encryption key reference. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: Gets the key name in the Key Vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Gets the version of the key specified in the keyName property. ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Premium: No description available. ,
Developer: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration service environment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The integration service environment state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
integrationServiceEnvironmentId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
networkConfiguration:
{
Description: The network configuration. ,
Required: False ,
}
{
virtualNetworkAddressSpace:
{
Description: Gets the virtual network address space. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: The access endpoint. ,
Required: False ,
}
{
type:
{
Description: The access endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
External: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subnets:
{
Description: The subnets. ,
Required: False ,
}
[
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
encryptionConfiguration:
{
Description: The encryption configuration. ,
Required: False ,
}
{
encryptionKeyReference:
{
Description: The encryption key reference. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: Gets the key name in the Key Vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Gets the version of the key specified in the keyName property. ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Premium: No description available. ,
Developer: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironments_Update (removed)
Description :  Updates an integration service environment.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
integrationServiceEnvironment:
{
Description: The integration service environment. ,
Required: True ,
}
{
properties:
{
Description: The integration service environment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The integration service environment state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
integrationServiceEnvironmentId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
networkConfiguration:
{
Description: The network configuration. ,
Required: False ,
}
{
virtualNetworkAddressSpace:
{
Description: Gets the virtual network address space. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: The access endpoint. ,
Required: False ,
}
{
type:
{
Description: The access endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
External: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subnets:
{
Description: The subnets. ,
Required: False ,
}
[
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
encryptionConfiguration:
{
Description: The encryption configuration. ,
Required: False ,
}
{
encryptionKeyReference:
{
Description: The encryption key reference. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: Gets the key name in the Key Vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Gets the version of the key specified in the keyName property. ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Premium: No description available. ,
Developer: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration service environment properties. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: No description available. ,
Ready: No description available. ,
Creating: No description available. ,
Created: No description available. ,
Deleting: No description available. ,
Deleted: No description available. ,
Canceled: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Moving: No description available. ,
Updating: No description available. ,
Registering: No description available. ,
Registered: No description available. ,
Unregistering: No description available. ,
Unregistered: No description available. ,
Completed: No description available. ,
Renewing: No description available. ,
Pending: No description available. ,
Waiting: No description available. ,
InProgress: No description available. ,
}
,
Required: False ,
}
enum ,
state:
{
Description: The integration service environment state. ,
Enum:
{
NotSpecified: No description available. ,
Completed: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
Suspended: No description available. ,
}
,
Required: False ,
}
enum ,
integrationServiceEnvironmentId:
{
Description: Gets the tracking id. ,
Required: False ,
}
string ,
endpointsConfiguration:
{
Description: The endpoints configuration. ,
Required: False ,
}
{
workflow:
{
Description: The workflow endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
connector:
{
Description: The connector endpoints. ,
Required: False ,
}
{
outgoingIpAddresses:
{
Description: The outgoing ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
accessEndpointIpAddresses:
{
Description: The access endpoint ip address. ,
Required: False ,
}
[
{
address:
{
Description: The address. ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
networkConfiguration:
{
Description: The network configuration. ,
Required: False ,
}
{
virtualNetworkAddressSpace:
{
Description: Gets the virtual network address space. ,
Required: False ,
}
string ,
accessEndpoint:
{
Description: The access endpoint. ,
Required: False ,
}
{
type:
{
Description: The access endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
External: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
subnets:
{
Description: The subnets. ,
Required: False ,
}
[
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
]
,
}
,
encryptionConfiguration:
{
Description: The encryption configuration. ,
Required: False ,
}
{
encryptionKeyReference:
{
Description: The encryption key reference. ,
Required: False ,
}
{
keyVault:
{
Description: The key vault reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
keyName:
{
Description: Gets the key name in the Key Vault. ,
Required: False ,
}
string ,
keyVersion:
{
Description: Gets the version of the key specified in the keyName property. ,
Required: False ,
}
string ,
}
,
}
,
}
,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Premium: No description available. ,
Developer: No description available. ,
}
,
Required: False ,
}
enum ,
capacity:
{
Description: The sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
identity:
{
Description: Managed service identity properties. ,
Required: False ,
}
{
type:
{
Description: Type of managed service identity. The type 'SystemAssigned' includes an implicitly created identity. The type 'None' will remove any identities from the resource. ,
Enum:
{
SystemAssigned: No description available. ,
UserAssigned: No description available. ,
None: No description available. ,
}
,
Required: True ,
}
enum ,
tenantId:
{
Description: Tenant of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
principalId:
{
Description: Principal Id of managed service identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironments_Delete (removed)
Description :  Deletes an integration service environment.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironmentSkus_List (removed)
Description :  Gets a list of integration service environment Skus.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/skus
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of integration service environment skus. ,
Required: False ,
}
[
{
resourceType:
{
Description: The resource type. ,
Required: False ,
}
string ,
sku:
{
Description: The sku. ,
Required: False ,
}
{
name:
{
Description: The sku name. ,
Enum:
{
NotSpecified: No description available. ,
Premium: No description available. ,
Developer: No description available. ,
}
,
Required: False ,
}
enum ,
tier:
{
Description: The sku tier. ,
Required: False ,
}
string ,
}
,
capacity:
{
Description: The sku capacity. ,
Required: False ,
}
{
minimum:
{
Description: The minimum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: The maximum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
default:
{
Description: The default capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
scaleType:
{
Description: The sku scale type. ,
Enum:
{
Manual: No description available. ,
Automatic: No description available. ,
None: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironments_Restart (removed)
Description :  Restarts an integration service environment.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/restart
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironmentNetworkHealth_Get (removed)
Description :  Gets the integration service environment network health.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/health/network
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: The integration service environment network health of all the subnets. ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironmentManagedApis_List (removed)
Description :  Gets the integration service environment managed Apis.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/managedApis
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The integration service environment managed APIs. ,
Required: False ,
}
[
{
properties:
{
Description: The integration service environment managed api properties. ,
Required: False ,
}
{
deploymentParameters:
{
Description: The integration service environment managed api deployment parameters. ,
Required: False ,
}
{
contentLinkDefinition:
{
Description: The integration service environment managed api content link for deployment. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironmentManagedApis_Get (removed)
Description :  Gets the integration service environment managed Api.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/managedApis/{apiName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
apiName:
{
Description: The api name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The integration service environment managed api properties. ,
Required: False ,
}
{
deploymentParameters:
{
Description: The integration service environment managed api deployment parameters. ,
Required: False ,
}
{
contentLinkDefinition:
{
Description: The integration service environment managed api content link for deployment. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironmentManagedApis_Put (removed)
Description :  Puts the integration service environment managed Api.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/managedApis/{apiName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group name. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
apiName:
{
Description: The api name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
integrationServiceEnvironmentManagedApi:
{
Description: The integration service environment managed api. ,
Required: True ,
}
{
properties:
{
Description: The integration service environment managed api properties. ,
Required: False ,
}
{
deploymentParameters:
{
Description: The integration service environment managed api deployment parameters. ,
Required: False ,
}
{
contentLinkDefinition:
{
Description: The integration service environment managed api content link for deployment. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The integration service environment managed api properties. ,
Required: False ,
}
{
deploymentParameters:
{
Description: The integration service environment managed api deployment parameters. ,
Required: False ,
}
{
contentLinkDefinition:
{
Description: The integration service environment managed api content link for deployment. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The integration service environment managed api properties. ,
Required: False ,
}
{
deploymentParameters:
{
Description: The integration service environment managed api deployment parameters. ,
Required: False ,
}
{
contentLinkDefinition:
{
Description: The integration service environment managed api content link for deployment. ,
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 algorithm of the content hash. ,
Required: False ,
}
string ,
value:
{
Description: The value of the content hash. ,
Required: False ,
}
string ,
}
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironmentManagedApis_Delete (removed)
Description :  Deletes the integration service environment managed Api.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/managedApis/{apiName}
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
apiName:
{
Description: The api name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
IntegrationServiceEnvironmentManagedApiOperations_List (removed)
Description :  Gets the managed Api operations.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Logic/integrationServiceEnvironments/{integrationServiceEnvironmentName}/managedApis/{apiName}/apiOperations
{
subscriptionId:
{
Description: The subscription id. ,
Required: True ,
}
string ,
resourceGroup:
{
Description: The resource group. ,
Required: True ,
}
string ,
integrationServiceEnvironmentName:
{
Description: The integration service environment name. ,
Required: True ,
}
string ,
apiName:
{
Description: The api name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The api operation definitions for an API. ,
Required: False ,
}
[
{
properties:
{
Description: The api operations properties ,
Required: False ,
}
{
summary:
{
Description: The summary of the api operation. ,
Required: False ,
}
string ,
description:
{
Description: The description of the api operation. ,
Required: False ,
}
string ,
visibility:
{
Description: The visibility of the api operation. ,
Required: False ,
}
string ,
trigger:
{
Description: The trigger type of api operation. ,
Required: False ,
}
string ,
triggerHint:
{
Description: The trigger hint for the api operation. ,
Required: False ,
}
string ,
pageable:
{
Description: Indicates whether the api operation is pageable. ,
Required: False ,
}
boolean ,
annotation:
{
Description: The annotation of api operation. ,
Required: False ,
}
{
status:
{
Description: The status annotation. ,
Enum:
{
NotSpecified: No description available. ,
Preview: No description available. ,
Production: No description available. ,
}
,
Required: False ,
}
enum ,
family:
{
Description: The family. ,
Required: False ,
}
string ,
revision:
{
Description: The revision. ,
Required: False ,
}
integer ,
}
,
api:
{
Description: The api reference. ,
Required: False ,
}
{
displayName:
{
Description: The display name of the api. ,
Required: False ,
}
string ,
description:
{
Description: The description of the api. ,
Required: False ,
}
string ,
iconUri:
{
Description: The icon uri of the api. ,
Required: False ,
}
string ,
swagger:
{
Description: The swagger of the api. ,
Required: False ,
}
object ,
brandColor:
{
Description: The brand color of the api. ,
Required: False ,
}
string ,
category:
{
Description: The tier. ,
Enum:
{
NotSpecified: No description available. ,
Enterprise: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: False ,
}
enum ,
integrationServiceEnvironment:
{
Description: The integration service environment reference. ,
Required: False ,
}
{
id:
{
Description: The resource id. ,
Required: False ,
}
string ,
name:
{
Description: Gets the resource name. ,
Required: False ,
}
string ,
type:
{
Description: Gets the resource type. ,
Required: False ,
}
string ,
}
,
}
,
inputsDefinition:
{
Description: The operation inputs definition schema. ,
Required: False ,
}
{
ref:
{
Description: The reference. ,
Required: False ,
}
string ,
type:
{
Description: The type ,
Enum:
{
String: No description available. ,
Number: No description available. ,
Integer: No description available. ,
Boolean: No description available. ,
Array: No description available. ,
File: No description available. ,
Object: No description available. ,
Null: No description available. ,
}
,
Required: False ,
}
enum ,
title:
{
Description: The title. ,
Required: False ,
}
string ,
items:
{
Required: False ,
}
string ,
properties:
{
Description: The object properties ,
Required: False ,
}
object ,
additionalProperties:
{
Description: The additional properties. ,
Required: False ,
}
object ,
required:
{
Description: The object required properties. ,
Required: False ,
}
[
string ,
]
,
maxProperties:
{
Description: The maximum number of allowed properties. ,
Required: False ,
}
integer ,
minProperties:
{
Description: The minimum number of allowed properties. ,
Required: False ,
}
integer ,
allOf:
{
Description: The schemas which must pass validation when this schema is used. ,
Required: False ,
}
[
string ,
]
,
discriminator:
{
Description: The discriminator. ,
Required: False ,
}
string ,
readOnly:
{
Description: Indicates whether this property must be present in the a request. ,
Required: False ,
}
boolean ,
xml:
{
Description: The xml representation format for a property. ,
Required: False ,
}
{
name:
{
Description: The xml element or attribute name. ,
Required: False ,
}
string ,
namespace:
{
Description: The xml namespace. ,
Required: False ,
}
string ,
prefix:
{
Description: The name prefix. ,
Required: False ,
}
string ,
attribute:
{
Description: Indicates whether the property should be an attribute instead of an element. ,
Required: False ,
}
boolean ,
wrapped:
{
Description: Indicates whether the array elements are wrapped in a container element. ,
Required: False ,
}
boolean ,
extensions:
{
Description: The vendor extensions. ,
Required: False ,
}
object ,
}
,
externalDocs:
{
Description: The external documentation. ,
Required: False ,
}
{
description:
{
Description: The document description. ,
Required: False ,
}
string ,
uri:
{
Description: The documentation Uri. ,
Required: False ,
}
string ,
extensions:
{
Description: The vendor extensions. ,
Required: False ,
}
object ,
}
,
example:
{
Description: The example value. ,
Required: False ,
}
object ,
notificationUrlExtension:
{
Description: Indicates the notification url extension. If this is set, the property's value should be a callback url for a webhook. ,
Required: False ,
}
boolean ,
dynamicSchemaOld:
{
Description: The dynamic schema configuration. ,
Required: False ,
}
{
operationId:
{
Description: The operation id to fetch dynamic schema. ,
Required: False ,
}
string ,
valuePath:
{
Description: Json pointer to the dynamic schema on the response body. ,
Required: False ,
}
string ,
parameters:
{
Description: The operation parameters. ,
Required: False ,
}
object ,
}
,
dynamicSchemaNew:
{
Description: The dynamic schema configuration. ,
Required: False ,
}
{
operationId:
{
Description: The operation id to fetch dynamic schema. ,
Required: False ,
}
string ,
valuePath:
{
Description: Json pointer to the dynamic schema on the response body. ,
Required: False ,
}
string ,
parameters:
{
Description: The operation parameters. ,
Required: False ,
}
object ,
}
,
dynamicListNew:
{
Description: The dynamic list. ,
Required: False ,
}
{
operationId:
{
Description: The operation id to fetch dynamic schema. ,
Required: False ,
}
string ,
builtInOperation:
{
Description: The built in operation. ,
Required: False ,
}
string ,
itemsPath:
{
Description: The path to a response property (relative to the response object, not the response body) which contains an array of dynamic value items. ,
Required: False ,
}
string ,
itemValuePath:
{
Description: The path to a property which defines the value which should be used. ,
Required: False ,
}
string ,
itemTitlePath:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
parameters:
{
Description: The parameters. ,
Required: False ,
}
object ,
}
,
dynamicTree:
{
Description: The dynamic values tree configuration. ,
Required: False ,
}
{
settings:
{
Description: The tree settings ,
Required: False ,
}
{
CanSelectParentNodes:
{
Description: Indicates whether parent nodes can be selected. ,
Required: False ,
}
boolean ,
CanSelectLeafNodes:
{
Description: Indicates whether leaf nodes can be selected. ,
Required: False ,
}
boolean ,
}
,
open:
{
Description: The tree on-open configuration ,
Required: False ,
}
{
operationId:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
itemsPath:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
itemValuePath:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
itemTitlePath:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
itemFullTitlePath:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
itemIsParent:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
selectableFilter:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
parameters:
{
Required: False ,
}
object ,
}
,
browse:
{
Description: The tree on-browse configuration ,
Required: False ,
}
{
operationId:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
itemsPath:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
itemValuePath:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
itemTitlePath:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
itemFullTitlePath:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
itemIsParent:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
selectableFilter:
{
Description: The path to an item property which defines the display name of the item. ,
Required: False ,
}
string ,
parameters:
{
Required: False ,
}
object ,
}
,
}
,
}
,
responsesDefinition:
{
Description: The operation responses definition schemas. ,
Required: False ,
}
object ,
isWebhook:
{
Description: Indicates whether the API operation is webhook or not. ,
Required: False ,
}
boolean ,
isNotification:
{
Description: Indicates whether the API operation is notification or not. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get the next set of results. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}
Operations_List (removed)
Description :  Lists all of the available Logic REST API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Logic/operations
{
api-version:
{
Description: The API version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of Logic operations supported by the Logic resource provider. ,
Required: False ,
}
[
{
origin:
{
Description: Operation: origin ,
Required: False ,
}
string ,
name:
{
Description: Operation name: {provider}/{resource}/{operation} ,
Required: False ,
}
string ,
display:
{
Description: The object that represents the operation. ,
Required: False ,
}
{
provider:
{
Description: Service provider: Microsoft.Logic ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed: Profile, endpoint, etc. ,
Required: False ,
}
string ,
operation:
{
Description: Operation type: Read, write, delete, etc. ,
Required: False ,
}
string ,
description:
{
Description: Operation: description. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: The properties. ,
Required: False ,
}
object ,
}
,
]
,
nextLink:
{
Description: URL to get the next set of operation list results if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
,
}