Jump to

• Request
• Response

Retrieve Error Recovery Jobs

get

/ic/api/integration/v1/monitoring/errors/recoveryJobs

Retrieves a list of recovery jobs created when errored integration instances are resubmitted in a batch.

Request

Supported Media Types

• application/json; charset=utf-8

Query Parameters

• q: string

  Filter parameters.

  • timewindow: 1h, 6h, 1d, 2d, 3d, RETENTIONPERIOD. Default value is 1h.
  • 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.
  • primaryValue: Full or partial recovery job identifier.

  Example:

  {primaryValue:'4', startdate:'2020-07-15 07:00:00', enddate:'2020-07-08 21:10:00'}

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

Type: object

Show Source

• id: string
• items: array items
• links: array links
• totalResults: integer(int32)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RecoveryJobRs"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object RecoveryJobRs

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

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : RecoveryJobRs

Type: object

Show Source

• createdDate: string(date-time)
• failedCount: integer(int64)
• id: string
• inProgressCount: integer(int64)
• links: array links
• recoveredCount: integer(int64)
• totalCount: integer(int64)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "createdDate":{
            "type":"string",
            "format":"date-time"
        },
        "totalCount":{
            "type":"integer",
            "format":"int64"
        },
        "recoveredCount":{
            "type":"integer",
            "format":"int64"
        },
        "inProgressCount":{
            "type":"integer",
            "format":"int64"
        },
        "failedCount":{
            "type":"integer",
            "format":"int64"
        }
    }
}

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