Jump to

• Request
• Response
• Examples

Retrieve Message Count Summary

get

/ic/api/integration/v1/monitoring/integrations/messages/summary

Retrieves summary of total, processed, succeeded, errored and aborted messages(instances) currently present in tracking runtime.

Request

Query Parameters

• integrationInstance(required): string
  This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

Successful operation

Body ()

Root Schema : MessageCountRs

Type: object

Show Source

• data-fetch-time: string (date-time)
  Data Fetch Time
• message-summary: object message-summary
  Additional Properties Allowed: additionalProperties

  Map of Message Summary

{
    "type":"object",
    "properties":{
        "data-fetch-time":{
            "type":"string",
            "description":"Data Fetch Time",
            "format":"date-time"
        },
        "message-summary":{
            "type":"object",
            "additionalProperties":{
                "type":"integer",
                "format":"int64"
            },
            "description":"Map of Message Summary"
        }
    }
}

Nested Schema : message-summary

Type: object

Additional Properties Allowed

Show Source

• integer(int64)

{
    "type":"object",
    "additionalProperties":{
        "type":"integer",
        "format":"int64"
    },
    "description":"Map of Message Summary"
}

Map of Message Summary

400 Response

Malformed parameters

500 Response

Server error

Back to Top

Examples

The following example shows how to retrieve the message count summary by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.

Example: Retrieve Message Count Summary

Request:

curl -X GET -H 'Authorization: Bearer access_token' -H "Content-Type:application/json" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/integrations/messages/summary?integrationInstance=service-instance

Back to Top