Contents x
    Import business transactions
    • 12 Mar 2024
    • 9 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Contents

    Import business transactions

    • Updated on 12 Mar 2024
    • 9 Minutes to read
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Post
    /BusinessActivityMonitoring/BusinessTransaction/Import
    Security
    API Key
    Header parameter nameAPIKey

    API key which has access for your API

    Query parameters
    BusinessProcessById
    string (uuid)
    Body parameters
    Array of object
    object
    id
    string (uuid)
    name
    string
    trackingName
    string
    description
    string
    order
    integer (int32)
    direction
    integer (int32)
    Valid values[ 1, 2, 3 ]
    stages
    Array of object (Stage)
    object
    id
    string (uuid)
    name
    string
    trackingName
    string
    eventSource
    string (uuid)
    eventSourceName
    string
    isConditional
    boolean
    markTransactionAsComplete
    boolean
    markTransactionAsFailed
    boolean
    autoCompleteConditionalStage
    boolean
    stageProperties
    Array of object (StageProperty)
    object
    id
    string (uuid)
    name
    string
    dataType
    string
    source
    integer (int32)
    Valid values[ 1, 2, 3, 4, 5 ]
    namespace
    string
    value
    string
    extractValueRegEx
    string
    isGlobalProperty
    boolean
    dateFormat
    string
    stageId
    string (uuid)
    globalPropertyId
    string (uuid)
    isIndexed
    boolean
    businessTransactionId
    string (uuid)
    reprocessConfiguration
    object (ReprocessConfiguration)
    endPointType
    integer (int32)
    Valid values[ 1, 2, 3, 4, 5, 6 ]
    eventGridSettings
    object (EventGridSettings)
    topicEndPoint
    string
    topicKey
    string
    subject
    string
    dataVersion
    string
    eventType
    string
    serviceBusSettings
    object (ServiceBusSettings)
    serviceBusConnectionString
    string
    entityName
    string
    sessionId
    string
    messageId
    string
    to
    string
    contentType
    string
    correlationId
    string
    label
    string
    replyTo
    string
    replyToSessionId
    string
    viaPartitionKey
    string
    timeToLive
    integer (int32)
    customProperties
    Array of object (StringObjectKeyValuePair)
    object
    key
    string
    value
    httpEndPointSettings
    object (HttpEndPointSettings)
    methodType
    integer (int32)
    Valid values[ 1, 2 ]
    defaultHeaders
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    uri
    string
    authorization
    object (HttpEndpointAuthorization)
    type
    integer (int32)
    Valid values[ 0, 1, 2, 3, 4 ]
    apiKeyAuth
    object (ApiKeyAuth)
    key
    string
    value
    string
    basicAuth
    object (BasicAuth)
    userName
    string
    password
    string
    bearerToken
    string
    oAuth
    object (OAuth)
    url
    string
    methodType
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    body
    string
    headers
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    queryParams
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    responseType
    integer (int32)
    Valid values[ 0, 1, 2 ]
    responseExpression
    string
    tokenPrefix
    string
    sftpEndPointSettings
    object (SftpEndPointSettings)
    host
    string
    userName
    string
    password
    string
    path
    string
    port
    integer (int32)
    azureBlobStorageSettings
    object (AzureBlobStorageSettings)
    connectionString
    string
    isCreateNewContainer
    boolean
    containerName
    string
    blobNamePrefix
    string
    businessProcessId
    string (uuid)
    defaultReprocessStageName
    string
    allowedTrackingStatusForReprocess
    Array of integer (TrackingStatus)
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    configuration
    object (Configuration)
    class
    string
    nodeDataArray
    Array of object (StageNode)
    object
    name
    string
    trackingName
    string
    key
    string
    id
    string
    category
    string
    iconPath
    string
    location
    object (NodeLocation)
    class
    string
    x
    number (float)
    y
    number (float)
    stage
    object (Stage)
    id
    string (uuid)
    name
    string
    trackingName
    string
    eventSource
    string (uuid)
    eventSourceName
    string
    isConditional
    boolean
    markTransactionAsComplete
    boolean
    markTransactionAsFailed
    boolean
    autoCompleteConditionalStage
    boolean
    stageProperties
    Array of object (StageProperty)
    object
    id
    string (uuid)
    name
    string
    dataType
    string
    source
    integer (int32)
    Valid values[ 1, 2, 3, 4, 5 ]
    namespace
    string
    value
    string
    extractValueRegEx
    string
    isGlobalProperty
    boolean
    dateFormat
    string
    stageId
    string (uuid)
    globalPropertyId
    string (uuid)
    isIndexed
    boolean
    businessTransactionId
    string (uuid)
    reprocessConfiguration
    object (ReprocessConfiguration)
    endPointType
    integer (int32)
    Valid values[ 1, 2, 3, 4, 5, 6 ]
    eventGridSettings
    object (EventGridSettings)
    topicEndPoint
    string
    topicKey
    string
    subject
    string
    dataVersion
    string
    eventType
    string
    serviceBusSettings
    object (ServiceBusSettings)
    serviceBusConnectionString
    string
    entityName
    string
    sessionId
    string
    messageId
    string
    to
    string
    contentType
    string
    correlationId
    string
    label
    string
    replyTo
    string
    replyToSessionId
    string
    viaPartitionKey
    string
    timeToLive
    integer (int32)
    customProperties
    Array of object (StringObjectKeyValuePair)
    object
    key
    string
    value
    httpEndPointSettings
    object (HttpEndPointSettings)
    methodType
    integer (int32)
    Valid values[ 1, 2 ]
    defaultHeaders
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    uri
    string
    authorization
    object (HttpEndpointAuthorization)
    type
    integer (int32)
    Valid values[ 0, 1, 2, 3, 4 ]
    apiKeyAuth
    object (ApiKeyAuth)
    key
    string
    value
    string
    basicAuth
    object (BasicAuth)
    userName
    string
    password
    string
    bearerToken
    string
    oAuth
    object (OAuth)
    url
    string
    methodType
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    body
    string
    headers
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    queryParams
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    responseType
    integer (int32)
    Valid values[ 0, 1, 2 ]
    responseExpression
    string
    tokenPrefix
    string
    sftpEndPointSettings
    object (SftpEndPointSettings)
    host
    string
    userName
    string
    password
    string
    path
    string
    port
    integer (int32)
    azureBlobStorageSettings
    object (AzureBlobStorageSettings)
    connectionString
    string
    isCreateNewContainer
    boolean
    containerName
    string
    blobNamePrefix
    string
    linkDataArray
    Array of object (StageLink)
    object
    from
    string
    to
    string
    label
    string
    visible
    boolean
    updateTransactionStatusConfiguration
    object (UpdateTransactionStatusConfiguration)
    isUpdateTransactionStatus
    boolean
    isUpdatingTransactionStatus
    boolean
    lastUpdatedAt
    string (date-time)
    from
    Array of integer (TrackingStatus)
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    to
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    value
    integer (int32)
    timeGrain
    string
    serializedConfig
    string
    purgeDays
    integer (int32)
    createdAt
    string (date-time)
    updatedAt
    string (date-time)
    status
    integer (int32)
    Valid values[ 1, 2, 3, 4 ]
    Array of object
    object
    id
    string (uuid)
    name
    string
    trackingName
    string
    description
    string
    order
    integer (int32)
    direction
    integer (int32)
    Valid values[ 1, 2, 3 ]
    stages
    Array of object (Stage)
    object
    id
    string (uuid)
    name
    string
    trackingName
    string
    eventSource
    string (uuid)
    eventSourceName
    string
    isConditional
    boolean
    markTransactionAsComplete
    boolean
    markTransactionAsFailed
    boolean
    autoCompleteConditionalStage
    boolean
    stageProperties
    Array of object (StageProperty)
    object
    id
    string (uuid)
    name
    string
    dataType
    string
    source
    integer (int32)
    Valid values[ 1, 2, 3, 4, 5 ]
    namespace
    string
    value
    string
    extractValueRegEx
    string
    isGlobalProperty
    boolean
    dateFormat
    string
    stageId
    string (uuid)
    globalPropertyId
    string (uuid)
    isIndexed
    boolean
    businessTransactionId
    string (uuid)
    reprocessConfiguration
    object (ReprocessConfiguration)
    endPointType
    integer (int32)
    Valid values[ 1, 2, 3, 4, 5, 6 ]
    eventGridSettings
    object (EventGridSettings)
    topicEndPoint
    string
    topicKey
    string
    subject
    string
    dataVersion
    string
    eventType
    string
    serviceBusSettings
    object (ServiceBusSettings)
    serviceBusConnectionString
    string
    entityName
    string
    sessionId
    string
    messageId
    string
    to
    string
    contentType
    string
    correlationId
    string
    label
    string
    replyTo
    string
    replyToSessionId
    string
    viaPartitionKey
    string
    timeToLive
    integer (int32)
    customProperties
    Array of object (StringObjectKeyValuePair)
    object
    key
    string
    value
    httpEndPointSettings
    object (HttpEndPointSettings)
    methodType
    integer (int32)
    Valid values[ 1, 2 ]
    defaultHeaders
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    uri
    string
    authorization
    object (HttpEndpointAuthorization)
    type
    integer (int32)
    Valid values[ 0, 1, 2, 3, 4 ]
    apiKeyAuth
    object (ApiKeyAuth)
    key
    string
    value
    string
    basicAuth
    object (BasicAuth)
    userName
    string
    password
    string
    bearerToken
    string
    oAuth
    object (OAuth)
    url
    string
    methodType
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    body
    string
    headers
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    queryParams
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    responseType
    integer (int32)
    Valid values[ 0, 1, 2 ]
    responseExpression
    string
    tokenPrefix
    string
    sftpEndPointSettings
    object (SftpEndPointSettings)
    host
    string
    userName
    string
    password
    string
    path
    string
    port
    integer (int32)
    azureBlobStorageSettings
    object (AzureBlobStorageSettings)
    connectionString
    string
    isCreateNewContainer
    boolean
    containerName
    string
    blobNamePrefix
    string
    businessProcessId
    string (uuid)
    defaultReprocessStageName
    string
    allowedTrackingStatusForReprocess
    Array of integer (TrackingStatus)
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    configuration
    object (Configuration)
    class
    string
    nodeDataArray
    Array of object (StageNode)
    object
    name
    string
    trackingName
    string
    key
    string
    id
    string
    category
    string
    iconPath
    string
    location
    object (NodeLocation)
    class
    string
    x
    number (float)
    y
    number (float)
    stage
    object (Stage)
    id
    string (uuid)
    name
    string
    trackingName
    string
    eventSource
    string (uuid)
    eventSourceName
    string
    isConditional
    boolean
    markTransactionAsComplete
    boolean
    markTransactionAsFailed
    boolean
    autoCompleteConditionalStage
    boolean
    stageProperties
    Array of object (StageProperty)
    object
    id
    string (uuid)
    name
    string
    dataType
    string
    source
    integer (int32)
    Valid values[ 1, 2, 3, 4, 5 ]
    namespace
    string
    value
    string
    extractValueRegEx
    string
    isGlobalProperty
    boolean
    dateFormat
    string
    stageId
    string (uuid)
    globalPropertyId
    string (uuid)
    isIndexed
    boolean
    businessTransactionId
    string (uuid)
    reprocessConfiguration
    object (ReprocessConfiguration)
    endPointType
    integer (int32)
    Valid values[ 1, 2, 3, 4, 5, 6 ]
    eventGridSettings
    object (EventGridSettings)
    topicEndPoint
    string
    topicKey
    string
    subject
    string
    dataVersion
    string
    eventType
    string
    serviceBusSettings
    object (ServiceBusSettings)
    serviceBusConnectionString
    string
    entityName
    string
    sessionId
    string
    messageId
    string
    to
    string
    contentType
    string
    correlationId
    string
    label
    string
    replyTo
    string
    replyToSessionId
    string
    viaPartitionKey
    string
    timeToLive
    integer (int32)
    customProperties
    Array of object (StringObjectKeyValuePair)
    object
    key
    string
    value
    httpEndPointSettings
    object (HttpEndPointSettings)
    methodType
    integer (int32)
    Valid values[ 1, 2 ]
    defaultHeaders
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    uri
    string
    authorization
    object (HttpEndpointAuthorization)
    type
    integer (int32)
    Valid values[ 0, 1, 2, 3, 4 ]
    apiKeyAuth
    object (ApiKeyAuth)
    key
    string
    value
    string
    basicAuth
    object (BasicAuth)
    userName
    string
    password
    string
    bearerToken
    string
    oAuth
    object (OAuth)
    url
    string
    methodType
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    body
    string
    headers
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    queryParams
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    responseType
    integer (int32)
    Valid values[ 0, 1, 2 ]
    responseExpression
    string
    tokenPrefix
    string
    sftpEndPointSettings
    object (SftpEndPointSettings)
    host
    string
    userName
    string
    password
    string
    path
    string
    port
    integer (int32)
    azureBlobStorageSettings
    object (AzureBlobStorageSettings)
    connectionString
    string
    isCreateNewContainer
    boolean
    containerName
    string
    blobNamePrefix
    string
    linkDataArray
    Array of object (StageLink)
    object
    from
    string
    to
    string
    label
    string
    visible
    boolean
    updateTransactionStatusConfiguration
    object (UpdateTransactionStatusConfiguration)
    isUpdateTransactionStatus
    boolean
    isUpdatingTransactionStatus
    boolean
    lastUpdatedAt
    string (date-time)
    from
    Array of integer (TrackingStatus)
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    to
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    value
    integer (int32)
    timeGrain
    string
    serializedConfig
    string
    purgeDays
    integer (int32)
    createdAt
    string (date-time)
    updatedAt
    string (date-time)
    status
    integer (int32)
    Valid values[ 1, 2, 3, 4 ]
    Array of object
    object
    id
    string (uuid)
    name
    string
    trackingName
    string
    description
    string
    order
    integer (int32)
    direction
    integer (int32)
    Valid values[ 1, 2, 3 ]
    stages
    Array of object (Stage)
    object
    id
    string (uuid)
    name
    string
    trackingName
    string
    eventSource
    string (uuid)
    eventSourceName
    string
    isConditional
    boolean
    markTransactionAsComplete
    boolean
    markTransactionAsFailed
    boolean
    autoCompleteConditionalStage
    boolean
    stageProperties
    Array of object (StageProperty)
    object
    id
    string (uuid)
    name
    string
    dataType
    string
    source
    integer (int32)
    Valid values[ 1, 2, 3, 4, 5 ]
    namespace
    string
    value
    string
    extractValueRegEx
    string
    isGlobalProperty
    boolean
    dateFormat
    string
    stageId
    string (uuid)
    globalPropertyId
    string (uuid)
    isIndexed
    boolean
    businessTransactionId
    string (uuid)
    reprocessConfiguration
    object (ReprocessConfiguration)
    endPointType
    integer (int32)
    Valid values[ 1, 2, 3, 4, 5, 6 ]
    eventGridSettings
    object (EventGridSettings)
    topicEndPoint
    string
    topicKey
    string
    subject
    string
    dataVersion
    string
    eventType
    string
    serviceBusSettings
    object (ServiceBusSettings)
    serviceBusConnectionString
    string
    entityName
    string
    sessionId
    string
    messageId
    string
    to
    string
    contentType
    string
    correlationId
    string
    label
    string
    replyTo
    string
    replyToSessionId
    string
    viaPartitionKey
    string
    timeToLive
    integer (int32)
    customProperties
    Array of object (StringObjectKeyValuePair)
    object
    key
    string
    value
    httpEndPointSettings
    object (HttpEndPointSettings)
    methodType
    integer (int32)
    Valid values[ 1, 2 ]
    defaultHeaders
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    uri
    string
    authorization
    object (HttpEndpointAuthorization)
    type
    integer (int32)
    Valid values[ 0, 1, 2, 3, 4 ]
    apiKeyAuth
    object (ApiKeyAuth)
    key
    string
    value
    string
    basicAuth
    object (BasicAuth)
    userName
    string
    password
    string
    bearerToken
    string
    oAuth
    object (OAuth)
    url
    string
    methodType
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    body
    string
    headers
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    queryParams
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    responseType
    integer (int32)
    Valid values[ 0, 1, 2 ]
    responseExpression
    string
    tokenPrefix
    string
    sftpEndPointSettings
    object (SftpEndPointSettings)
    host
    string
    userName
    string
    password
    string
    path
    string
    port
    integer (int32)
    azureBlobStorageSettings
    object (AzureBlobStorageSettings)
    connectionString
    string
    isCreateNewContainer
    boolean
    containerName
    string
    blobNamePrefix
    string
    businessProcessId
    string (uuid)
    defaultReprocessStageName
    string
    allowedTrackingStatusForReprocess
    Array of integer (TrackingStatus)
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    configuration
    object (Configuration)
    class
    string
    nodeDataArray
    Array of object (StageNode)
    object
    name
    string
    trackingName
    string
    key
    string
    id
    string
    category
    string
    iconPath
    string
    location
    object (NodeLocation)
    class
    string
    x
    number (float)
    y
    number (float)
    stage
    object (Stage)
    id
    string (uuid)
    name
    string
    trackingName
    string
    eventSource
    string (uuid)
    eventSourceName
    string
    isConditional
    boolean
    markTransactionAsComplete
    boolean
    markTransactionAsFailed
    boolean
    autoCompleteConditionalStage
    boolean
    stageProperties
    Array of object (StageProperty)
    object
    id
    string (uuid)
    name
    string
    dataType
    string
    source
    integer (int32)
    Valid values[ 1, 2, 3, 4, 5 ]
    namespace
    string
    value
    string
    extractValueRegEx
    string
    isGlobalProperty
    boolean
    dateFormat
    string
    stageId
    string (uuid)
    globalPropertyId
    string (uuid)
    isIndexed
    boolean
    businessTransactionId
    string (uuid)
    reprocessConfiguration
    object (ReprocessConfiguration)
    endPointType
    integer (int32)
    Valid values[ 1, 2, 3, 4, 5, 6 ]
    eventGridSettings
    object (EventGridSettings)
    topicEndPoint
    string
    topicKey
    string
    subject
    string
    dataVersion
    string
    eventType
    string
    serviceBusSettings
    object (ServiceBusSettings)
    serviceBusConnectionString
    string
    entityName
    string
    sessionId
    string
    messageId
    string
    to
    string
    contentType
    string
    correlationId
    string
    label
    string
    replyTo
    string
    replyToSessionId
    string
    viaPartitionKey
    string
    timeToLive
    integer (int32)
    customProperties
    Array of object (StringObjectKeyValuePair)
    object
    key
    string
    value
    httpEndPointSettings
    object (HttpEndPointSettings)
    methodType
    integer (int32)
    Valid values[ 1, 2 ]
    defaultHeaders
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    uri
    string
    authorization
    object (HttpEndpointAuthorization)
    type
    integer (int32)
    Valid values[ 0, 1, 2, 3, 4 ]
    apiKeyAuth
    object (ApiKeyAuth)
    key
    string
    value
    string
    basicAuth
    object (BasicAuth)
    userName
    string
    password
    string
    bearerToken
    string
    oAuth
    object (OAuth)
    url
    string
    methodType
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    body
    string
    headers
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    queryParams
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    responseType
    integer (int32)
    Valid values[ 0, 1, 2 ]
    responseExpression
    string
    tokenPrefix
    string
    sftpEndPointSettings
    object (SftpEndPointSettings)
    host
    string
    userName
    string
    password
    string
    path
    string
    port
    integer (int32)
    azureBlobStorageSettings
    object (AzureBlobStorageSettings)
    connectionString
    string
    isCreateNewContainer
    boolean
    containerName
    string
    blobNamePrefix
    string
    linkDataArray
    Array of object (StageLink)
    object
    from
    string
    to
    string
    label
    string
    visible
    boolean
    updateTransactionStatusConfiguration
    object (UpdateTransactionStatusConfiguration)
    isUpdateTransactionStatus
    boolean
    isUpdatingTransactionStatus
    boolean
    lastUpdatedAt
    string (date-time)
    from
    Array of integer (TrackingStatus)
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    to
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    value
    integer (int32)
    timeGrain
    string
    serializedConfig
    string
    purgeDays
    integer (int32)
    createdAt
    string (date-time)
    updatedAt
    string (date-time)
    status
    integer (int32)
    Valid values[ 1, 2, 3, 4 ]
    Array of object
    object
    id
    string (uuid)
    name
    string
    trackingName
    string
    description
    string
    order
    integer (int32)
    direction
    integer (int32)
    Valid values[ 1, 2, 3 ]
    stages
    Array of object (Stage)
    object
    id
    string (uuid)
    name
    string
    trackingName
    string
    eventSource
    string (uuid)
    eventSourceName
    string
    isConditional
    boolean
    markTransactionAsComplete
    boolean
    markTransactionAsFailed
    boolean
    autoCompleteConditionalStage
    boolean
    stageProperties
    Array of object (StageProperty)
    object
    id
    string (uuid)
    name
    string
    dataType
    string
    source
    integer (int32)
    Valid values[ 1, 2, 3, 4, 5 ]
    namespace
    string
    value
    string
    extractValueRegEx
    string
    isGlobalProperty
    boolean
    dateFormat
    string
    stageId
    string (uuid)
    globalPropertyId
    string (uuid)
    isIndexed
    boolean
    businessTransactionId
    string (uuid)
    reprocessConfiguration
    object (ReprocessConfiguration)
    endPointType
    integer (int32)
    Valid values[ 1, 2, 3, 4, 5, 6 ]
    eventGridSettings
    object (EventGridSettings)
    topicEndPoint
    string
    topicKey
    string
    subject
    string
    dataVersion
    string
    eventType
    string
    serviceBusSettings
    object (ServiceBusSettings)
    serviceBusConnectionString
    string
    entityName
    string
    sessionId
    string
    messageId
    string
    to
    string
    contentType
    string
    correlationId
    string
    label
    string
    replyTo
    string
    replyToSessionId
    string
    viaPartitionKey
    string
    timeToLive
    integer (int32)
    customProperties
    Array of object (StringObjectKeyValuePair)
    object
    key
    string
    value
    httpEndPointSettings
    object (HttpEndPointSettings)
    methodType
    integer (int32)
    Valid values[ 1, 2 ]
    defaultHeaders
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    uri
    string
    authorization
    object (HttpEndpointAuthorization)
    type
    integer (int32)
    Valid values[ 0, 1, 2, 3, 4 ]
    apiKeyAuth
    object (ApiKeyAuth)
    key
    string
    value
    string
    basicAuth
    object (BasicAuth)
    userName
    string
    password
    string
    bearerToken
    string
    oAuth
    object (OAuth)
    url
    string
    methodType
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    body
    string
    headers
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    queryParams
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    responseType
    integer (int32)
    Valid values[ 0, 1, 2 ]
    responseExpression
    string
    tokenPrefix
    string
    sftpEndPointSettings
    object (SftpEndPointSettings)
    host
    string
    userName
    string
    password
    string
    path
    string
    port
    integer (int32)
    azureBlobStorageSettings
    object (AzureBlobStorageSettings)
    connectionString
    string
    isCreateNewContainer
    boolean
    containerName
    string
    blobNamePrefix
    string
    businessProcessId
    string (uuid)
    defaultReprocessStageName
    string
    allowedTrackingStatusForReprocess
    Array of integer (TrackingStatus)
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    configuration
    object (Configuration)
    class
    string
    nodeDataArray
    Array of object (StageNode)
    object
    name
    string
    trackingName
    string
    key
    string
    id
    string
    category
    string
    iconPath
    string
    location
    object (NodeLocation)
    class
    string
    x
    number (float)
    y
    number (float)
    stage
    object (Stage)
    id
    string (uuid)
    name
    string
    trackingName
    string
    eventSource
    string (uuid)
    eventSourceName
    string
    isConditional
    boolean
    markTransactionAsComplete
    boolean
    markTransactionAsFailed
    boolean
    autoCompleteConditionalStage
    boolean
    stageProperties
    Array of object (StageProperty)
    object
    id
    string (uuid)
    name
    string
    dataType
    string
    source
    integer (int32)
    Valid values[ 1, 2, 3, 4, 5 ]
    namespace
    string
    value
    string
    extractValueRegEx
    string
    isGlobalProperty
    boolean
    dateFormat
    string
    stageId
    string (uuid)
    globalPropertyId
    string (uuid)
    isIndexed
    boolean
    businessTransactionId
    string (uuid)
    reprocessConfiguration
    object (ReprocessConfiguration)
    endPointType
    integer (int32)
    Valid values[ 1, 2, 3, 4, 5, 6 ]
    eventGridSettings
    object (EventGridSettings)
    topicEndPoint
    string
    topicKey
    string
    subject
    string
    dataVersion
    string
    eventType
    string
    serviceBusSettings
    object (ServiceBusSettings)
    serviceBusConnectionString
    string
    entityName
    string
    sessionId
    string
    messageId
    string
    to
    string
    contentType
    string
    correlationId
    string
    label
    string
    replyTo
    string
    replyToSessionId
    string
    viaPartitionKey
    string
    timeToLive
    integer (int32)
    customProperties
    Array of object (StringObjectKeyValuePair)
    object
    key
    string
    value
    httpEndPointSettings
    object (HttpEndPointSettings)
    methodType
    integer (int32)
    Valid values[ 1, 2 ]
    defaultHeaders
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    uri
    string
    authorization
    object (HttpEndpointAuthorization)
    type
    integer (int32)
    Valid values[ 0, 1, 2, 3, 4 ]
    apiKeyAuth
    object (ApiKeyAuth)
    key
    string
    value
    string
    basicAuth
    object (BasicAuth)
    userName
    string
    password
    string
    bearerToken
    string
    oAuth
    object (OAuth)
    url
    string
    methodType
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    body
    string
    headers
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    queryParams
    Array of object (DefaultHeaders)
    object
    key
    string
    value
    isSensitive
    boolean
    id
    string (uuid)
    responseType
    integer (int32)
    Valid values[ 0, 1, 2 ]
    responseExpression
    string
    tokenPrefix
    string
    sftpEndPointSettings
    object (SftpEndPointSettings)
    host
    string
    userName
    string
    password
    string
    path
    string
    port
    integer (int32)
    azureBlobStorageSettings
    object (AzureBlobStorageSettings)
    connectionString
    string
    isCreateNewContainer
    boolean
    containerName
    string
    blobNamePrefix
    string
    linkDataArray
    Array of object (StageLink)
    object
    from
    string
    to
    string
    label
    string
    visible
    boolean
    updateTransactionStatusConfiguration
    object (UpdateTransactionStatusConfiguration)
    isUpdateTransactionStatus
    boolean
    isUpdatingTransactionStatus
    boolean
    lastUpdatedAt
    string (date-time)
    from
    Array of integer (TrackingStatus)
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    to
    integer (int32)
    Valid values[ 0, 1, 2, 3 ]
    value
    integer (int32)
    timeGrain
    string
    serializedConfig
    string
    purgeDays
    integer (int32)
    createdAt
    string (date-time)
    updatedAt
    string (date-time)
    status
    integer (int32)
    Valid values[ 1, 2, 3, 4 ]
    Responses
    200

    Success

    Was this article helpful?
    What's Next