/
REST API Overview

IBM DataPower Operations Dashboard v1.0.22.x

REST API Overview

Owned by Amit Munwes
Sept 30, 2024
3 min read

Authorization

Use Basic Authentication to authenticate when invoking APIs.

It is recommended to review the Role Based Access Control page for understanding the use of built-in and custom roles for authorization in DPOD.

To authenticate when using curl, see the following example:

curl -u username:password https://<DPOD-host-name>/op/api/...

Successful Response

All successful responses include the following fields:

Name

Required/Optional

Description

Type

Available Options

Name

Required/Optional

Description

Type

Available Options

resultCode

Required

The REST API result code.

String

 

resultMessage

Required

The REST API result message.

String

Human-friendly result message.

result

Optional

The REST API result element.

Element

Each REST API describes the relevant fields.

Error Response

All error responses include the following fields:

Name

Required/Optional

Description

Type

Available Options

Name

Required/Optional

Description

Type

Available Options

resultCode

Required

The REST API result code.

String

 

resultErrorCode

Required

The REST API result error code.

String

Machine-readable code indicating the error that has occurred.

resultMessage

Required

The REST API result message.

String

Human-friendly result message.

Search Request

All search requests include the following fields:

Name

Required/Optional

Description

Type

Available Options

Name

Required/Optional

Description

Type

Available Options

pagingDto

Optional

Navigate between a set of search results.

Element

 

pagingDto.pagingMinRecordNum

Required

Specifies the minimum record number to fetch.

Long

 

pagingDto.pagingMaxRecordNum

Required

Specifies the maximum record number to fetch.

Long

 

sortDto

Optional

Sort criteria for the search results.

Element

 

sortDto.sortableField

Required

Specifies the sorting field.

String

Each REST API describes the relevant available fields.

sortDto.sortAttribute

Required

Specifies the sorting order.

String

  • ASC

  • DESC

filters

Optional

Filter criteria for the search results.

Array of Elements

 

filters[].filterField

Required

Specifies the filter field name.

String

Each REST API describes the relevant available fields.

filters[].filterOperator

Required

Specifies the filter field operator.

String

  • EQUALS

  • NOT_EQUALS

  • GREATER_THAN

  • GREATER_EQUALS

  • LESS_EQUALS

  • LESS_THAN

Note: The filters GREATER_* and LESS_* are relevant only for numeric fields.

filters[].timeRangeValue

Optional

Specifies the filter time range.

Element

See Time Range Value Element.

filters[].stringValues

Required

Specifies the filter values.

Array of Strings

 

Time Range Value Element

Some APIs include the Time Range Filter which contains the following fields:

Name

Required/Optional

Description

Type

Available Options

Name

Required/Optional

Description

Type

Available Options

timeRangeType

Required

The time range type.

String

  • all

  • recent

  • custom

  • today

  • this_week

  • this_month

  • yesterday

  • last_week

  • last_month

recentPeriodInMillis

Optional

The recent period in milliseconds.
Only required when the time range type is recent.

Long

 

timeRangeStart

Optional

The custom start date.
Only required when the time range type is custom.

Long (milliseconds from epoch)

 

timeRangeEnd

Optional

The custom end date.
Only required when the time range type is custom.

Long (milliseconds from epoch)

 

Index Sets and Related Document Types

All available index sets and document types used to add / edit reports and alerts:

Index Set

Related Document Type

Description

Supported Product View

Index Set

Related Document Type

Description

Supported Product View

wdp-syslog

WDP_SYSLOG

Syslog Records

  • IDG

  • APIC

wdp-syslog-sys-error

WDP_SYSLOG

Syslog Records

  • IDG

  • APIC

wdp-syslog-sys-auth

WDP_SYSLOG

Syslog Records

  • IDG

  • APIC

wdp-syslog-sys-default

WDP_SYSLOG

Syslog Records

  • IDG

  • APIC

wdp-wsm

WDP_WSM

WS-M Records

  • IDG

  • APIC

API_PROBE_TRANSACTION

API Probe Transaction

  • APIC

PROBE_TRANSACTION

Probe Transaction

  • IDG

wdp-device-resources

WDP_DEVICE_RESOURCES

Device Resources

  • IDG

  • APIC

RESTART_DATA

Restart Data

  • IDG

  • APIC

WDP_OBJECTS_STATUS

Object Status

  • IDG

  • APIC

wdp-service-resources

WDP_SERVICE_RESOURCES

Service Resources

  • IDG

WDP_MQ_OBJECT_STATS

WDP MQ Object Stats

  • IDG

wdp-config-service

WDP_CONFIG_SERVICE

Service Config

  • IDG

WDP_CONFIG_CHANGE

Config Change

  • IDG

WDP_CONFIG_FSHBE

FSH Config

  • IDG

WDP_CONFIG_DEVICE

Device Config

  • IDG

WDP_CONFIG_DOMAIN

Domain Config

  • IDG

WDP_CONFIG_B2B_PARTNER

B2B Partner Config

  • IDG

WDP_CONFIG_B2B_PARTNER_DESTINATION

B2B Partner Dest Config

  • IDG

apic-log

APIC_LOGICAL_TRANS

API-C Transaction

  • APIC

logical-tran-compact

WDP_LOGICAL_TRANS

Transaction

  • IDG

WDP_LOGICAL_TRANS_CHILD

Child Transaction

  • IDG

internal-operations

FLUME_STATISTICS

Agent Statistics

  • IDG

  • APIC

LOGTARGET_STATISTICS

Log Target Statistics

  • IDG

  • APIC

WSMAGENT_STATISTICS

WS-M Agent Statistics

  • IDG

  • APIC

NODES_HEALTH_STATISTICS

Store Node Health Statistics

  • IDG

  • APIC

ALERT_EXECUTION_RESULT

Alert Execution Results

  • IDG

  • APIC

INTERNAL_ALERTS_SENT

Internal Alerts Sent

  • IDG

  • APIC

system-health

DEVICE_HEALTH_METRIC

Device Health Metric

  • IDG

  • APIC

apic-analytics

APIC_ANALYTICS

API-C Analytics

  • APIC

long-term-stats

LONG_TERM_STATS_EXECUTION

Long Term Stats Execution

  • IDG

  • APIC

API_LONG_TERM_STATS

API Long Term Stats

  • APIC

SERVICE_LONG_TERM_STATS

Service Long Term Stats

  • IDG

Copyright © 2015 MonTier Software (2015) Ltd.