Find integration by id
GET/v2/integrations/:id
Find integration by id
Request
Path Parameters
Responses
- 200
- 404
- 502
The integration corresponding to the ID
- text/plain; x-api-version=2.0
- application/json; x-api-version=2.0
- text/json; x-api-version=2.0
- application/xml; x-api-version=2.0
- text/xml; x-api-version=2.0
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
]
Array [
Array [
]
]
Array [
]
inboundConnection
object
Possible values: [0
, 1
, 2
]
ackOptions
object
condition
object
intervalOptions
object
retryOptions
object
subIntegrations
object[]
nullable
loggingWebhookOverrides
object
Possible values: [0
, 1
, 2
, 3
, 4
]
transformations
object[]
nullable
outboundConnections
object[]
nullable
Possible values: [0
, 1
, 2
]
ackOptions
object
condition
object
intervalOptions
object
retryOptions
object
internalProperties
object
preDefinedUserProperties
object
nullable
condition
object
loggingWebhooks
object[]
nullable
Possible values: [0
, 1
]
Possible values: [0
, 1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
, 11
, 12
]
authorizationHeaderKey
object
Possible values: [0
, 1
, 2
, 3
, 4
, 5
]
headers
object
nullable
Possible values: [0
, 1
, 2
, 3
, 4
]
externalContentServiceWebhook
object
apimSubscriptionKey
object
oAuthClientSecret
object
headers
object
nullable
Possible values: [0
, 1
]
Possible values: [0
, 1
]
oAuthPwd
object
customAuthenticationProperties
object
nullable
basicAuthenticationPassword
object
restResponseErrorHandlingRules
object[]
nullable
Possible values: [0
, 1
, 2
]
customTokenHeader
object
resendWebhooks
object[]
nullable
Possible values: [0
, 1
]
Possible values: [0
, 1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
, 11
, 12
]
authorizationHeaderKey
object
Possible values: [0
, 1
, 2
, 3
, 4
, 5
]
headers
object
nullable
internalLoggingOptions
object
Possible values: [0
, 1
, 2
, 3
, 4
]
retryOptions
object
inboundRetryOptions
object
internalProperties
object
Possible values: [0
, 1
]
{
"configCorrelationId": "string",
"description": "string",
"inboundConnection": {
"adapterType": "string",
"useProcessLock": true,
"wrapperType": 0,
"mightBeWrapped": true,
"adapterId": "string",
"adapterName": "string",
"connectionProperties": "string",
"ackOptions": {
"sendAck": true,
"adapterType": "string",
"connectionProperties": "string",
"transformationSasUri": "string",
"transformationId": "string",
"transformationVersion": "string",
"ackOutboundFormat": "string",
"useZipMapping": true,
"sendNegativeAck": true,
"dllFileNameWithExtension": "string"
},
"condition": {
"enabled": true,
"expression": "string"
},
"intervalOptions": {
"useInterval": true,
"pollingIntervalInSeconds": 0,
"intervalExpression": "string",
"retryOptions": {
"failureRetryIntervalSeconds": 0,
"turnOffFailureRetry": true,
"retryOnNonTransientFailures": true
}
}
},
"subIntegrations": [
{
"subIntegrationId": "string",
"subintegrationName": "string",
"sender": "string",
"receiver": "string",
"loggingWebhookOverrides": {
"logLevel": 0,
"inboundMesssageType": "string",
"outboundMessageType": "string",
"logMessageContent": true,
"transactionTag": "string",
"customInboundDescription": "string",
"customOutboundDescription": "string",
"logMetaData": true,
"enabled": true
},
"transformations": [
{
"id": "string",
"transformationType": "string",
"transformationName": "string",
"properties": "string"
}
],
"passThrough": true,
"outboundConnections": [
{
"adapterType": "string",
"useProcessLock": true,
"wrapperType": 0,
"mightBeWrapped": true,
"adapterId": "string",
"adapterName": "string",
"connectionProperties": "string",
"ackOptions": {
"sendAck": true,
"adapterType": "string",
"connectionProperties": "string",
"transformationSasUri": "string",
"transformationId": "string",
"transformationVersion": "string",
"ackOutboundFormat": "string",
"useZipMapping": true,
"sendNegativeAck": true,
"dllFileNameWithExtension": "string"
},
"condition": {
"enabled": true,
"expression": "string"
},
"intervalOptions": {
"useInterval": true,
"pollingIntervalInSeconds": 0,
"intervalExpression": "string",
"retryOptions": {
"failureRetryIntervalSeconds": 0,
"turnOffFailureRetry": true,
"retryOnNonTransientFailures": true
}
}
}
],
"messageOutboundFormat": "string",
"messageOutboundEncoding": "string",
"internalProperties": {
"redirectInboundToRetry": true,
"redirectBatchingToRetry": true,
"redirectSplittingToRetry": true
},
"enabled": true,
"preDefinedUserProperties": {},
"condition": {
"enabled": true,
"expression": "string"
}
}
],
"companyName": "string",
"companyId": "string",
"subscriptionName": "string",
"subscriptionId": "string",
"transactionType": "string",
"loggingWebhooks": [
{
"contract": 0,
"endpointURL": "string",
"httpVerb": "string",
"webhookConnectionId": "string",
"adapterType": 0,
"queryString": "string",
"maxRetries": 0,
"timeout": 0,
"authorizationHeaderKey": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"type": 0,
"enabled": true,
"headers": {},
"logLevel": 0,
"inboundMesssageType": "string",
"outboundMessageType": "string",
"logMessageContent": true,
"transactionTag": "string",
"customInboundDescription": "string",
"customOutboundDescription": "string",
"logMetaData": true,
"useExternalContentService": true,
"sendContentOnExternalServiceFailure": true,
"externalContentServiceWebhook": {
"endpointURL": "string",
"httpVerb": "string",
"webhookConnectionId": "string",
"authorizationHeaderType": "string",
"apimSubscriptionKey": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"oAuthUrl": "string",
"oAuthBody": "string",
"oAuthClientId": "string",
"oAuthClientSecret": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"headers": {},
"body": "string",
"usePaging": true,
"useDateDelta": true,
"pagingType": 0,
"nextLinkType": 0,
"pathName": "string",
"oAuthGrantType": "string",
"oAuthUserName": "string",
"oAuthPwd": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"oAuthResource": "string",
"oAuthScope": "string",
"customAuthenticationProperties": {},
"basicAuthenticationUserName": "string",
"basicAuthenticationPassword": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"newInternalMessageCorrelationId": "string",
"newInternalMessagePreserveInterchangeId": true,
"useFallBackOnRequestFailed": true,
"fallBackOnThreeHoundred": true,
"fallBackOnFourHoundred": true,
"fallBackOnFiveHoundred": true,
"useStaticIp": true,
"terminateOnDuplicateDetection": true,
"duplicateTerminationStatus": "string",
"restResponseErrorHandlingRules": [
{
"statusCodes": "string",
"action": 0,
"retry": true,
"customStatus": "string"
}
],
"customTimeout": 0,
"useCustomTokenHeader": true,
"customTokenHeader": {
"key": "string",
"value": "string"
}
}
}
],
"resendWebhooks": [
{
"contract": 0,
"endpointURL": "string",
"httpVerb": "string",
"webhookConnectionId": "string",
"adapterType": 0,
"queryString": "string",
"maxRetries": 0,
"timeout": 0,
"authorizationHeaderKey": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"type": 0,
"enabled": true,
"headers": {},
"usePureMessageSending": true
}
],
"internalLoggingOptions": {
"logLevel": 0,
"logMessageContent": true,
"logMetaData": true
},
"retryOptions": {
"failureCountIntervalMinutes": 0,
"reQueueMaxDelaySeconds": 0,
"reQueueMinDelaySeconds": 0,
"maxErrorsPerInterval": 0,
"numberOfRetries": 0,
"enabled": true,
"turnOffErrorPersistance": true,
"maxDelayActions": 0,
"inboundRetryOptions": {
"failureRetryIntervalSeconds": 0,
"turnOffFailureRetry": true,
"retryOnNonTransientFailures": true
}
},
"sender": "string",
"receiver": "string",
"messageInboundFormat": "string",
"messageInboundEncoding": "string",
"removeBom": true,
"handleAsBinaryFile": true,
"internalProperties": {
"redirectInboundToRetry": true,
"redirectBatchingToRetry": true,
"redirectSplittingToRetry": true
},
"stopOnEncodingError": true,
"pollingIntervalInSeconds": 0,
"intervalExpression": "string",
"enabled": true,
"environment": 0,
"useApiKey": true,
"archived": true,
"moved": true,
"id": "string",
"_etag": "string",
"cosmosEntityName": "string",
"createdBy": "string",
"updatedBy": "string",
"createdAtUtc": "2024-09-27T08:40:18.783Z",
"updatedAtUtc": "2024-09-27T08:40:18.783Z"
}
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
]
Array [
Array [
]
]
Array [
]
inboundConnection
object
Possible values: [0
, 1
, 2
]
ackOptions
object
condition
object
intervalOptions
object
retryOptions
object
subIntegrations
object[]
nullable
loggingWebhookOverrides
object
Possible values: [0
, 1
, 2
, 3
, 4
]
transformations
object[]
nullable
outboundConnections
object[]
nullable
Possible values: [0
, 1
, 2
]
ackOptions
object
condition
object
intervalOptions
object
retryOptions
object
internalProperties
object
preDefinedUserProperties
object
nullable
condition
object
loggingWebhooks
object[]
nullable
Possible values: [0
, 1
]
Possible values: [0
, 1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
, 11
, 12
]
authorizationHeaderKey
object
Possible values: [0
, 1
, 2
, 3
, 4
, 5
]
headers
object
nullable
Possible values: [0
, 1
, 2
, 3
, 4
]
externalContentServiceWebhook
object
apimSubscriptionKey
object
oAuthClientSecret
object
headers
object
nullable
Possible values: [0
, 1
]
Possible values: [0
, 1
]
oAuthPwd
object
customAuthenticationProperties
object
nullable
basicAuthenticationPassword
object
restResponseErrorHandlingRules
object[]
nullable
Possible values: [0
, 1
, 2
]
customTokenHeader
object
resendWebhooks
object[]
nullable
Possible values: [0
, 1
]
Possible values: [0
, 1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
, 11
, 12
]
authorizationHeaderKey
object
Possible values: [0
, 1
, 2
, 3
, 4
, 5
]
headers
object
nullable
internalLoggingOptions
object
Possible values: [0
, 1
, 2
, 3
, 4
]
retryOptions
object
inboundRetryOptions
object
internalProperties
object
Possible values: [0
, 1
]
{
"configCorrelationId": "string",
"description": "string",
"inboundConnection": {
"adapterType": "string",
"useProcessLock": true,
"wrapperType": 0,
"mightBeWrapped": true,
"adapterId": "string",
"adapterName": "string",
"connectionProperties": "string",
"ackOptions": {
"sendAck": true,
"adapterType": "string",
"connectionProperties": "string",
"transformationSasUri": "string",
"transformationId": "string",
"transformationVersion": "string",
"ackOutboundFormat": "string",
"useZipMapping": true,
"sendNegativeAck": true,
"dllFileNameWithExtension": "string"
},
"condition": {
"enabled": true,
"expression": "string"
},
"intervalOptions": {
"useInterval": true,
"pollingIntervalInSeconds": 0,
"intervalExpression": "string",
"retryOptions": {
"failureRetryIntervalSeconds": 0,
"turnOffFailureRetry": true,
"retryOnNonTransientFailures": true
}
}
},
"subIntegrations": [
{
"subIntegrationId": "string",
"subintegrationName": "string",
"sender": "string",
"receiver": "string",
"loggingWebhookOverrides": {
"logLevel": 0,
"inboundMesssageType": "string",
"outboundMessageType": "string",
"logMessageContent": true,
"transactionTag": "string",
"customInboundDescription": "string",
"customOutboundDescription": "string",
"logMetaData": true,
"enabled": true
},
"transformations": [
{
"id": "string",
"transformationType": "string",
"transformationName": "string",
"properties": "string"
}
],
"passThrough": true,
"outboundConnections": [
{
"adapterType": "string",
"useProcessLock": true,
"wrapperType": 0,
"mightBeWrapped": true,
"adapterId": "string",
"adapterName": "string",
"connectionProperties": "string",
"ackOptions": {
"sendAck": true,
"adapterType": "string",
"connectionProperties": "string",
"transformationSasUri": "string",
"transformationId": "string",
"transformationVersion": "string",
"ackOutboundFormat": "string",
"useZipMapping": true,
"sendNegativeAck": true,
"dllFileNameWithExtension": "string"
},
"condition": {
"enabled": true,
"expression": "string"
},
"intervalOptions": {
"useInterval": true,
"pollingIntervalInSeconds": 0,
"intervalExpression": "string",
"retryOptions": {
"failureRetryIntervalSeconds": 0,
"turnOffFailureRetry": true,
"retryOnNonTransientFailures": true
}
}
}
],
"messageOutboundFormat": "string",
"messageOutboundEncoding": "string",
"internalProperties": {
"redirectInboundToRetry": true,
"redirectBatchingToRetry": true,
"redirectSplittingToRetry": true
},
"enabled": true,
"preDefinedUserProperties": {},
"condition": {
"enabled": true,
"expression": "string"
}
}
],
"companyName": "string",
"companyId": "string",
"subscriptionName": "string",
"subscriptionId": "string",
"transactionType": "string",
"loggingWebhooks": [
{
"contract": 0,
"endpointURL": "string",
"httpVerb": "string",
"webhookConnectionId": "string",
"adapterType": 0,
"queryString": "string",
"maxRetries": 0,
"timeout": 0,
"authorizationHeaderKey": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"type": 0,
"enabled": true,
"headers": {},
"logLevel": 0,
"inboundMesssageType": "string",
"outboundMessageType": "string",
"logMessageContent": true,
"transactionTag": "string",
"customInboundDescription": "string",
"customOutboundDescription": "string",
"logMetaData": true,
"useExternalContentService": true,
"sendContentOnExternalServiceFailure": true,
"externalContentServiceWebhook": {
"endpointURL": "string",
"httpVerb": "string",
"webhookConnectionId": "string",
"authorizationHeaderType": "string",
"apimSubscriptionKey": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"oAuthUrl": "string",
"oAuthBody": "string",
"oAuthClientId": "string",
"oAuthClientSecret": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"headers": {},
"body": "string",
"usePaging": true,
"useDateDelta": true,
"pagingType": 0,
"nextLinkType": 0,
"pathName": "string",
"oAuthGrantType": "string",
"oAuthUserName": "string",
"oAuthPwd": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"oAuthResource": "string",
"oAuthScope": "string",
"customAuthenticationProperties": {},
"basicAuthenticationUserName": "string",
"basicAuthenticationPassword": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"newInternalMessageCorrelationId": "string",
"newInternalMessagePreserveInterchangeId": true,
"useFallBackOnRequestFailed": true,
"fallBackOnThreeHoundred": true,
"fallBackOnFourHoundred": true,
"fallBackOnFiveHoundred": true,
"useStaticIp": true,
"terminateOnDuplicateDetection": true,
"duplicateTerminationStatus": "string",
"restResponseErrorHandlingRules": [
{
"statusCodes": "string",
"action": 0,
"retry": true,
"customStatus": "string"
}
],
"customTimeout": 0,
"useCustomTokenHeader": true,
"customTokenHeader": {
"key": "string",
"value": "string"
}
}
}
],
"resendWebhooks": [
{
"contract": 0,
"endpointURL": "string",
"httpVerb": "string",
"webhookConnectionId": "string",
"adapterType": 0,
"queryString": "string",
"maxRetries": 0,
"timeout": 0,
"authorizationHeaderKey": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"type": 0,
"enabled": true,
"headers": {},
"usePureMessageSending": true
}
],
"internalLoggingOptions": {
"logLevel": 0,
"logMessageContent": true,
"logMetaData": true
},
"retryOptions": {
"failureCountIntervalMinutes": 0,
"reQueueMaxDelaySeconds": 0,
"reQueueMinDelaySeconds": 0,
"maxErrorsPerInterval": 0,
"numberOfRetries": 0,
"enabled": true,
"turnOffErrorPersistance": true,
"maxDelayActions": 0,
"inboundRetryOptions": {
"failureRetryIntervalSeconds": 0,
"turnOffFailureRetry": true,
"retryOnNonTransientFailures": true
}
},
"sender": "string",
"receiver": "string",
"messageInboundFormat": "string",
"messageInboundEncoding": "string",
"removeBom": true,
"handleAsBinaryFile": true,
"internalProperties": {
"redirectInboundToRetry": true,
"redirectBatchingToRetry": true,
"redirectSplittingToRetry": true
},
"stopOnEncodingError": true,
"pollingIntervalInSeconds": 0,
"intervalExpression": "string",
"enabled": true,
"environment": 0,
"useApiKey": true,
"archived": true,
"moved": true,
"id": "string",
"_etag": "string",
"cosmosEntityName": "string",
"createdBy": "string",
"updatedBy": "string",
"createdAtUtc": "2024-09-27T08:40:18.788Z",
"updatedAtUtc": "2024-09-27T08:40:18.788Z"
}
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
]
Array [
Array [
]
]
Array [
]
inboundConnection
object
Possible values: [0
, 1
, 2
]
ackOptions
object
condition
object
intervalOptions
object
retryOptions
object
subIntegrations
object[]
nullable
loggingWebhookOverrides
object
Possible values: [0
, 1
, 2
, 3
, 4
]
transformations
object[]
nullable
outboundConnections
object[]
nullable
Possible values: [0
, 1
, 2
]
ackOptions
object
condition
object
intervalOptions
object
retryOptions
object
internalProperties
object
preDefinedUserProperties
object
nullable
condition
object
loggingWebhooks
object[]
nullable
Possible values: [0
, 1
]
Possible values: [0
, 1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
, 11
, 12
]
authorizationHeaderKey
object
Possible values: [0
, 1
, 2
, 3
, 4
, 5
]
headers
object
nullable
Possible values: [0
, 1
, 2
, 3
, 4
]
externalContentServiceWebhook
object
apimSubscriptionKey
object
oAuthClientSecret
object
headers
object
nullable
Possible values: [0
, 1
]
Possible values: [0
, 1
]
oAuthPwd
object
customAuthenticationProperties
object
nullable
basicAuthenticationPassword
object
restResponseErrorHandlingRules
object[]
nullable
Possible values: [0
, 1
, 2
]
customTokenHeader
object
resendWebhooks
object[]
nullable
Possible values: [0
, 1
]
Possible values: [0
, 1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
, 11
, 12
]
authorizationHeaderKey
object
Possible values: [0
, 1
, 2
, 3
, 4
, 5
]
headers
object
nullable
internalLoggingOptions
object
Possible values: [0
, 1
, 2
, 3
, 4
]
retryOptions
object
inboundRetryOptions
object
internalProperties
object
Possible values: [0
, 1
]
{
"configCorrelationId": "string",
"description": "string",
"inboundConnection": {
"adapterType": "string",
"useProcessLock": true,
"wrapperType": 0,
"mightBeWrapped": true,
"adapterId": "string",
"adapterName": "string",
"connectionProperties": "string",
"ackOptions": {
"sendAck": true,
"adapterType": "string",
"connectionProperties": "string",
"transformationSasUri": "string",
"transformationId": "string",
"transformationVersion": "string",
"ackOutboundFormat": "string",
"useZipMapping": true,
"sendNegativeAck": true,
"dllFileNameWithExtension": "string"
},
"condition": {
"enabled": true,
"expression": "string"
},
"intervalOptions": {
"useInterval": true,
"pollingIntervalInSeconds": 0,
"intervalExpression": "string",
"retryOptions": {
"failureRetryIntervalSeconds": 0,
"turnOffFailureRetry": true,
"retryOnNonTransientFailures": true
}
}
},
"subIntegrations": [
{
"subIntegrationId": "string",
"subintegrationName": "string",
"sender": "string",
"receiver": "string",
"loggingWebhookOverrides": {
"logLevel": 0,
"inboundMesssageType": "string",
"outboundMessageType": "string",
"logMessageContent": true,
"transactionTag": "string",
"customInboundDescription": "string",
"customOutboundDescription": "string",
"logMetaData": true,
"enabled": true
},
"transformations": [
{
"id": "string",
"transformationType": "string",
"transformationName": "string",
"properties": "string"
}
],
"passThrough": true,
"outboundConnections": [
{
"adapterType": "string",
"useProcessLock": true,
"wrapperType": 0,
"mightBeWrapped": true,
"adapterId": "string",
"adapterName": "string",
"connectionProperties": "string",
"ackOptions": {
"sendAck": true,
"adapterType": "string",
"connectionProperties": "string",
"transformationSasUri": "string",
"transformationId": "string",
"transformationVersion": "string",
"ackOutboundFormat": "string",
"useZipMapping": true,
"sendNegativeAck": true,
"dllFileNameWithExtension": "string"
},
"condition": {
"enabled": true,
"expression": "string"
},
"intervalOptions": {
"useInterval": true,
"pollingIntervalInSeconds": 0,
"intervalExpression": "string",
"retryOptions": {
"failureRetryIntervalSeconds": 0,
"turnOffFailureRetry": true,
"retryOnNonTransientFailures": true
}
}
}
],
"messageOutboundFormat": "string",
"messageOutboundEncoding": "string",
"internalProperties": {
"redirectInboundToRetry": true,
"redirectBatchingToRetry": true,
"redirectSplittingToRetry": true
},
"enabled": true,
"preDefinedUserProperties": {},
"condition": {
"enabled": true,
"expression": "string"
}
}
],
"companyName": "string",
"companyId": "string",
"subscriptionName": "string",
"subscriptionId": "string",
"transactionType": "string",
"loggingWebhooks": [
{
"contract": 0,
"endpointURL": "string",
"httpVerb": "string",
"webhookConnectionId": "string",
"adapterType": 0,
"queryString": "string",
"maxRetries": 0,
"timeout": 0,
"authorizationHeaderKey": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"type": 0,
"enabled": true,
"headers": {},
"logLevel": 0,
"inboundMesssageType": "string",
"outboundMessageType": "string",
"logMessageContent": true,
"transactionTag": "string",
"customInboundDescription": "string",
"customOutboundDescription": "string",
"logMetaData": true,
"useExternalContentService": true,
"sendContentOnExternalServiceFailure": true,
"externalContentServiceWebhook": {
"endpointURL": "string",
"httpVerb": "string",
"webhookConnectionId": "string",
"authorizationHeaderType": "string",
"apimSubscriptionKey": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"oAuthUrl": "string",
"oAuthBody": "string",
"oAuthClientId": "string",
"oAuthClientSecret": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"headers": {},
"body": "string",
"usePaging": true,
"useDateDelta": true,
"pagingType": 0,
"nextLinkType": 0,
"pathName": "string",
"oAuthGrantType": "string",
"oAuthUserName": "string",
"oAuthPwd": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"oAuthResource": "string",
"oAuthScope": "string",
"customAuthenticationProperties": {},
"basicAuthenticationUserName": "string",
"basicAuthenticationPassword": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"newInternalMessageCorrelationId": "string",
"newInternalMessagePreserveInterchangeId": true,
"useFallBackOnRequestFailed": true,
"fallBackOnThreeHoundred": true,
"fallBackOnFourHoundred": true,
"fallBackOnFiveHoundred": true,
"useStaticIp": true,
"terminateOnDuplicateDetection": true,
"duplicateTerminationStatus": "string",
"restResponseErrorHandlingRules": [
{
"statusCodes": "string",
"action": 0,
"retry": true,
"customStatus": "string"
}
],
"customTimeout": 0,
"useCustomTokenHeader": true,
"customTokenHeader": {
"key": "string",
"value": "string"
}
}
}
],
"resendWebhooks": [
{
"contract": 0,
"endpointURL": "string",
"httpVerb": "string",
"webhookConnectionId": "string",
"adapterType": 0,
"queryString": "string",
"maxRetries": 0,
"timeout": 0,
"authorizationHeaderKey": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"type": 0,
"enabled": true,
"headers": {},
"usePureMessageSending": true
}
],
"internalLoggingOptions": {
"logLevel": 0,
"logMessageContent": true,
"logMetaData": true
},
"retryOptions": {
"failureCountIntervalMinutes": 0,
"reQueueMaxDelaySeconds": 0,
"reQueueMinDelaySeconds": 0,
"maxErrorsPerInterval": 0,
"numberOfRetries": 0,
"enabled": true,
"turnOffErrorPersistance": true,
"maxDelayActions": 0,
"inboundRetryOptions": {
"failureRetryIntervalSeconds": 0,
"turnOffFailureRetry": true,
"retryOnNonTransientFailures": true
}
},
"sender": "string",
"receiver": "string",
"messageInboundFormat": "string",
"messageInboundEncoding": "string",
"removeBom": true,
"handleAsBinaryFile": true,
"internalProperties": {
"redirectInboundToRetry": true,
"redirectBatchingToRetry": true,
"redirectSplittingToRetry": true
},
"stopOnEncodingError": true,
"pollingIntervalInSeconds": 0,
"intervalExpression": "string",
"enabled": true,
"environment": 0,
"useApiKey": true,
"archived": true,
"moved": true,
"id": "string",
"_etag": "string",
"cosmosEntityName": "string",
"createdBy": "string",
"updatedBy": "string",
"createdAtUtc": "2024-09-27T08:40:18.791Z",
"updatedAtUtc": "2024-09-27T08:40:18.791Z"
}
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
]
Array [
Array [
]
]
Array [
]
inboundConnection
object
Possible values: [0
, 1
, 2
]
ackOptions
object
condition
object
intervalOptions
object
retryOptions
object
subIntegrations
object[]
nullable
loggingWebhookOverrides
object
Possible values: [0
, 1
, 2
, 3
, 4
]
transformations
object[]
nullable
outboundConnections
object[]
nullable
Possible values: [0
, 1
, 2
]
ackOptions
object
condition
object
intervalOptions
object
retryOptions
object
internalProperties
object
preDefinedUserProperties
object
nullable
condition
object
loggingWebhooks
object[]
nullable
Possible values: [0
, 1
]
Possible values: [0
, 1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
, 11
, 12
]
authorizationHeaderKey
object
Possible values: [0
, 1
, 2
, 3
, 4
, 5
]
headers
object
nullable
Possible values: [0
, 1
, 2
, 3
, 4
]
externalContentServiceWebhook
object
apimSubscriptionKey
object
oAuthClientSecret
object
headers
object
nullable
Possible values: [0
, 1
]
Possible values: [0
, 1
]
oAuthPwd
object
customAuthenticationProperties
object
nullable
basicAuthenticationPassword
object
restResponseErrorHandlingRules
object[]
nullable
Possible values: [0
, 1
, 2
]
customTokenHeader
object
resendWebhooks
object[]
nullable
Possible values: [0
, 1
]
Possible values: [0
, 1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
, 11
, 12
]
authorizationHeaderKey
object
Possible values: [0
, 1
, 2
, 3
, 4
, 5
]
headers
object
nullable
internalLoggingOptions
object
Possible values: [0
, 1
, 2
, 3
, 4
]
retryOptions
object
inboundRetryOptions
object
internalProperties
object
Possible values: [0
, 1
]
{
"configCorrelationId": "string",
"description": "string",
"inboundConnection": {
"adapterType": "string",
"useProcessLock": true,
"wrapperType": 0,
"mightBeWrapped": true,
"adapterId": "string",
"adapterName": "string",
"connectionProperties": "string",
"ackOptions": {
"sendAck": true,
"adapterType": "string",
"connectionProperties": "string",
"transformationSasUri": "string",
"transformationId": "string",
"transformationVersion": "string",
"ackOutboundFormat": "string",
"useZipMapping": true,
"sendNegativeAck": true,
"dllFileNameWithExtension": "string"
},
"condition": {
"enabled": true,
"expression": "string"
},
"intervalOptions": {
"useInterval": true,
"pollingIntervalInSeconds": 0,
"intervalExpression": "string",
"retryOptions": {
"failureRetryIntervalSeconds": 0,
"turnOffFailureRetry": true,
"retryOnNonTransientFailures": true
}
}
},
"subIntegrations": [
{
"subIntegrationId": "string",
"subintegrationName": "string",
"sender": "string",
"receiver": "string",
"loggingWebhookOverrides": {
"logLevel": 0,
"inboundMesssageType": "string",
"outboundMessageType": "string",
"logMessageContent": true,
"transactionTag": "string",
"customInboundDescription": "string",
"customOutboundDescription": "string",
"logMetaData": true,
"enabled": true
},
"transformations": [
{
"id": "string",
"transformationType": "string",
"transformationName": "string",
"properties": "string"
}
],
"passThrough": true,
"outboundConnections": [
{
"adapterType": "string",
"useProcessLock": true,
"wrapperType": 0,
"mightBeWrapped": true,
"adapterId": "string",
"adapterName": "string",
"connectionProperties": "string",
"ackOptions": {
"sendAck": true,
"adapterType": "string",
"connectionProperties": "string",
"transformationSasUri": "string",
"transformationId": "string",
"transformationVersion": "string",
"ackOutboundFormat": "string",
"useZipMapping": true,
"sendNegativeAck": true,
"dllFileNameWithExtension": "string"
},
"condition": {
"enabled": true,
"expression": "string"
},
"intervalOptions": {
"useInterval": true,
"pollingIntervalInSeconds": 0,
"intervalExpression": "string",
"retryOptions": {
"failureRetryIntervalSeconds": 0,
"turnOffFailureRetry": true,
"retryOnNonTransientFailures": true
}
}
}
],
"messageOutboundFormat": "string",
"messageOutboundEncoding": "string",
"internalProperties": {
"redirectInboundToRetry": true,
"redirectBatchingToRetry": true,
"redirectSplittingToRetry": true
},
"enabled": true,
"preDefinedUserProperties": {},
"condition": {
"enabled": true,
"expression": "string"
}
}
],
"companyName": "string",
"companyId": "string",
"subscriptionName": "string",
"subscriptionId": "string",
"transactionType": "string",
"loggingWebhooks": [
{
"contract": 0,
"endpointURL": "string",
"httpVerb": "string",
"webhookConnectionId": "string",
"adapterType": 0,
"queryString": "string",
"maxRetries": 0,
"timeout": 0,
"authorizationHeaderKey": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"type": 0,
"enabled": true,
"headers": {},
"logLevel": 0,
"inboundMesssageType": "string",
"outboundMessageType": "string",
"logMessageContent": true,
"transactionTag": "string",
"customInboundDescription": "string",
"customOutboundDescription": "string",
"logMetaData": true,
"useExternalContentService": true,
"sendContentOnExternalServiceFailure": true,
"externalContentServiceWebhook": {
"endpointURL": "string",
"httpVerb": "string",
"webhookConnectionId": "string",
"authorizationHeaderType": "string",
"apimSubscriptionKey": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"oAuthUrl": "string",
"oAuthBody": "string",
"oAuthClientId": "string",
"oAuthClientSecret": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"headers": {},
"body": "string",
"usePaging": true,
"useDateDelta": true,
"pagingType": 0,
"nextLinkType": 0,
"pathName": "string",
"oAuthGrantType": "string",
"oAuthUserName": "string",
"oAuthPwd": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"oAuthResource": "string",
"oAuthScope": "string",
"customAuthenticationProperties": {},
"basicAuthenticationUserName": "string",
"basicAuthenticationPassword": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"newInternalMessageCorrelationId": "string",
"newInternalMessagePreserveInterchangeId": true,
"useFallBackOnRequestFailed": true,
"fallBackOnThreeHoundred": true,
"fallBackOnFourHoundred": true,
"fallBackOnFiveHoundred": true,
"useStaticIp": true,
"terminateOnDuplicateDetection": true,
"duplicateTerminationStatus": "string",
"restResponseErrorHandlingRules": [
{
"statusCodes": "string",
"action": 0,
"retry": true,
"customStatus": "string"
}
],
"customTimeout": 0,
"useCustomTokenHeader": true,
"customTokenHeader": {
"key": "string",
"value": "string"
}
}
}
],
"resendWebhooks": [
{
"contract": 0,
"endpointURL": "string",
"httpVerb": "string",
"webhookConnectionId": "string",
"adapterType": 0,
"queryString": "string",
"maxRetries": 0,
"timeout": 0,
"authorizationHeaderKey": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"type": 0,
"enabled": true,
"headers": {},
"usePureMessageSending": true
}
],
"internalLoggingOptions": {
"logLevel": 0,
"logMessageContent": true,
"logMetaData": true
},
"retryOptions": {
"failureCountIntervalMinutes": 0,
"reQueueMaxDelaySeconds": 0,
"reQueueMinDelaySeconds": 0,
"maxErrorsPerInterval": 0,
"numberOfRetries": 0,
"enabled": true,
"turnOffErrorPersistance": true,
"maxDelayActions": 0,
"inboundRetryOptions": {
"failureRetryIntervalSeconds": 0,
"turnOffFailureRetry": true,
"retryOnNonTransientFailures": true
}
},
"sender": "string",
"receiver": "string",
"messageInboundFormat": "string",
"messageInboundEncoding": "string",
"removeBom": true,
"handleAsBinaryFile": true,
"internalProperties": {
"redirectInboundToRetry": true,
"redirectBatchingToRetry": true,
"redirectSplittingToRetry": true
},
"stopOnEncodingError": true,
"pollingIntervalInSeconds": 0,
"intervalExpression": "string",
"enabled": true,
"environment": 0,
"useApiKey": true,
"archived": true,
"moved": true,
"id": "string",
"_etag": "string",
"cosmosEntityName": "string",
"createdBy": "string",
"updatedBy": "string",
"createdAtUtc": "2024-09-27T08:40:18.795Z",
"updatedAtUtc": "2024-09-27T08:40:18.795Z"
}
- Schema
- Example (from schema)
Schema
Array [
Array [
]
Array [
]
]
Array [
Array [
]
]
Array [
]
inboundConnection
object
Possible values: [0
, 1
, 2
]
ackOptions
object
condition
object
intervalOptions
object
retryOptions
object
subIntegrations
object[]
nullable
loggingWebhookOverrides
object
Possible values: [0
, 1
, 2
, 3
, 4
]
transformations
object[]
nullable
outboundConnections
object[]
nullable
Possible values: [0
, 1
, 2
]
ackOptions
object
condition
object
intervalOptions
object
retryOptions
object
internalProperties
object
preDefinedUserProperties
object
nullable
condition
object
loggingWebhooks
object[]
nullable
Possible values: [0
, 1
]
Possible values: [0
, 1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
, 11
, 12
]
authorizationHeaderKey
object
Possible values: [0
, 1
, 2
, 3
, 4
, 5
]
headers
object
nullable
Possible values: [0
, 1
, 2
, 3
, 4
]
externalContentServiceWebhook
object
apimSubscriptionKey
object
oAuthClientSecret
object
headers
object
nullable
Possible values: [0
, 1
]
Possible values: [0
, 1
]
oAuthPwd
object
customAuthenticationProperties
object
nullable
basicAuthenticationPassword
object
restResponseErrorHandlingRules
object[]
nullable
Possible values: [0
, 1
, 2
]
customTokenHeader
object
resendWebhooks
object[]
nullable
Possible values: [0
, 1
]
Possible values: [0
, 1
, 2
, 3
, 4
, 5
, 6
, 7
, 8
, 9
, 10
, 11
, 12
]
authorizationHeaderKey
object
Possible values: [0
, 1
, 2
, 3
, 4
, 5
]
headers
object
nullable
internalLoggingOptions
object
Possible values: [0
, 1
, 2
, 3
, 4
]
retryOptions
object
inboundRetryOptions
object
internalProperties
object
Possible values: [0
, 1
]
{
"configCorrelationId": "string",
"description": "string",
"inboundConnection": {
"adapterType": "string",
"useProcessLock": true,
"wrapperType": 0,
"mightBeWrapped": true,
"adapterId": "string",
"adapterName": "string",
"connectionProperties": "string",
"ackOptions": {
"sendAck": true,
"adapterType": "string",
"connectionProperties": "string",
"transformationSasUri": "string",
"transformationId": "string",
"transformationVersion": "string",
"ackOutboundFormat": "string",
"useZipMapping": true,
"sendNegativeAck": true,
"dllFileNameWithExtension": "string"
},
"condition": {
"enabled": true,
"expression": "string"
},
"intervalOptions": {
"useInterval": true,
"pollingIntervalInSeconds": 0,
"intervalExpression": "string",
"retryOptions": {
"failureRetryIntervalSeconds": 0,
"turnOffFailureRetry": true,
"retryOnNonTransientFailures": true
}
}
},
"subIntegrations": [
{
"subIntegrationId": "string",
"subintegrationName": "string",
"sender": "string",
"receiver": "string",
"loggingWebhookOverrides": {
"logLevel": 0,
"inboundMesssageType": "string",
"outboundMessageType": "string",
"logMessageContent": true,
"transactionTag": "string",
"customInboundDescription": "string",
"customOutboundDescription": "string",
"logMetaData": true,
"enabled": true
},
"transformations": [
{
"id": "string",
"transformationType": "string",
"transformationName": "string",
"properties": "string"
}
],
"passThrough": true,
"outboundConnections": [
{
"adapterType": "string",
"useProcessLock": true,
"wrapperType": 0,
"mightBeWrapped": true,
"adapterId": "string",
"adapterName": "string",
"connectionProperties": "string",
"ackOptions": {
"sendAck": true,
"adapterType": "string",
"connectionProperties": "string",
"transformationSasUri": "string",
"transformationId": "string",
"transformationVersion": "string",
"ackOutboundFormat": "string",
"useZipMapping": true,
"sendNegativeAck": true,
"dllFileNameWithExtension": "string"
},
"condition": {
"enabled": true,
"expression": "string"
},
"intervalOptions": {
"useInterval": true,
"pollingIntervalInSeconds": 0,
"intervalExpression": "string",
"retryOptions": {
"failureRetryIntervalSeconds": 0,
"turnOffFailureRetry": true,
"retryOnNonTransientFailures": true
}
}
}
],
"messageOutboundFormat": "string",
"messageOutboundEncoding": "string",
"internalProperties": {
"redirectInboundToRetry": true,
"redirectBatchingToRetry": true,
"redirectSplittingToRetry": true
},
"enabled": true,
"preDefinedUserProperties": {},
"condition": {
"enabled": true,
"expression": "string"
}
}
],
"companyName": "string",
"companyId": "string",
"subscriptionName": "string",
"subscriptionId": "string",
"transactionType": "string",
"loggingWebhooks": [
{
"contract": 0,
"endpointURL": "string",
"httpVerb": "string",
"webhookConnectionId": "string",
"adapterType": 0,
"queryString": "string",
"maxRetries": 0,
"timeout": 0,
"authorizationHeaderKey": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"type": 0,
"enabled": true,
"headers": {},
"logLevel": 0,
"inboundMesssageType": "string",
"outboundMessageType": "string",
"logMessageContent": true,
"transactionTag": "string",
"customInboundDescription": "string",
"customOutboundDescription": "string",
"logMetaData": true,
"useExternalContentService": true,
"sendContentOnExternalServiceFailure": true,
"externalContentServiceWebhook": {
"endpointURL": "string",
"httpVerb": "string",
"webhookConnectionId": "string",
"authorizationHeaderType": "string",
"apimSubscriptionKey": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"oAuthUrl": "string",
"oAuthBody": "string",
"oAuthClientId": "string",
"oAuthClientSecret": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"headers": {},
"body": "string",
"usePaging": true,
"useDateDelta": true,
"pagingType": 0,
"nextLinkType": 0,
"pathName": "string",
"oAuthGrantType": "string",
"oAuthUserName": "string",
"oAuthPwd": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"oAuthResource": "string",
"oAuthScope": "string",
"customAuthenticationProperties": {},
"basicAuthenticationUserName": "string",
"basicAuthenticationPassword": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"newInternalMessageCorrelationId": "string",
"newInternalMessagePreserveInterchangeId": true,
"useFallBackOnRequestFailed": true,
"fallBackOnThreeHoundred": true,
"fallBackOnFourHoundred": true,
"fallBackOnFiveHoundred": true,
"useStaticIp": true,
"terminateOnDuplicateDetection": true,
"duplicateTerminationStatus": "string",
"restResponseErrorHandlingRules": [
{
"statusCodes": "string",
"action": 0,
"retry": true,
"customStatus": "string"
}
],
"customTimeout": 0,
"useCustomTokenHeader": true,
"customTokenHeader": {
"key": "string",
"value": "string"
}
}
}
],
"resendWebhooks": [
{
"contract": 0,
"endpointURL": "string",
"httpVerb": "string",
"webhookConnectionId": "string",
"adapterType": 0,
"queryString": "string",
"maxRetries": 0,
"timeout": 0,
"authorizationHeaderKey": {
"decryptedValue": "string",
"name": "string",
"version": "string"
},
"type": 0,
"enabled": true,
"headers": {},
"usePureMessageSending": true
}
],
"internalLoggingOptions": {
"logLevel": 0,
"logMessageContent": true,
"logMetaData": true
},
"retryOptions": {
"failureCountIntervalMinutes": 0,
"reQueueMaxDelaySeconds": 0,
"reQueueMinDelaySeconds": 0,
"maxErrorsPerInterval": 0,
"numberOfRetries": 0,
"enabled": true,
"turnOffErrorPersistance": true,
"maxDelayActions": 0,
"inboundRetryOptions": {
"failureRetryIntervalSeconds": 0,
"turnOffFailureRetry": true,
"retryOnNonTransientFailures": true
}
},
"sender": "string",
"receiver": "string",
"messageInboundFormat": "string",
"messageInboundEncoding": "string",
"removeBom": true,
"handleAsBinaryFile": true,
"internalProperties": {
"redirectInboundToRetry": true,
"redirectBatchingToRetry": true,
"redirectSplittingToRetry": true
},
"stopOnEncodingError": true,
"pollingIntervalInSeconds": 0,
"intervalExpression": "string",
"enabled": true,
"environment": 0,
"useApiKey": true,
"archived": true,
"moved": true,
"id": "string",
"_etag": "string",
"cosmosEntityName": "string",
"createdBy": "string",
"updatedBy": "string",
"createdAtUtc": "2024-09-27T08:40:18.800Z",
"updatedAtUtc": "2024-09-27T08:40:18.800Z"
}
A integration corresponding to the ID could not be found
Could not contact internal services. Please try again later or contact our support department