list_syncs

Diese Referenz wird aus dem veröffentlichten Werkzeugvertrag erzeugt. Feldnamen und normative Beschreibungen im Schema sind Englisch.

Verhalten und Grenzen

Listet die eigenen Synchronisierungspaare des Nutzers im verbundenen Workspace auf: welcher Kalender in welchen fließt, in welchem Zustand, und falls ein Paar nicht läuft, mit einem belegten Grund, dem nächsten Schritt und, wo eine Seite in Ridian ihn erledigt, nextStepUrl. Ein Zwei-Wege-Sync ist EIN Paar, nicht zwei. Kalendernamen folgen der erteilten Auswahl: Ein Kalender außerhalb davon kommt ohne Namen zurück, statt dass das Paar verschwindet. Keine Termintitel. Der kurze ref-Wert (sync_1, sync_2, …) ist die Eingabe für diagnose_sync und set_sync_paused; er zählt nach Position, deshalb list_syncs erneut aufrufen, wenn sich Paare seitdem geändert haben könnten. Eine leere Liste heißt, dass der Nutzer hier keine eigenen Paare hat — nicht, dass der Workspace keine hat. Pausieren und Fortsetzen gehen hier mit set_sync_paused, ein neuer Einweg-Sync mit preview_sync und create_sync; Regeln ändern oder einen Sync löschen geschieht in der Ridian-App.

Berechtigungen

Freigegebene Scopes, Konten, Kalender und Sichtbarkeitsregeln begrenzen den Zugriff. Ein Workspace-Admin erhält dadurch keinen pauschalen Zugriff auf fremde Konten.

sync:read

Freigaben und Grenzen

Eingabe

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

Ausgabe

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "syncs": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "ref": {
            "type": "string"
          },
          "source": {
            "type": "object",
            "properties": {
              "id": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "id",
              "name"
            ],
            "additionalProperties": false
          },
          "target": {
            "type": "object",
            "properties": {
              "id": {
                "type": [
                  "string",
                  "null"
                ]
              },
              "name": {
                "type": [
                  "string",
                  "null"
                ]
              }
            },
            "required": [
              "id",
              "name"
            ],
            "additionalProperties": false
          },
          "twoWay": {
            "type": "boolean"
          },
          "status": {
            "type": "string",
            "enum": [
              "active",
              "paused",
              "error",
              "deleting"
            ]
          },
          "reason": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "userPaused",
                  "sourceUnavailable",
                  "targetUnavailable",
                  "targetReadOnly",
                  "unsupportedProvider",
                  "planLimit",
                  "other"
                ]
              },
              {
                "type": "null"
              }
            ]
          },
          "nextStep": {
            "type": [
              "string",
              "null"
            ]
          },
          "nextStepUrl": {
            "type": [
              "string",
              "null"
            ]
          },
          "unavailableSince": {
            "type": [
              "number",
              "null"
            ]
          }
        },
        "required": [
          "ref",
          "source",
          "target",
          "twoWay",
          "status",
          "reason",
          "nextStep",
          "nextStepUrl",
          "unavailableSince"
        ],
        "additionalProperties": false
      }
    },
    "scope": {
      "type": "string",
      "const": "own_pairs_in_this_workspace"
    }
  },
  "required": [
    "syncs",
    "scope"
  ],
  "additionalProperties": false
}

Fehler und Wiederholungen

Prüfe das Werkzeugergebnis auf Fehler. Wiederhole Schreiboperationen nicht blind nach einem Timeout. Prüfe zuerst den aktuellen Ressourcen- oder Sendestatus.

Fehlerbehandlung