Eine Ressource abrufen.¶

Methode¶

GET https://papi.afi.ai/api/v1/tenants/{tenant_id}/resources/{id}

Beschreibung¶

Ruft eine Ressource anhand ihrer ID oder externen ID ab.

Pfadparameter¶

tenant_id string erforderlich

ID des Mandanten, dem die Ressource zugeordnet ist.

id string erforderlich

ID der abzurufenden Ressource. Eine externe ID kann mit dem Präfix ext$ verwendet werden.

curl

curl -X GET \
    -H 'Authorization: {api-key}' \
    https://papi.afi.ai/api/v1/tenants/{tenant_id}/resources/{id}

Schema der erfolgreichen Antwort (200)¶

object

Resource beschreibt eine verwaltete Ressource.

id string

Eindeutige ID der Ressource.

external_id string

Externe ID der Ressource (Google Workspace, Microsoft 365 usw.).

tenant_id string

ID des Mandanten, dem die Ressource zugeordnet ist.

name string

Name der Ressource (beispielsweise die E-Mail-Adresse eines Benutzers in einem Google Workspace- oder Microsoft 365-Mandanten oder der Name einer geteilten Ablage).

kind string

Ressourcentyp (beispielsweise office_user oder office_teamdrive).

archived boolean

Gibt an, ob die Ressource archiviert ist. Bei true können keine neuen Daten aus der Quelle mehr gesichert werden (beispielsweise wenn die zugrunde liegende Ressource im Quellsystem gelöscht wurde).

Antwortbeispiel¶

{
  "id": "string",
  "external_id": "string",
  "tenant_id": "string",
  "name": "string",
  "kind": "string",
  "archived": true
}