Jump to

• Request
• Response
• Examples

Retrieve Monitoring Data for Integrations

get

/ic/api/integration/v1/monitoring/integrations

Retrieves a list of integrations along with respective count for total, processed, succeeded, errored and aborted messages within the specified time window.

Request

Supported Media Types

• application/json; charset=utf-8

Query Parameters

• limit: integer(int32)
  Number of integrations to fetch.
• offset: integer(int32)
  Start index for pagination support. Default value is 0.
• orderBy: string

  Valid values:

  • 'name': Results will be ordered by Integration name.
  • 'time': Results will be ordered by last updated time.

  Example:

  To order the records by name

  orderBy='name'

• q: string

  Filter parameters.

  • timewindow: 1h, 6h, 1d, 2d, 3d, RETENTIONPERIOD. Default value is 1h.
  • status: CONFIGURED, ACTIVATION_INPROGRESS, FAILEDACTIVATION, ACTIVATED, ALL. Default value is ACTIVATED.
  • startdate: Custom time range start date/time in UTC format for filtering integrations.
  • enddate: Custom time range end date/time in UTC format for filtering integrations.
  • name: Integration name - Both complete and partial name search is supported.
  • style: Style of integration
    • 'freeform_mapmydata' - App Driven Orchestration
    • 'freeform_scheduled' - Scheduled Orchestration
    • 'template_mapmydata' - Basic Routing
    • 'template_subscribetooic' - Subscribe to OIC
    • 'template_publishtooic' - Publish to OIC

  Example:

  {timewindow:'2d', status:'CONFIGURED', style:'freeform_scheduled'}

• return: string
  Type of records to return.

Back to Top

Response

Supported Media Types

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

200 Response

Successful operation

Body ()

Root Schema : MonitoringIntegrationsRs

Type: object

Show Source

• dataFetchTime: string(date-time)
• items: array items
• links: array links
• timeWindow: string
• totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MonitoringIntegrationBaseRs"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "timeWindow":{
            "type":"string"
        },
        "dataFetchTime":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object MonitoringIntegrationBaseRs

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

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : MonitoringIntegrationBaseRs

Type: object

Show Source

• code: string
• flowStatus: string
• id: string
• lastUpdated: string(date-time)
• lastUpdatedString: string
• links: array links
• mepType: string
• name: string
• nextRunDateString: string
• noOfErrors: integer
• noOfMsgsProcessed: integer
• noOfMsgsReceived: integer
• noOfSuccess: integer
• optimizedVersion: 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"
        }
    }
}

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

500 Response

Server error

Back to Top

Examples

The following examples show how to retrieve monitoring details about activated and integrations 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 all activated integrations

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

Example: Get monitoring data for all activated integrations for the past day

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

Example: Get monitoring data for all activated integrations by integration name in alphabetical order

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "orderBy=name" https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/integrations

Example: Paginate through returned results

Pagination is done with limit and offset. In this example, we list integrations starting at the fourth item. The list contains 16 items.

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "offset=3&limit=16" https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/integrations

Example: Combine parameters - get monitoring data for the past day by integration name in alphabetical order

To combine query parameters, use q with the --data-urlencode option. The other parameters can be added after the -d option.

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

Back to Top