Jump to

• Request
• Response
• Examples

Retrieve Monitoring Data for an Integration

get

/ic/api/integration/v1/monitoring/integrations/{id}

Retrieves a monitoring integration with the specified identifier and version.

Request

Supported Media Types

• application/json; charset=utf-8

Path Parameters

• id(required): string
  Integration identifier and version.

Query Parameters

• q: string

  Filter parameter.

  • timewindow: 1h, 6h, 1d, 2d, 3d, RETENTIONPERIOD. Default value is 1h.

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8
• application/vnd.oracle.resource+json;type=singular

200 Response

Successful operation

Body ()

Root Schema : MonitoringIntegrationRs

Type: object

Show Source

• code: string
• description: string
• endPointURI: string
• flowId: string
• flowStatus: string
• id: string
• lastUpdated: string(date-time)
• lastUpdatedBy: string
• lastUpdatedString: string
• links: array links
• mepType: string
• name: string
• nextRunDateString: string
• noOfErrors: integer
• noOfMsgsProcessed: integer
• noOfMsgsReceived: integer
• noOfSuccess: integer
• optimizedVersion: string
• proxyWSDL: string
• scheduleApplicable: boolean
  Default Value: false
• scheduleDefined: boolean
  Default Value: false
• scheduleStatus: string
• status: string
• successRate: number
• version: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "mepType":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "noOfMsgsReceived":{
            "type":"integer"
        },
        "noOfMsgsProcessed":{
            "type":"integer"
        },
        "noOfErrors":{
            "type":"integer"
        },
        "noOfSuccess":{
            "type":"integer"
        },
        "successRate":{
            "type":"number"
        },
        "scheduleApplicable":{
            "type":"boolean",
            "default":false
        },
        "scheduleDefined":{
            "type":"boolean",
            "default":false
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "optimizedVersion":{
            "type":"string"
        },
        "lastUpdatedString":{
            "type":"string"
        },
        "scheduleStatus":{
            "type":"string"
        },
        "nextRunDateString":{
            "type":"string"
        },
        "flowStatus":{
            "type":"string"
        },
        "flowId":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "endPointURI":{
            "type":"string"
        },
        "proxyWSDL":{
            "type":"string"
        },
        "lastUpdatedBy":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SuiteLink"
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

400 Response

Malformed parameters

404 Response

Integration not found

500 Response

Server error

Back to Top

Examples

The following examples show how to get monitoring data about an integration 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: Get monitoring data for the integration HELLO_WORLD|01.02.0000

The id is in the form: code%7Cversion. The %7C is the encoded | (vertical line).

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/integrations/HELLO_WORLD%7C01.02.0000

Example: Get monitoring data for the integration HELLO_WORLD|01.02.0000 for the past day

The id is in the form: code%7Cversion. The %7C is the encoded | (vertical line).

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={timewindow: '1d'}" https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/integrations/HELLO_WORLD%7C01.02.0000

Back to Top