Getting a list of products linked with Common Services

Ops Center Common Services REST API Reference Guide

Version
10.7.x
File Size
577 KB
Audience
anonymous
Part Number
MK-99OPS003-03
The following request gets a list of products linked with Common Services.

Execution permission

None.

Request line

GET base-URL/app/v1/application-services

Request message

Object ID
None.
Query parameters
None.
Body
None.

Response message

Body
[
    {
        "id": "8a11b0f56d3cf1ac016d3d4f36490004",
        "type": "DATA_INSTANCE_DIRECTOR",
        "displayType": "Hitachi Ops Center Protector",
        "abbreviatedDisplayType": "Protector",
        "name": "example.com",
        "description": "Copy-data management",
        "scheme": "https",
        "hostname": "example.com",
        "port": 20964,
        "baseUri": "https://example.com:20964",
        "loginScreenUri": "https://example.com:20964/#/SSO/opscenter",
        "licenseRegistrationScreenUri": "https://example.com:20964?target=%23%2FLicenses#/SSO/opscenter",
        "authorizationManagementScreenUri": "https://example.com:20964?target=%23%2FAccessControl#/SSO/opscenter",
        "clientConfigurationUri": "https://example.com:20964/HDID/master/AuthenticationHandler/objects/OIDCClientConfiguration/opscenter",
        "oidcEnabled": true,
        "oidcRedirectUris": [
            "https://example.com:20964/*"
        ],
        "internalVersion": 1,
        "statusCheckDisabled": false
    },
    {
        "id": "8a11a1bf6d7012db016dd878c5e50001",
        "type": "AUTOMATOR",
        "displayType": "Hitachi Ops Center Automator",
        "abbreviatedDisplayType": "Automator",
        "name": "example.com",
        "description": "",
        "scheme": "https",
        "hostname": "example.com",
        "port": 22016,
        "baseUri": "https://example.com:22016/Automation",
        "loginScreenUri": "https://example.com:22016/Automation/login",
        "licenseRegistrationScreenUri": "https://example.com:22016/Automation/license.htm",
        "authorizationManagementScreenUri": "https://example.com:22016/Automation/main.htm?module=administrations",
        "clientConfigurationUri": "https://example.com:22016/Automation/v1/application/ClientConfigurations",
        "oidcEnabled": true,
        "oidcRedirectUris": [
            "https://example.com:22016/Automation/callback"
        ],
        "internalVersion": 1,
        "statusCheckDisabled": false
    }
]

Attribute

Type

Description

id

string

Object ID of the product

type

string

Product type

displayType

string

Display type

abbreviatedDisplayType

string

Product abbreviation

name

string

Product name

description

string

Description of the product

scheme

string

Communication protocol

  • http
  • https

hostname

string

Host name of the server running the product

port

int

Port number of the product

baseUri

string

Base URI of the product

loginScreenUri

string

URI of the login screen for the product

licenseRegistrationScreenUri

string

URI of the license registration screen for the product

authorizationManagementScreenUri

string

URI of the authorization management screen for the product

clientConfigurationUri

string

URI of the configuration screen for the product

oidcEnabled

boolean

Whether single sign-on can be used

  • true: Can be used
  • false: Cannot be used

oidcRedirectUris

string[]

Redirect URI

internalVersion

int

Internal version of the product

statusCheckDisabled

boolean

Whether to use Common Services to check the product's heartbeat

  • true: Do not check the product's heartbeat
  • false: Check the product's heartbeat

Coding example

curl -v -X GET -s "https://example.com:443/portal/app/v1/application-services" -H "Authorization:Bearer eyJhbxxx"
Tip: Because this request uses SSL communication, you must either run the curl command with the root certificate of the Common Services server certificate specified for the --cacert option, or run the command with the -k option specified. (The -k option runs the command by ignoring SSL errors.)