Getting status information for a specific product linked with Common Services

Ops Center Common Services REST API Reference Guide

Version
10.9.x
File Size
533 KB
Audience
anonymous
Part Number
MK-99OPS003-06
The following request gets status information for a specific product linked with Common Services.

Execution permission

None.

Request line

GET base-URL/app/v1/application-services/object-ID-of-the-product/status

Request message

Object ID of the product

Specify the value of id acquired by using the request for getting information about the products linked with Common Services.

Attribute

Type

Description

id

string

(Required) Object ID of the product

Query parameters
None.
Body
None.

Response message

Body
{
    "connectionStatus" : "ONLINE",
    "trustRelationshipStatus" : "ESTABLISHED"
}

Attribute

Type

Description

connectionStatus

string

Status of connection with Common Services

  • ONLINE: Connected
  • OFFLINE: Not connected

trustRelationshipStatus

string

Single sign-on status

  • ESTABLISHED: Single sign-on is possible.
  • NOT_ESTABLISHED: Single sign-on is not possible.
  • NOT_SUPPORTED: The single sign-on function is not supported.
  • UNKNOWN: The status of the single sign-on setting is unknown.

Coding example

curl -v -X GET -s "https://example.com:443/portal/app/v1/application-services/8a11a1bf6d7012db016dd878c5e50001/status" -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.)