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

Path Parameters

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

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.
• q: string

  Filter parameter.

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

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 : MonitoringIntegrationsRs

Type: object

Show Source

• data-fetch-time: string (date-time)
  Data Fetch Time
• items: array items
  List of Monitoring Integration
• time-window: string
  Time Window
• total-results: integer (int64)
  Total Results

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Monitoring Integration",
            "items":{
                "$ref":"#/components/schemas/MonitoringIntegrationBaseRs"
            }
        },
        "total-results":{
            "type":"integer",
            "description":"Total Results",
            "format":"int64"
        },
        "time-window":{
            "type":"string",
            "description":"Time Window"
        },
        "data-fetch-time":{
            "type":"string",
            "description":"Data Fetch Time",
            "format":"date-time"
        }
    }
}

Nested Schema : items

Type: array

List of Monitoring Integration

Show Source

• Array of: MonitoringIntegrationBaseRs

{
    "type":"array",
    "description":"List of Monitoring Integration",
    "items":{
        "$ref":"#/components/schemas/MonitoringIntegrationBaseRs"
    }
}

Nested Schema : MonitoringIntegrationBaseRs

Match All

Show Source

• allOf IntegrationBaseRs
• allOf IdRs
• object GenericRestRs
• object MonitoringIntegrationBaseRs-allOf[3]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IntegrationBaseRs"
        },
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "noOfMsgsReceived":{
                    "type":"integer"
                },
                "noOfMsgsProcessed":{
                    "type":"integer"
                },
                "noOfErrors":{
                    "type":"integer"
                },
                "noOfSuccess":{
                    "type":"integer"
                },
                "successRate":{
                    "type":"number"
                },
                "scheduleApplicable":{
                    "type":"boolean"
                },
                "scheduleDefined":{
                    "type":"boolean"
                },
                "mepType":{
                    "type":"string"
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time"
                },
                "optimizedVersion":{
                    "type":"string"
                },
                "lastUpdatedString":{
                    "type":"string"
                },
                "noOfAborted":{
                    "type":"integer"
                },
                "scheduleStatus":{
                    "type":"string"
                },
                "nextRunDateString":{
                    "type":"string"
                },
                "flowStatus":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : IntegrationBaseRs

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object IntegrationBaseRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "version":{
                    "type":"string"
                },
                "name":{
                    "type":"string"
                },
                "projectCode":{
                    "type":"string"
                },
                "code":{
                    "type":"string"
                },
                "mepType":{
                    "type":"string"
                },
                "status":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : IdRs

Match All

Show Source

• object GenericRestRs
• object IdRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

Nested Schema : IdRs-allOf[1]

Type: object

Show Source

• id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : IntegrationBaseRs-allOf[2]

Type: object

Show Source

• code: string
• mepType: string
• name: string
• projectCode: string
• status: string
• version: string

{
    "type":"object",
    "properties":{
        "version":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "projectCode":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "mepType":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    }
}

Nested Schema : MonitoringIntegrationBaseRs-allOf[3]

Type: object

Show Source

• flowStatus: string
• lastUpdated: string (date-time)
• lastUpdatedString: string
• mepType: string
• nextRunDateString: string
• noOfAborted: integer
• noOfErrors: integer
• noOfMsgsProcessed: integer
• noOfMsgsReceived: integer
• noOfSuccess: integer
• optimizedVersion: string
• scheduleApplicable: boolean
• scheduleDefined: boolean
• scheduleStatus: string
• successRate: number

{
    "type":"object",
    "properties":{
        "noOfMsgsReceived":{
            "type":"integer"
        },
        "noOfMsgsProcessed":{
            "type":"integer"
        },
        "noOfErrors":{
            "type":"integer"
        },
        "noOfSuccess":{
            "type":"integer"
        },
        "successRate":{
            "type":"number"
        },
        "scheduleApplicable":{
            "type":"boolean"
        },
        "scheduleDefined":{
            "type":"boolean"
        },
        "mepType":{
            "type":"string"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "optimizedVersion":{
            "type":"string"
        },
        "lastUpdatedString":{
            "type":"string"
        },
        "noOfAborted":{
            "type":"integer"
        },
        "scheduleStatus":{
            "type":"string"
        },
        "nextRunDateString":{
            "type":"string"
        },
        "flowStatus":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• media-type: string
• method: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "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://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/integrations/HELLO_WORLD%7C01.02.0000?integrationInstance=service-instance

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://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/integrations/HELLO_WORLD%7C01.02.0000?integrationInstance=service-instance

Back to Top