Jump to

• Request
• Response
• Examples

Retrieve Future Runs for a Schedule

get

/ic/api/integration/v1/monitoring/futureruns

Retrieves the future runs for a scheduled integration.

Request

Query Parameters

• q: string

  Filter parameters.

  • startdate: Custom time range start date/time in UTC format for filtering instances.
  • enddate: Custom time range end date/time in UTC format for filtering instances.
  • code: Integration identifier.
  • version: Integration version.
  • projectCode: Project identifier

• returnAll: boolean
  Valid values - true, false (default). If true, will return each future run. Else, will aggregate the count of future runs on a daily basis.
• timezone: string

  Timezone identifier.

  Examples:

  America/New_York, Asia/Calcutta, Europe/London

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

Match All

Show Source

• object GenericRestRs
• object FutureRunsForIntegrationListRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/FutureRunsForIntegrationTO"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/SuiteLink"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

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

Nested Schema : FutureRunsForIntegrationListRs-allOf[1]

Type: object

Show Source

• items: array items
• links: array links

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

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"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object FutureRunsForIntegrationTO

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

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : FutureRunsForIntegrationTO

Type: object

Show Source

• code: string
• future-runs: array future-runs
• integration-id: string
• integration-name: string
• project-id: string
• schedule-id: string
• schedule-name: string
• version: string

{
    "type":"object",
    "properties":{
        "integration-id":{
            "type":"string"
        },
        "schedule-id":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "schedule-name":{
            "type":"string"
        },
        "future-runs":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FutureRunTO"
            }
        },
        "integration-name":{
            "type":"string"
        },
        "project-id":{
            "type":"string"
        }
    }
}

Nested Schema : future-runs

Type: array

Show Source

• Array of: object FutureRunTO

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

Nested Schema : FutureRunTO

Type: object

Show Source

• request-id: integer (int64)
• run-count: integer (int32)
• run-time: string
• run-type: string
• state: string
• submitter-name: string

{
    "type":"object",
    "properties":{
        "run-type":{
            "type":"string"
        },
        "run-time":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "request-id":{
            "type":"integer",
            "format":"int64"
        },
        "submitter-name":{
            "type":"string"
        },
        "run-count":{
            "type":"integer",
            "format":"int32"
        }
    }
}

400 Response

Malformed parameters

500 Response

Server error

Back to Top

Examples

The following example shows how to retrieve the future runs in a schduled 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: Retrieve all the future runs in a scheduled integration

Request:

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/futureruns?q={startdate%3A%20%272025-07-01%2018%3A30%3A00%27%2C%20enddate%3A%20%272025-07-07%2018%3A29%3A59%27%2C%20code%3A%20%27SCHEDULE_TEST%27%2C%20version%3A%20%2701.00.0000%27}&returnAll=true&timezone=Asia%2FCalcutta&integrationInstance=service-instance

Example: Retrieve all the future runs in a scheduled integration and aggregated daily

Request:

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/futureruns?q={startdate%3A%20%272025-07-01%2018%3A30%3A00%27%2C%20enddate%3A%20%272025-07-07%2018%3A29%3A59%27%2C%20code%3A%20%27SCHEDULE_TEST%27%2C%20version%3A%20%2701.00.0000%27}&timezone=Asia%2FCalcutta&integrationInstance=service-instance

Back to Top