Skip to main content

Gets the integration configuration corresponding to the configCorrelationId

GET 
/v1/management/integration/:id

Gets the integration configuration corresponding to the configCorrelationId

Request​

Path Parameters

    id stringrequired

Header Parameters

    companyId string

Responses​

The integration corresponding to the configCorrelationId

Schema

    configCorrelationId stringnullable
    description stringnullable

    inboundConnection

    object

    adapterType stringnullable
    useProcessLock boolean
    wrapperType int32

    Possible values: [0, 1, 2]

    mightBeWrapped boolean
    adapterId stringnullable
    adapterName stringnullable
    connectionProperties stringnullable

    ackOptions

    object

    sendAck boolean
    adapterType stringnullable
    connectionProperties stringnullable
    transformationSasUri stringnullable
    transformationId stringnullable
    transformationVersion stringnullable
    ackOutboundFormat stringnullable
    useZipMapping boolean
    sendNegativeAck boolean
    dllFileNameWithExtension stringnullable

    condition

    object

    enabled boolean
    expression stringnullable

    intervalOptions

    object

    useInterval boolean
    pollingIntervalInSeconds int32
    intervalExpression stringnullable

    retryOptions

    object

    failureRetryIntervalSeconds int32nullable
    turnOffFailureRetry boolean
    retryOnNonTransientFailures boolean

    subIntegrations

    object[]

    nullable

  • Array [

    • subIntegrationId stringnullable
    subintegrationName stringnullable
    sender stringnullable
    receiver stringnullable

    loggingWebhookOverrides

    object

    logLevel int32

    Possible values: [0, 1, 2, 3, 4]

    inboundMesssageType stringnullable
    outboundMessageType stringnullable
    logMessageContent booleannullable
    transactionTag stringnullable
    customInboundDescription stringnullable
    customOutboundDescription stringnullable
    logMetaData booleannullable
    enabled boolean

    transformations

    object[]

    nullable

  • Array [

    • id stringnullable
    transformationType stringnullable
    transformationName stringnullable
    properties stringnullable

  • ]

    • passThrough boolean

    outboundConnections

    object[]

    nullable

  • Array [

    • adapterType stringnullable
    useProcessLock boolean
    wrapperType int32

    Possible values: [0, 1, 2]

    mightBeWrapped boolean
    adapterId stringnullable
    adapterName stringnullable
    connectionProperties stringnullable

    ackOptions

    object

    sendAck boolean
    adapterType stringnullable
    connectionProperties stringnullable
    transformationSasUri stringnullable
    transformationId stringnullable
    transformationVersion stringnullable
    ackOutboundFormat stringnullable
    useZipMapping boolean
    sendNegativeAck boolean
    dllFileNameWithExtension stringnullable

    condition

    object

    enabled boolean
    expression stringnullable

    intervalOptions

    object

    useInterval boolean
    pollingIntervalInSeconds int32
    intervalExpression stringnullable

    retryOptions

    object

    failureRetryIntervalSeconds int32nullable
    turnOffFailureRetry boolean
    retryOnNonTransientFailures boolean

  • ]

    • messageOutboundFormat stringnullable
    messageOutboundEncoding stringnullable

    internalProperties

    object

    redirectInboundToRetry boolean
    redirectBatchingToRetry boolean
    redirectSplittingToRetry boolean
    enabled boolean

    preDefinedUserProperties

    object

    nullable

    property name* string

    condition

    object

    enabled boolean
    expression stringnullable

  • ]

    • companyName stringnullable
    companyId stringnullable
    subscriptionName stringnullable
    subscriptionId stringnullable
    transactionType stringnullable

    loggingWebhooks

    object[]

    nullable

  • Array [

    • contract int32

    Possible values: [0, 1]

    endpointURL stringnullable
    httpVerb stringnullable
    webhookConnectionId stringnullable
    adapterType int32

    Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

    queryString stringnullable
    maxRetries int32
    timeout int32

    authorizationHeaderKey

    object

    decryptedValue stringnullable
    name stringnullable
    version stringnullable
    type int32

    Possible values: [0, 1, 2, 3, 4, 5]

    enabled boolean

    headers

    object

    nullable

    property name* string
    logLevel int32

    Possible values: [0, 1, 2, 3, 4]

    inboundMesssageType stringnullable
    outboundMessageType stringnullable
    logMessageContent booleannullable
    transactionTag stringnullable
    customInboundDescription stringnullable
    customOutboundDescription stringnullable
    logMetaData booleannullable
    useExternalContentService booleannullable
    sendContentOnExternalServiceFailure booleannullable

    externalContentServiceWebhook

    object

    endpointURL stringnullable
    httpVerb stringnullable
    webhookConnectionId stringnullable
    authorizationHeaderType stringnullable

    apimSubscriptionKey

    object

    decryptedValue stringnullable
    name stringnullable
    version stringnullable
    oAuthUrl stringnullable
    oAuthBody stringnullable
    oAuthClientId stringnullable

    oAuthClientSecret

    object

    decryptedValue stringnullable
    name stringnullable
    version stringnullable

    headers

    object

    nullable

    property name* string
    body stringnullable
    usePaging boolean
    useDateDelta boolean
    pagingType int32

    Possible values: [0, 1]

    nextLinkType int32

    Possible values: [0, 1]

    pathName stringnullable
    oAuthGrantType stringnullable
    oAuthUserName stringnullable

    oAuthPwd

    object

    decryptedValue stringnullable
    name stringnullable
    version stringnullable
    oAuthResource stringnullable
    oAuthScope stringnullable

    customAuthenticationProperties

    object

    nullable

    property name* string
    basicAuthenticationUserName stringnullable

    basicAuthenticationPassword

    object

    decryptedValue stringnullable
    name stringnullable
    version stringnullable
    newInternalMessageCorrelationId stringnullable
    newInternalMessagePreserveInterchangeId boolean
    useFallBackOnRequestFailed boolean
    fallBackOnThreeHoundred boolean
    fallBackOnFourHoundred boolean
    fallBackOnFiveHoundred boolean
    restConnectionPropertiesSecondary
    useStaticIp boolean
    terminateOnDuplicateDetection boolean
    duplicateTerminationStatus stringnullable

    restResponseErrorHandlingRules

    object[]

    nullable

  • Array [

    • statusCodes stringnullable
    action int32

    Possible values: [0, 1, 2]

    retry boolean
    customStatus stringnullable

  • ]

    • customTimeout int32
    useCustomTokenHeader booleannullable

    customTokenHeader

    object

    key stringnullable
    value stringnullable

  • ]

    • resendWebhooks

    object[]

    nullable

  • Array [

    • contract int32

    Possible values: [0, 1]

    endpointURL stringnullable
    httpVerb stringnullable
    webhookConnectionId stringnullable
    adapterType int32

    Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12]

    queryString stringnullable
    maxRetries int32
    timeout int32

    authorizationHeaderKey

    object

    decryptedValue stringnullable
    name stringnullable
    version stringnullable
    type int32

    Possible values: [0, 1, 2, 3, 4, 5]

    enabled boolean

    headers

    object

    nullable

    property name* string
    usePureMessageSending boolean

  • ]

    • internalLoggingOptions

    object

    logLevel int32

    Possible values: [0, 1, 2, 3, 4]

    logMessageContent booleannullable
    logMetaData booleannullable

    retryOptions

    object

    failureCountIntervalMinutes int32nullable
    reQueueMaxDelaySeconds int32nullable
    reQueueMinDelaySeconds int32nullable
    maxErrorsPerInterval int32nullable
    numberOfRetries int32nullable
    enabled boolean
    turnOffErrorPersistance boolean
    maxDelayActions int32nullable

    inboundRetryOptions

    object

    failureRetryIntervalSeconds int32nullable
    turnOffFailureRetry boolean
    retryOnNonTransientFailures boolean
    sender stringnullable
    receiver stringnullable
    messageInboundFormat stringnullable
    messageInboundEncoding stringnullable
    removeBom boolean
    handleAsBinaryFile boolean

    internalProperties

    object

    redirectInboundToRetry boolean
    redirectBatchingToRetry boolean
    redirectSplittingToRetry boolean
    stopOnEncodingError boolean
    pollingIntervalInSeconds int32
    intervalExpression stringnullable
    enabled boolean
    environment int32

    Possible values: [0, 1]

    useApiKey boolean
    archived boolean
    moved boolean
    id stringnullable
    _etag stringnullable
    cosmosEntityName stringnullable
    createdBy stringnullable
    updatedBy stringnullable
    createdAtUtc date-timenullable
    updatedAtUtc date-timenullable
Loading...