Freigeben über

Kanal: Archiv

  • Artikel

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Archivieren sie einen Kanal in einem Team. Wenn ein Kanal archiviert wird, können Benutzer keine neuen Nachrichten senden oder auf vorhandene Nachrichten im Kanal reagieren, die Kanaleinstellungen bearbeiten oder andere Änderungen am Kanal vornehmen.

Sie können einen archivierten Kanal löschen oder Mitglieder hinzufügen und daraus entfernen. Wenn Sie ein Team archivieren, werden dessen Kanäle für Sie archiviert.

Die Archivierung erfolgt asynchron; Ein Kanal wird archiviert, nachdem der asynchrone Archivierungsvorgang erfolgreich abgeschlossen wurde. Dies kann auftreten, nachdem die Antwort zurückgegeben wurde.

Ein Kanal ohne Besitzer oder ein Kanal, der zu einer Gruppe ohne Besitzer gehört, kann nicht archiviert werden.

Verwenden Sie die Methode zum Aufheben der Archivierung , um einen Kanal aus seinem archivierten Zustand wiederherzustellen. Ein Kanal kann nicht archiviert oder nicht archiviert werden, wenn sein Team archiviert ist.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Globaler Dienst US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet
✅ ✅ ✅ ✅

Berechtigungen

Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) ChannelSettings.ReadWrite.All Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Anwendung ChannelSettings.ReadWrite.All Nicht verfügbar.

Hinweis: Diese API unterstützt Administratorberechtigungen. Globale Administratoren und Microsoft Teams-Dienstadministratoren können auf Teams zugreifen, in denen sie kein Mitglied sind.

HTTP-Anforderung

POST /teams/{team-id}/channels/{channel-id}/archive
POST /groups/{team-id}/team/channels/{channel-id}/archive

Anforderungsheader

Kopfzeile Wert
Authorization Bearer {token}. Erforderlich.

Anforderungstext

In der Anforderung können Sie optional den shouldSetSpoSiteReadOnlyForMembers Parameter wie folgt in einen JSON-Text einfügen.

{
    "shouldSetSpoSiteReadOnlyForMembers": true
}

Dieser optionale Parameter definiert, ob Berechtigungen für Kanalmitglieder für schreibgeschützt auf der SharePoint Online-Website festgelegt werden sollen, die dem Team zugeordnet ist. Wenn Sie ihn auf false festlegen oder den Text vollständig weglassen, wird dieser Schritt übersprungen.

Antwort

Wenn die Archivierung erfolgreich gestartet wird, gibt diese Methode eine 202 Accepted Antwortcode. Die Antwort enthält einen Location Header, der den Speicherort des teamsAsyncOperation-Objekts enthält, das für die Archivierung des Kanals in einem Team erstellt wurde. Überprüfen Sie den Status des Archivierungsvorgangs, indem Sie eine GET-Anforderung an diesen Speicherort stellen.

Beispiele

Beispiel 1: Archivieren eines Kanals

Das folgende Beispiel zeigt eine Anforderung zum Archivieren eines Kanals.

Anforderung

POST https://graph.microsoft.com/beta/teams/{team-id}/channels/{channel-id}/archive

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 202 Accepted
Location: /teams/{team-id}/operations/{operation-id}
Content-Type: text/plain
Content-Length: 0

Beispiel 2: Archivieren eines Kanals, wenn das Team archiviert wird

Das folgende Beispiel zeigt eine Anforderung, wenn das Team archiviert wird.

Anforderung

POST https://graph.microsoft.com/beta/teams/{team-id}/channels/{channel-id}/archive

Antwort

Das folgende Beispiel zeigt die 400 Fehlerantwort.

http/1.1 400 Bad Request
Content-Type: application/json
Content-Length: 193

{
    "error": {
        "code": "BadRequest",
        "message": "Team has to be active, for channel to be archived or unarchived: {channel-id}",
        "innerError": {
            "message": "Team has to be active, for channel to be archived or unarchived: {channel-id}",
            "code": "Unknown",
            "innerError": {},
            "date": "2023-12-11T04:26:35",
            "request-id": "8f897345980-f6f3-49dd-83a8-a3064eeecdf8",
            "client-request-id": "50a0er33-4567-3f6c-01bf-04d144fc8bbe"
        }
    }
}