Jump to

• Request
• Response
• Examples

Replay an Integration Instance

post

/ic/api/integration/v1/monitoring/instances/{id}/replay

Replay the integration instance with the specified identifier.

Request

Path Parameters

• id(required): string
  Errored instance identifier.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• flow-code: string
• flow-version: string
• ids: array ids
• project-code: string
• replay-trace-level: string

{
    "type":"object",
    "properties":{
        "replay-trace-level":{
            "type":"string"
        },
        "ids":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "flow-code":{
            "type":"string"
        },
        "flow-version":{
            "type":"string"
        },
        "project-code":{
            "type":"string"
        }
    }
}

Nested Schema : ids

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

OK

Body ()

Root Schema : InstanceReplayRs

Type: object

Show Source

• failed-submissions: array failed-submissions
• filtered-out-instances-with-reason: array filtered-out-instances-with-reason
• id: string
• message: string
  Message
• redirect-url: string
  RedirectURL
• replay-instance-id: string
• replay-job-id: string
• replay-trace: string
• replayed-instances: array replayed-instances
• replayed-instances-count: integer (int32)

{
    "type":"object",
    "properties":{
        "replayed-instances":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Object"
            }
        },
        "failed-submissions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Object"
            }
        },
        "filtered-out-instances-with-reason":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Object"
            }
        },
        "replayed-instances-count":{
            "type":"integer",
            "format":"int32"
        },
        "redirect-url":{
            "type":"string",
            "description":"RedirectURL"
        },
        "message":{
            "type":"string",
            "description":"Message"
        },
        "replay-job-id":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "replay-instance-id":{
            "type":"string"
        },
        "replay-trace":{
            "type":"string"
        }
    }
}

Nested Schema : failed-submissions

Type: array

Show Source

• Array of: object schema

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

Nested Schema : filtered-out-instances-with-reason

Type: array

Show Source

• Array of: object schema

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

Nested Schema : replayed-instances

Type: array

Show Source

• Array of: object schema

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

Nested Schema : schema

Type: object

400 Response

Null request body / missing ids / invalid id

401 Response

Unauthorized for projectCode

403 Response

Forbidden

412 Response

Non-replayable instance or integration

500 Response

Server error

Back to Top

Examples

The following example shows how to replay the integration instance by submitting a POST 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: Replay the integration for instance id 100001

curl -X POST -H 'Authorization: Bearer access_token' -H "Content-Type:application/json" -d '{replayTraceLevel: 'Audit', flowCode: 'TEST_FUTURE_RUNS', flowVersion: '01.00.0000'}' https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/instances/100001/replay?return=monitoringui&integrationInstance=service_instance

This example replays the integration instance for an instance with instance id: 100001.

Back to Top