Versions Compared

Old Version 9

changes.mady.by.user Sara Weisz

Saved on

compared with

New Version Current

changes.mady.by.user Sara Weisz

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this page:

Table of Contents
maxLevel1
minLevel1
include
outlinefalse
indent
exclude
styledisc
typelist
printabletrue
class

Status
colourYellow
titlePOST

...

Search for Probe Captures

{
Expand
title/op/api/v2/probeCaptures/search

Description:

This API retrieves all performs a search for probe captures.

Required Roles:

  • There shouldn’t be defined a is no custom role that denies access to “Manage Probe“ and there is a .

  • And one of the following:

    • A custom role that

    permits access or a built-in role OpDashAdminRole

    • allows access to “Manage Probe“.

    • The OpDashAdminRole builtin role.

URI:

/op/api/v2/probeCaptures/search

Request:

The request should use the

Status
colourYellow
titlePOST
method with the following fields in its body:

Name

Required/Optional

Description

Type

Available Options

filterspagingDto

OptionalRequired

Filter Navigate between a set of search results. For further details see Search Request.

Element

filters

Optional

Filter criteria for the search results. For further details see Search Request.

Element

filters[].filterfield

Required

Specifies the filter field name.

String

  • DPOD_DEVICE_NAME

  • DPOD_DOMAIN_NAME

  • DPOD_SERVICE_NAME

  • DPOD_API_PROBE_CAPTURE_ID

  • DPOD_API_PROBE_CAPTURE_STATUS

filters[filterfield=DPOD_API_PROBE_CAPTURE_STATUS].stringValues

Required

The maximum number of records to allowstatus of the probe.

StringArray of Strings

  • ACTIVE

  • STOPPING

  • COMPLETED

  • ABORTED

pagingDto

Required

Navigate between a set of search results. For further details see Search Request.

Element

Example:

Code Block
{
  "pagingDto": {
    "pagingMinRecordNum": 1,
    "pagingMaxRecordNum": 100
  },
  "filters": [
    {
      "filterField": "DPOD_DEVICE_NAME",
      "filterOperator": "EQUALS",
      "stringValues": [
        "idg_10_6_0_a"
      ]
    },
    {
      "filterField": "DPOD_DOMAIN_NAME",
      "filterOperator": "EQUALS",
      "stringValues": [
        "BankA_Domain"
      ]
    },
    {
      "filterField": "DPOD_SERVICE_NAME",
      "filterOperator": "EQUALS",
      "stringValues": [
        "YellowPagesService.WSP"
      ]
    },
    {
      "filterField": "DPOD_API_PROBE_CAPTURE_ID",
      "filterOperator": "EQUALS",
      "stringValues": [
        "f5940035-9c29-4e25-8b96-0fe76ecc947c"
      ]
    },
    {
      "filterField": "DPOD_API_PROBE_CAPTURE_STATUS",
      "filterOperator": "EQUALS",
      "stringValues": [
        "ACTIVE"
      ]
    }
  ]
}

Successful Response:

The response includes the following fields in its body result element:

Name

Description

Type

Available Options

totalResultsCount

The total number of records.

Long

results

Array of Element

results[].id

The id ID of the record in the Databaseprobe capture.

Long

results[].captureId

The id for a transaction ID of the probe capture in the DataPower gateway.

String

results[].deviceName

The device name from which the debug probe data was captured.

String

results[].domainName

The domain name from which the debug probe data was captured.

String

results[].serviceName

The service name from which the debug probe data was captured.

String

results[].captureCount

The number of transactions to capture.

Long

results[].capturedTransactions

The number of captured transactions.

Long

results[].userName

The user name who created the probe capture.

String

results[].startTimeInMill

When the probe capture started.

Long

results[].endTimeInMill

When the probe capture finished.

Long

results[].captureStatushttpHeaderName

The capture statustransaction HTTP header name.

String

  • ACTIVE

  • STOPPING

  • COMPLETED

  • ABORTED

Example:

Code Block

results[].clientIp

The transaction client IP.

String

results[].fullUri

The transaction full URI.

String

results[].captureStatus

The probe capture status.

String

  • ACTIVE

  • STOPPING

  • COMPLETED

  • ABORTED

Example:

Code Block
{
    "resultCode": "SUCCESS",
    "resultMessage": "Probe captures retrieved successfully",
    "result": {
        "totalResultsCount": 1,
        "results": [
            {
                "id": 151,
                "captureId": "f5940035-9c29-4e25-8b96-0fe76ecc947c",
                "deviceName": "idg_10_6_0_a",
                "domainName": "BankA_Domain",
                "serviceName": "YellowPagesService.WSP",
                "captureCount": 10,
                "capturedTransactions": 10,
                "userName": "admin",
                "startTimeInMill": 1727249223659,
                "endTimeInMill": 1727249593870,
                "captureStatus": "COMPLETED"
            }
        ]
    }
}

Status
colourGreen
titleGET
Get

...

a Probe Capture

...

Expand
title/op/api/v2/probeCapture/{{probeCaptureId}}

Description:

This API retrieves a specific probe capture.

Required Roles:

  • There shouldn’t be defined a is no custom role that denies access to “Manage Probe“ and there is a .

  • And one of the following:

    • A custom role that

    permits access or a built-in role OpDashAdminRole.
URI

    • allows access to “Manage Probe“.

    • The OpDashAdminRole builtin role.

URI:

/op/api/v2/probeCapture/{{probeCaptureId}}

Request:

The request should use the

Status
colourGreen
titleGET
method with the following URL parameters:

Name

Required/Optional

Description

Type

Available Options

probeCaptureId

Required

The probe capture id (can be retrieved from “Retrieved all probe captures” response)ElementID.

Long

Successful Response:

The response includes the following fields in its body result element:

Name

Description

Type

Available Options

id

The id ID of the record in the Databaseprobe capture.

Long

captureId

The id for a transaction ID of the probe capture in the DataPower gateway.

String

deviceName

The device name from which the debug probe data was captured.

String

domainName

The domain name from which the debug probe data was captured.

String

serviceName

The service name from which the debug probe data was captured.

String

captureCount

The number of transactions to capture.

Long

capturedTransactions

The number of captured transactions.

Long

userName

The user name who created the probe capture.

String

startTimeInMill

When the probe capture started.

Long

endTimeInMill

When the probe capture finished.

Long

captureStatushttpHeaderName

The capture statustransaction HTTP header name.

String

  • ACTIVE

  • STOPPING

    • clientIp

    The transaction client IP.

    String

    fullUri

    The transaction full URI.

    String

    captureStatus

    The probe capture status.

    String

    • ACTIVE

    • STOPPING

    • COMPLETED

    • ABORTED

    Example:

    Code Block
    {
    "resultCode": "SUCCESS",
    "resultMessage": "Probe capture retrieved successfully",
    "result": {
        "id": 151,
        "captureId": "f5940035-9c29-4e25-8b96-0fe76ecc947c",
        "deviceName": "idg_10_6_0_a",
        "domainName": "BankA_Domain",
        "serviceName": "YellowPagesService.WSP",
        "captureCount": 10,
        "capturedTransactions": 10,
        "userName": "admin",
        "startTimeInMill": 1727249223659,
        "endTimeInMill": 1727249593870,
        "captureStatus": "COMPLETED"
    }
}

    Status
    colourYellow
    titlePOST
    Add Probe

    ...

    Captures

    Expand
    title/op/api/v2/ProbeCaptures/probeCaptures

    Description:

    This API adds probe captures.

    Required Roles:

    • There shouldn’t be defined a is no custom role that denies access to “Manage Probe“ and there is a .

    • And one of the following:

      • A custom role that

      permits access or a built-in role OpDashAdminRole

      • allows access to “Manage Probe“.

      • The OpDashAdminRole builtin role.

    URI:

    /op/api/v2/probeCaptures/

    Request:

    The request should use the

    Status
    colourYellow
    titlePOST
    method with the following fields in its body:

    Name

    Required/Optional

    Description

    Type

    Available Options

    deviceNames

    Required

    The device names on which to create a probe capture.

    Array of Strings

    Supports wildcards

    deviceNamesOperator

    Required

    The device names operator.

    String

    • eq

    domainNames

    Required

    The domain names on which to create a probe capture.

    Array of Strings

    Supports wildcards

    domainNamesOperator

    Required

    The domain names operator.

    String

    • eq

    serviceNames

    Required

    The service names on which to create a probe capture.

    Array of Strings

    Supports wildcards

    serviceNameOperator

    Required

    The service names operator.

    Array of Strings

    • eq

    durationInMinutes

    Required

    the The duration in minutes to capture.

    Long

    Positive number

    captureCount

    Required

    The number of transactions to capture.

    Long

    Number between 10 - 200

    interval

    Optional

    The interval in seconds between which the data for two consecutive transactions can be captured.

    Long

    Number between 1 - 3600

    additionalFiltersParameters

    Optional

    Probe Filterstransaction filters.

    Element

    additionalFiltersParameters.httpHeaderName

    Optional

    Filter transactions by the HTTP header name.

    String

    additionalFiltersParameters.clientInUri

    Optional

    Filter transactions by the client IP address.

    String

    additionalFiltersParameters.clientIp

    Optional

    Filter transactions by the request URI path.

    String

    Example:

    Code Block
    {
    "deviceNames": ["idg_10_6_0_a"],
    "deviceNamesOperator": "eq",
    "domainNames": ["BankA_Domain"],
    "domainNamesOperator": "eq",
    "serviceNames": ["YellowPagesService.WSP"],
    "serviceNameOperator": "eq",
    "durationInMinutes": 60,
    "captureCount": 15,
    "interval": 1,
    "additionalFiltersParameters": {
        "httpHeaderName": "",
        "clientInUri": "",
        "clientIp": ""
    }
}

    Successful Response:

    The response includes the following fields in its body result element:

    Name

    Description

    Type

    Available Options

    probeCaptures

    The probe captures that have been created.

    Array of ElementElements

    probeCaptures[].id

    The id ID of the record in the Databaseprobe capture.

    Long

    probeCaptures[].captureId

    The id for a transaction ID of the probe capture in the DataPower gateway.

    String

    probeCaptures[].deviceName

    The device name from which the debug probe data was captured.

    String

    probeCaptures[].domainName

    The domain name from which the debug probe data was captured.

    String

    probeCaptures[].serviceName

    The service name from which the debug probe data was captured.

    String

    probeCaptures[].captureCount

    The number of transactions to capture.

    Long

    probeCaptures[].capturedTransactions

    The number of captured transactions.

    Long

    probeCaptures[].userName

    The user name who created the probe capture.

    String

    probeCaptures[].startTimeInMill

    When the probe capture started.

    Long

    probeCaptures[].endTimeInMill

    When the probe capture finished.

    probeCaptures[].httpHeaderName

    The transaction HTTP header name.

    String

    probeCaptures[].clientIp

    The transaction client IP.

    String

    probeCaptures[].fullUri

    The transaction full URI.

    String

    probeCaptures[].captureStatus

    The probe capture status.

    String

    • ACTIVE

    • STOPPING

    • COMPLETED

    • ABORTED

    probeCaptures[].resultCode

    The REST API probe capture creation result code.

    String

    • SUCCESS

    • WARNING

    • ERROR

    probeCaptures[].resultMessage

    The REST API probe capture creation result message.

    String

    Example:

    Code Block
    {
    "resultCode": "SUCCESS",
    "resultMessage": "All probe captures created successfully",
    "result": {
        "probeCaptures": [
            {
                "id": 155,
                "captureId": "7a8c48a8-bc1c-4459-9a77-0fe76ecca35b",
                "deviceName": "idg_10_6_0_a",
                "domainName": "BankA_Domain",
                "serviceName": "YellowPagesService.WSP",
                "captureCount": 15,
                "capturedTransactions": 0,
                "userName": "admin",
                "startTimeInMill": 1727262911381,
                "captureStatus": "ACTIVE",
                "resultCode": "SUCCESS",
                "resultMessage": "Probe capture created successfully"
            }
        ]
    }
}

    Status
    colourRed
    titleDELETE
    Delete a Probe Capture

    Expand
    title/op/api/v2/probeCapture/{{apiProbeCaptureId}}

    Description:

    This API deletes a specific probe captureAPI marks a specific probe capture for deletion (with a status of STOPPING).
    A background process will delete the probe capture from the DataPower gateway and will change its status to STOPPED once it is deleted.

    Required Roles:

    • There shouldn’t be defined a is no custom role that denies access to “Manage Probe“ and there is a .

    • And one of the following:

      • A custom role that

      permits access or a built-in role OpDashAdminRole

      • allows access to “Manage Probe“.

      • The OpDashAdminRole builtin role.

    URI:

    /op/api/v2/probeCapture/{{probeCaptureId}}

    Request:

    The request should use the

    Status
    colourRed
    titleDELETE
    method with the following URL parameters:

    Name

    Required/Optional

    Description

    Type

    Available Options

    probeCaptureId

    Required

    The probe capture id (can be retrieved from “Retrieved all probe captures” response)ElementID.

    Long

    Successful Response:

    Example:

    Code Block
    {
    "resultCode": "SUCCESS",
    "resultMessage": "Probe capture is stopping"
}