REST API for Oracle Insurance Policy Administration - Service Layer - Get liveness of PASJava/PASService/CycleService

Get liveness of PASJava/PASService/CycleService

get

/PASService/rest/services/v1/health/liveness

Get liveness of PASJava/PASService/CycleService

Request

There are no request parameters for this operation.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

successful operation

Root Schema : schema

Type: object

Show Source

checks: array checks
status: string

Allowed Values: [ "UP", "DOWN" ]
timestamp: string (date-time)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "enum":[
                "UP",
                "DOWN"
            ]
        },
        "timestamp":{
            "type":"string",
            "format":"date-time"
        },
        "checks":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "status":{
                        "type":"string",
                        "enum":[
                            "UP",
                            "DOWN"
                        ]
                    },
                    "server":{
                        "type":"string"
                    },
                    "hostname":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : checks

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "status":{
                "type":"string",
                "enum":[
                    "UP",
                    "DOWN"
                ]
            },
            "server":{
                "type":"string"
            },
            "hostname":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

hostname: string
server: string
status: string

Allowed Values: [ "UP", "DOWN" ]

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "enum":[
                "UP",
                "DOWN"
            ]
        },
        "server":{
            "type":"string"
        },
        "hostname":{
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Examples

Returns a JSON with all LIVE checks for All services that accepts HTTP/HTTPS requests for PASJava.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl \
    -X GET \
    -H "Content-Type: application/json" \
    -u 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' \
    -L "http://server:port/PASService/rest/services/v1/health/liveliness \"

Example Response Body

The following shows an example of the response body in JSON format for PASJava/PASService/CycleService:

The following shows an example of the response body in JSON format for PASJava:

{
  "status": "UP",
  "timestamp": "2025-05-07T12:00:00Z",
  "checks": [
    {
      "server": "Server Name1",
      "status": "UP",
      "host": "linux server name"
    }
  ]
}

The following shows an example of the response body in JSON format for PASService:

{
  "status": "UP",
  "timestamp": "2025-05-07T12:00:00Z",
  "checks": [
    {
      "server": "Server Name1",
      "status": "UP",
      "host": "linux server name"
    }
  ]
}

The following shows an example of the response body in JSON format for CycleService:

{
  "status": "UP",
  "timestamp": "2025-05-07T12:00:00Z",
  "checks": [
    {
      "server": "Server Name1",
      "status": "UP",
      "host": "linux server name"
    }
  ]
}