Skip to main content

DryRunResponse

estSkippedNoIdinteger<int32>required

Estimated count of series that would be skipped because they have no external ID for the chosen provider.

Possible values: >= 0

estSkippedRecentlySyncedinteger<int32>required

Estimated count of series that would be skipped because they were recently synced.

Possible values: >= 0

planFailurestring | nullnullable

Provider resolution failure reason, if any.

sample object[]required

Per-series deltas for the first N eligible series.

  • Array [
  • changes objectrequired

    Field name → (before, after) JSON values.

    property name* DryRunFieldChange
    afterrequired
    beforerequired
    seriesIdstring<uuid>required
    seriesNamestringrequired
    skipped object[]required

    Fields that would have been written but were skipped (locks, all-locked, etc.)

  • Array [
  • fieldstringrequired
    reasonstringrequired
  • ]
  • ]
  • totalEligibleinteger<int32>required

    Total number of series eligible to be refreshed (all of them, not just the sample).

    Possible values: >= 0

    DryRunResponse
    {
    "estSkippedNoId": 0,
    "estSkippedRecentlySynced": 0,
    "planFailure": "string",
    "sample": [
    {
    "changes": {},
    "seriesId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "seriesName": "string",
    "skipped": [
    {
    "field": "string",
    "reason": "string"
    }
    ]
    }
    ],
    "totalEligible": 0
    }