IBM DataPower Operations Dashboard v1.0.8.0
A newer version of this product documentation is available.
You are viewing an older version. View latest at IBM DPOD Documentation.
JSON fields
- Copy Page Tree
- Former user (Deleted)
This section describes the fields of the wiki service's JSON request. For more details on how the JSON requests are created see Update Wiki service JSON (Deprecated).
All fields have values.
Service (item)
This section describes the service, it occurs once.
Field | Type | Description |
|---|---|---|
Service Name | Text | Technical name of the service, as defined in the DataPower Gateway |
Business Name | Text | User-supplied value. The business name of the service in the organization |
Description & Summary | Text | User-supplied value. Description of the service. DEFAULT_USER_VALUE |
Technology Type | Multi-Choice: “SOAP Web Service”, “RESTFul Web Service”, “JMS/MQ” | User-supplied value. The main technology used by this service to receive requests. DEFAULT_USER_VALUE |
Service Status | Multi-Choice: “Request”, “Active”, “Ready for Testing”, “Ready for Prod”, “Deprecated”, “Canceled” | User-supplied value. |
Planned Blackout Periods | Text | User-supplied DEFAULT_USER_VALUE |
Exposed To Network | Multi-Choice: “Internet, Internet DMZ”, “Production network”, “Intranet”, “Management network” | User-supplied value. The network this service is exposed to. DEFAULT_USER_VALUE |
Contacts (Fixed list of 3 items, key = role)
This is a list of the personnel contacts who manage the service or are involved in its maintenance. It is a fixed 3-item list, where each item is one of 3 different roles (each role appears once).
Field | Type | Description |
|---|---|---|
Role (key) | Single Select: “Business Owner”, “Technical Owner”, “Technical Support” | The role of the contact |
Name | Text | Contact name |
Phone Number | Text | Contact phone number |
Cell Number | Text | Contact cellphone number |
Email Address | Text | Contact email address |
Environments (List)
A list of service environments. DPOD identifies situations in which the same service – identified by the DataPower service name – is hosted by different DataPower Gateways or on different domains. In such cases, each service instance will be represented by separate an “Environments” section in a single JSON request. If the service has a single instance, there will only be one item on the Environments list.
Field | Type | Description |
|---|---|---|
Name | Multi Select: “Development”, “Testing”, “Staging”, “Production” | User-supplied value. The environment of this service instance. DEFAULT_USER_VALUE |
Domain | Text | Domain of service instance. |
Device | Text | Device of service instance |
Frontend Protocol | Text | Front end protocol of this service instance. |
Calculated Frontend URL | Text | When there is a proxy (e.g. load-balancer) directing traffic to the DataPower Gateway, this will be the proxy URL. |
WDP Frontend URL | URI | The front-end URL of the service instance on the DataPower Gateway |
LoadBalancer \ Proxy Name | Text | LoadBalancer \ Proxy Name IPs or hostnames |
FrontendContextURL | Text | Front-end URI context. |
Frontend Ports | Text | TCP ports for the front-end service |
is Protected by SSL | Boolean | Whether the service is protected by SSL (true) or not (false) |
is SSL Client Certificate | Boolean | Whether the service require client authentication with a certificate (true) or not (false) |
DataPower WSDL | Text | URL of the the service instance WSDL on DataPower |
Request Schema Validation | Boolean | Whether the service validate request messages against a schema (true) or no validation (false) |
Response Schema Validation | Boolean | Whether the service validate response messages against a schema (true) or no validation (false) |
Payload Request Type | Single Select: “SOAP”, “XML”, “JSON”, “NON-XML” | Type of the request payload handled by the service instance |
Payload Response Type | Single Select: “SOAP”, “XML”, “JSON”, “NON-XML” | Type of the response payload handled by the service instance |
Dynamic Provider(BE) URL | Text | Dynamic provider URL, if derived dynamically
|
Provider URL | Text | The provider URL, as statically defined in the service instance |
ProviderContextURL | Text | Provider URI context/ |
Provider Ports | Text | Provider TCP ports |
Version | Text | User-supplied value for the service instance version. DEFAULT_USER_VALUE |
Consumers (List, key=IP)
This list describes consumers for the DataPower service. Each item represents a single consumer.
Field | Type | Description |
|---|---|---|
Application Name | Technical Author Managed List | User-supplied value. Name of consumer application DEFAULT_USER_VALUE |
Platform | Technical Author Managed List - >NET, Java, CICS | User-supplied value. Consumer application platform. DEFAULT_USER_VALUE |
Contacts Details | Text | User-supplied value. Contact details for this consumer. DEFAULT_USER_VALUE |
Contact Name | Text | User-fillsupplieded value. Contact name for this consumer. DEFAULT_USER_VALUE |
Security (item)
Describes the security requirements for the DataPower service.
Field | Type | Description |
|---|---|---|
Authentication Mechanism | Value list | User-supplied value. DEFAULT_USER_VALUE |
Encryption Required | Boolean | User-supplied value. Whether encryption is required (true) or not (false). DEFAULT_USER_VALUE |
Verify Required | Boolean | User-supplied value. Whether signature verification is required. DEFAULT_USER_VALUE |
Antivirus Required | Boolean | User-supplied value. Whether the service performs antivirus checks on requests (true) or not (false) DEFAULT_USER_VALUE |
Last Penetration Test | Date | User-supplied value. Last penetration test date. DEFAULT_USER_VALUE |
Provider (item)
This section describes the back-end provider for the DataPower service.
Field | Type | Description |
|---|---|---|
Platform | Value list | User-supplied value. Provider technical platform. DEFAULT_USER_VALUE |
Application Name | Text - Technical Author Managed List | User-supplied value. DEFAULT_USER_VALUE |
Application Code | Text | User-supplied value. DEFAULT_USER_VALUE |
Development (item)
This section can be used to add files and samples relevant for development of the DataPower service.
Field | Type | Description |
|---|---|---|
Sample Request | Text | User-supplied value. Sample request for the DataPower service. DEFAULT_USER_VALUE |
Sample Response | Text | User-supplied value. Sample response for the DataPower service. DEFAULT_USER_VALUE |
Attachments | File Upload (List up to 5) | User-supplied value. Various attachments useful for development. DEFAULT_USER_VALUE |